Skip to content

withIgnoreIMEEvents: Update documentation for clarity #70098

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 13, 2025
Merged

withIgnoreIMEEvents: Update documentation for clarity #70098

merged 2 commits into from
May 13, 2025

Conversation

yogeshbhutkar
Copy link
Contributor

@yogeshbhutkar yogeshbhutkar commented May 12, 2025 •
edited
Loading

What, Why, and How?

Closes #70097
Related #70056 (comment)

This PR updates the documentation for withIgnoreIMEEvents to reflect its applicability to all supported keyboard event handlers, not just keyDown.

Since keyUp events can also be triggered during IME composition, it's important, especially for accessibility and proper handling for CJK users to use the HOF with both keyDown and keyUp. This change helps ensure the intent and usage are clear to developers.

Source: https://developer.mozilla.org/en-US/docs/Web/API/Element/keyup_event#keyup_events_with_ime

@yogeshbhutkar yogeshbhutkar marked this pull request as ready for review May 12, 2025 05:23
@yogeshbhutkar yogeshbhutkar requested a review from ajitbohra as a code owner May 12, 2025 05:23
@github-actions GitHub Actions
Copy link

github-actions bot commented May 12, 2025 •
edited
Loading

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: yogeshbhutkar <yogeshbhutkar@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>

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

t-hamano
t-hamano approved these changes May 13, 2025
View reviewed changes
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

LGTM!

P.S. I think we don't need to add a changelog entry as this change is just a comment and an argument name change.

@t-hamano t-hamano added [Type] Code Quality Issues or PRs that relate to code quality [Package] Components /packages/components labels May 13, 2025
@Mamaduka Mamaduka added the props-bot Adding this label triggers the Props Bot workflow for a PR. label May 13, 2025
@github-actions github-actions bot removed the props-bot Adding this label triggers the Props Bot workflow for a PR. label May 13, 2025
@Mamaduka Mamaduka merged commit 3a5d9f0 into WordPress:trunk May 13, 2025
85 of 106 checks passed
@github-actions github-actions bot added this to the Gutenberg 20.9 milestone May 13, 2025
chriszarate pushed a commit to chriszarate/gutenberg that referenced this pull request Jul 1, 2025
@yogeshbhutkar @t-hamano
@Mamaduka @chriszarate
withIgnoreIMEEvents: Update documentation for clarity (WordPress#70098
a4a4cb3 
)

Co-authored-by: yogeshbhutkar <yogeshbhutkar@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mamaduka Mamaduka Mamaduka approved these changes

@t-hamano t-hamano t-hamano approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

Assignees
No one assigned
Labels
[Package] Components /packages/components [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Milestone
Gutenberg 20.9
Development

Successfully merging this pull request may close these issues.

Generalize JSDoc for withIgnoreIMEEvents HOF to cover both keyDown and keyUp events
3 participants
@yogeshbhutkar @Mamaduka @t-hamano