added the allowedFormat details in richtext readme#42426
added the allowedFormat details in richtext readme#42426fabiankaegy merged 5 commits intoWordPress:trunkfrom Smit2808:update/richtext-readme
Conversation
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @Smit2808! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
fabiankaegy
left a comment
There was a problem hiding this comment.
Hey @Smit2808 👋
Thanks for creating this new PR and improving the documentation :)
I have left a few suggestions in the code. Mainly I think that we should remove all the code comments that don't have anything to do with the allowedFormats property as it makes the code example a little crowded.
Once these suggestions have been applied we can merge this in :)
Co-authored-by: Fabian Kägy <mail@fabian-kaegy.de>
Co-authored-by: Fabian Kägy <mail@fabian-kaegy.de>
Co-authored-by: Fabian Kägy <mail@fabian-kaegy.de>
Co-authored-by: Fabian Kägy <mail@fabian-kaegy.de>
|
Hi @fabiankaegy Thanks 🙂 for reviewing my PR. I committed all suggestions you have given. Please review it. |
|
Thanks, @fabiankaegy for the quick reply and review. |
|
Hi @fabiankaegy, All checks are passed. Now you can merge. |
What?
In this PR I have added the information about the allowedFormats property. In richtext package documentation, there is no detailed information and example about this property. So created the PR for this.
Why?
In rich-text package documentation, there should be detailed information about the allowedFormats property.
The allowedFormats property provides the formatting options in tools. If you want to display only limited formatting options to richtext then allowedFormats is used.
How?
In my custom Gutenberg block, I want to stop displaying some formating options so I researched a lot and found about this allowedFormats property in one blog. So I think there should be detailed example documentation about allowedFormats property in rich text package documentation.
Testing Instructions
Open the rich text documentation and you will not find any detailed info about allowedFormats property.
Screenshots or screencast