Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a setter for the format property on RangeSelection #5829

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

HyperVS
Copy link

@HyperVS HyperVS commented Apr 4, 2024

This pull request introduces a setter method for the format property within the RangeSelection class. This enhancement aims to simplify the process of updating the format for range selections within the API.

Changes Made:

  • Added a setFormat() method to the RangeSelection class.

This method allows developers to modify the format of the range selection in a more intuitive manner, eliminating the need to directly manipulate the format property.

Benefits

Improves code readability and maintainability by providing a clear and consistent interface for modifying the format property.
Reduces the likelihood of errors and misuse by encapsulating the logic for setting format values within a dedicated method.

Copy link

vercel bot commented Apr 4, 2024

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 Dec 2, 2024 7:14pm
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 2, 2024 7:14pm

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 4, 2024
@agriffis
Copy link
Contributor

agriffis commented Apr 4, 2024

Where's the code that calls this setter?

@HyperVS
Copy link
Author

HyperVS commented Apr 7, 2024

This addition is more of an api enhancement (exactly like setStyle on the same RangeSelection class). Whilst internal lexical code can use this setter, it is much easier to just use this.format directly within the class.

However, this addition provides a safe way for developers to update the format property without unexpected side-effects, namely from forgetting to set the dirty flag to true after directly manipulating the format property.

Copy link

github-actions bot commented Dec 2, 2024

size-limit report 📦

Path Size
lexical - cjs 30.99 KB (0%)
lexical - esm 30.82 KB (0%)
@lexical/rich-text - cjs 39.76 KB (0%)
@lexical/rich-text - esm 32.63 KB (0%)
@lexical/plain-text - cjs 38.35 KB (0%)
@lexical/plain-text - esm 29.95 KB (0%)
@lexical/react - cjs 41.48 KB (0%)
@lexical/react - esm 34.02 KB (0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants