Skip to content

Block Editor: Add README for Typewriter component#79482

Open
Hassams wants to merge 1 commit into
WordPress:trunkfrom
Hassams:add/typewriter-readme
Open

Block Editor: Add README for Typewriter component#79482
Hassams wants to merge 1 commit into
WordPress:trunkfrom
Hassams:add/typewriter-readme

Conversation

@Hassams

@Hassams Hassams commented Jun 24, 2026

Copy link
Copy Markdown

What?

Adds a README.md for the Typewriter component in block-editor, which previously had none.

Why?

The Typewriter component and its useTypewriter hook had no documentation describing their purpose, usage, or the fact that the hook is exposed outside the package as the private __unstableUseTypewriter API consumed by the editor package's VisualEditor. Most other block-editor components 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 Typewriter wrapper component, and a usage example for the useTypewriter hook.

Testing Instructions

Docs-only change, no functional code touched.

  • Read through packages/block-editor/src/components/typewriter/README.md and confirm it accurately describes the component's behavior in packages/block-editor/src/components/typewriter/index.js.

Documents the Typewriter component and useTypewriter hook, including
their role as the private __unstableUseTypewriter API consumed by the
editor package's VisualEditor.
@Hassams Hassams requested a review from ellatrix as a code owner June 24, 2026 10:27
@github-actions github-actions Bot added the [Package] Block editor /packages/block-editor label Jun 24, 2026
@github-actions

Copy link
Copy Markdown

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.

  • Required label: Any label starting with [Type].
  • Labels found: .

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.

@github-actions

Copy link
Copy Markdown

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 props-bot label.

Unlinked Accounts

The 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.

Unlinked contributors: Hassams.


To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions github-actions Bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Jun 24, 2026
@github-actions

Copy link
Copy Markdown

👋 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Package] Block editor /packages/block-editor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant