-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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 usage documentation for Rich Text package #35885
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding the examples, I've already learned more about the RichText package.
I've added a couple of suggestions on rewording in a few spots.
I was a little confused by the Collapsed selection, the first paragraph makes sense. However, the last sentence confused me on what I'm supposed to take away from it.
It looks like you are still working on it since there is a TODO:
in the Replacements spot, or was that asking for others to add their input?
This is great so far and thanks so much for documenting and adding examples. It helps!
Co-authored-by: Marcus Kazmierczak <[email protected]>
Co-authored-by: Marcus Kazmierczak <[email protected]>
Co-authored-by: Marcus Kazmierczak <[email protected]>
…st bold and italics
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating, this is a good improvement to the RichText docs 👍
Description
I've been using the
@wordpress/rich-text
package a fair amount recently. It's super powerful and I really appreciate the work that's gone into this.That said, to understand the package you must currently learn by either:
Whilst it is possible to gain a working understanding of the fundamentals of the package in this way it is not the most efficient method. Given that this package is so critical and underpins much of what Gutenberg can do, this seems like something we should look to address.
This PR attempts this by adding some basic
Usage
documentation. This coversRichTextValue
object.I would also like to cover the
replacements
property of the value object. I would do this but I still don't understand it so I'm going to need to rely on others to add this information.How has this been tested?
Screenshots
Types of changes
New feature (non-breaking change which adds functionality)
Checklist:
*.native.js
files for terms that need renaming or removal).