Block Editor: Add README for Typewriter component#79482
Conversation
Documents the Typewriter component and useTypewriter hook, including their role as the private __unstableUseTypewriter API consumed by the editor package's VisualEditor.
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @Hassams. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @Hassams! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
What?
Adds a
README.mdfor theTypewritercomponent inblock-editor, which previously had none.Why?
The
Typewritercomponent and itsuseTypewriterhook had no documentation describing their purpose, usage, or the fact that the hook is exposed outside the package as the private__unstableUseTypewriterAPI consumed by theeditorpackage'sVisualEditor. Most otherblock-editorcomponents have a README; this one was missing.How?
Added a README following the conventions used by other component READMEs in this package: a short description, a usage example for the
Typewriterwrapper component, and a usage example for theuseTypewriterhook.Testing Instructions
Docs-only change, no functional code touched.
packages/block-editor/src/components/typewriter/README.mdand confirm it accurately describes the component's behavior inpackages/block-editor/src/components/typewriter/index.js.