feat: #11566 filter toolbar buttons RTE widget
#11566
- Added the
disablePluginTypesprop to theRichTextEditorComponentto allow filtering of toolbar buttons. - Implemented the
filterToolbarConfigfunction to dynamically filter toolbar items based on the disabled plugins. - Updated the
RichTextEditorWidgetto include thedisablePluginTypesproperty with a dropdown for selecting plugins to disable. - Passed the
disablePluginTypesprop from the widget to the component to apply the toolbar filtering.
https://github.com/user-attachments/assets/270e6831-6681-4978-bf08-182393281ad6
Summary by CodeRabbit
-
New Features
- Introduced
disablePluginTypesproperty in the Rich Text Editor, allowing users to specify which plugins to disable in the toolbar. - Enhanced widget configuration with a dropdown for selecting disabled plugins, improving customization options.
- Introduced
-
Bug Fixes
- Improved rendering logic to ensure the editor updates correctly when plugin types are disabled.
-
Tests
- Added automated tests for the Rich Text Editor widget to verify functionality related to disabled plugin types, enhancing test coverage.
Walkthrough
This update enhances the Rich Text Editor widget by introducing the disablePluginTypes property, allowing users to specify which plugins should be disabled in the toolbar. The related components and tests have been updated to incorporate this feature, ensuring a more flexible and customizable editing experience. Automated tests have also been added to verify that the changes work as intended, maintaining the reliability of the widget.
Changes
| Files | Change Summary |
|---|---|
.../RTE/RichTextEditor_4_spec.ts |
Added automated tests verifying the behavior of the Rich Text Editor's toolbar when specific plugin types are disabled. |
.../RichTextEditorWidget/component/index.tsx |
Introduced disablePluginTypes to the RichtextEditorComponentProps interface, enabling dynamic filtering of the toolbar configuration based on disabled plugins. |
.../RichTextEditorWidget/widget/index.tsx |
Added disablePluginTypes to the RichTextEditorWidget class, allowing users to select multiple plugins to disable, with validation for unique values. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant Widget
participant Component
User->>Widget: Select disabled plugins
Widget->>Component: Pass disablePluginTypes
Component->>Component: Filter toolbar configuration
Component->>User: Render updated toolbar
Poem
In the editor's realm, plugins dance and play,
A new feature arrives to brighten the day.
Disable a tool, make choices with ease,
With tests now in place, the worries all cease.
Flexibility blooms, as users now cheer,
For the Rich Text Editor, a change we hold dear! ✨
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>. -
Generate unit testing code for this file. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai generate unit testing code for this file. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai generate interesting stats about this repository and render them as a table. -
@coderabbitai show all the console.log statements in this repository. -
@coderabbitai read src/utils.ts and generate unit testing code. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -
@coderabbitai help me debug CodeRabbit configuration file.
-
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (invoked as PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.
@ApekshaBhosale Could you please review this PR?
This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.
This PR has been closed because of inactivity.