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

[lexical-react] Fix(lexical-react): ContentEditable props type rename #6837

Merged
merged 3 commits into from
Nov 18, 2024

Conversation

ivaaaaann
Copy link
Contributor

Description

The name of the type seems too generic, so I suggest renaming it to:

Like the link below
https://github.com/facebook/lexical/blob/main/packages/lexical-react/src/LexicalTablePlugin.ts

The name of the type seems too generic, so I suggest renaming it to:

Like the link below
https://github.com/facebook/lexical/blob/main/packages/lexical-react/src/LexicalTablePlugin.ts
Copy link

vercel bot commented Nov 15, 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 Nov 18, 2024 0:59am
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 0:59am

@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 Nov 15, 2024
Copy link

github-actions bot commented Nov 15, 2024

size-limit report 📦

Path Size
lexical - cjs 30.85 KB (0%)
lexical - esm 30.73 KB (0%)
@lexical/rich-text - cjs 39.58 KB (0%)
@lexical/rich-text - esm 32.67 KB (0%)
@lexical/plain-text - cjs 38.22 KB (0%)
@lexical/plain-text - esm 29.93 KB (0%)
@lexical/react - cjs 41.35 KB (0%)
@lexical/react - esm 34.03 KB (0%)

@etrepum
Copy link
Collaborator

etrepum commented Nov 15, 2024

I think this probably makes sense but it doesn't maintain backwards compatibility. I would recommend also exporting it as Props, maybe with a @deprecated docstring

@ivaaaaann
Copy link
Contributor Author

@etrepum Thanks for the nice comment, I didn't think about that part! I modified it according to your comment.

Comment on lines 32 to 39
/**
* @deprecated This type has been renamed to `ContentEditableProps` to provide a clearer and more descriptive name.
* For backward compatibility, this type is still exported as `Props`, but it is recommended to migrate to using `ContentEditableProps` instead.
*
* @note This alias is maintained for compatibility purposes but may be removed in future versions.
* Please update your codebase to use `ContentEditableProps` to ensure long-term maintainability.
*/
export type Props = ContentEditableProps
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the formatting here is causing CI to fail, npm run prettier:fix would resolve it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you i fixed fix: prettier

@etrepum etrepum added this pull request to the merge queue Nov 18, 2024
Merged via the queue into facebook:main with commit ab758a7 Nov 18, 2024
14 checks passed
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.

3 participants