[lexical-playground] plugins TableOfContent Scroll smooth behaviour A…

[mshaheerz]

[lexical-playground] Feature: Add smooth scroll behavior for Table of Contents

Description

Current Behavior

Clicking a heading in the Table of Contents scrolls to the heading in the editor instantly without any smooth transition.
This abrupt behavior can be jarring for users and detracts from the overall user experience.

New Behavior

Smooth scrolling has been implemented when clicking on a heading in the Table of Contents.
The user will experience a seamless transition to the relevant section of the editor.

This change improves usability and aligns with modern UI/UX standards.

Changes Made

file path: lexical-plaground/src/plugins/TableOfContentsPlugin/index.tsx

1. Modified the scrollToNode function in the TableOfContentsList component to include smooth scrolling:
   domElement.scrollIntoView({ behavior: "smooth", block: "center" });
   2.Tested the implementation across multiple headings and ensured compatibility with varying editor states.

Test plan

Before

Clicking on a heading resulted in an instant, abrupt jump to the section without a smooth transition.

After

Clicking on a heading in the Table of Contents now triggers a smooth scrolling animation to the corresponding section in the Editor.

Steps to Test:

Open the lexical-playground with the Table of Contents plugin enabled.
Add headings (H1, H2, H3) to the document in the editor.
Click on any heading in the Table of Contents.
Verify the editor smoothly scrolls to the selected heading.

Screenshots/Recordings:

Before

lexical-before.-.Made.with.Clipchamp.mp4

After

lexical-after.-.Made.with.Clipchamp.mp4

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
lexical	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 20, 2025 9:48am
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 20, 2025 9:48am

[facebook-github-bot]

Hi @mshaheerz!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

[github-actions]

size-limit report 📦

Path	Size
lexical - cjs	29.07 KB (0%)
lexical - esm	28.89 KB (0%)
@lexical/rich-text - cjs	38.04 KB (0%)
@lexical/rich-text - esm	30.98 KB (0%)
@lexical/plain-text - cjs	36.57 KB (0%)
@lexical/plain-text - esm	28.26 KB (0%)
@lexical/react - cjs	39.84 KB (0%)
@lexical/react - esm	32.34 KB (0%)

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[ivailop7]

You need to run 'prettier' to format correctly

[mshaheerz]

Code formatted with Prettier.