Skip to content

Add readme for typewrite component#71103

Open
dhananjaykuber wants to merge 1 commit intoWordPress:trunkfrom
dhananjaykuber:docs/typewrite-component
Open

Add readme for typewrite component#71103
dhananjaykuber wants to merge 1 commit intoWordPress:trunkfrom
dhananjaykuber:docs/typewrite-component

Conversation

@dhananjaykuber
Copy link
Copy Markdown
Contributor

Closes #52074

What?

Add README.md with component documentation for Typewriter component

Why?

README.md file was missing for Typewriter component

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 7, 2025

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.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: dhananjaykuber <dhananjaykuber@git.wordpress.org>
Co-authored-by: mburridge <mburridge@git.wordpress.org>

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

@im3dabasia im3dabasia added the [Type] Developer Documentation Documentation for developers label Aug 7, 2025
- Respects viewport boundaries to avoid scrolling caret out of view
- Includes initial trigger threshold to prevent premature activation

#### Event Handling:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not needed in a README feels like implementation detail.


Block Editor components are components that can be used to compose the UI of your block editor. Thus, they can only be used under a `BlockEditorProvider` in the components tree.

### Technical Implementation
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not needed IMO


The content to wrap with typewriter functionality. Should contain contentEditable elements for the effect to work.

### Browser Compatibility
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should avoid this, we could probably even remove the IE specific code nowadays.

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

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add README.md file for typewriter component

3 participants