Notices: Type NoticeAction.onClick as a mouse event handler - #81859
Open
swissspidy wants to merge 2 commits into
Open
Notices: Type NoticeAction.onClick as a mouse event handler#81859swissspidy wants to merge 2 commits into
swissspidy wants to merge 2 commits into
Conversation
A notice action's callback is handed to a `Button`, so React calls it with the click event. The type declared it as `VoidFunction`, so a handler that reads the event failed to type check even though the `Notice` component's own action type has always described it as a mouse event handler. Also note on `url` that it takes precedence over `onClick`, matching what the component documents. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EQTrVy89daPN74LMo9FKNN
|
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: @claude. 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. |
|
Size Change: 0 B Total Size: 7.74 MB |
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EQTrVy89daPN74LMo9FKNN
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Types
NoticeAction.onClickin@wordpress/noticesasMouseEventHandler< HTMLAnchorElement | HTMLButtonElement >instead ofVoidFunction, and documents thaturltakes precedence overonClick.Why?
A notice action's callback is handed straight to a
Button, so React calls it with the click event:@wordpress/componentshas always described its ownNoticeAction.onClickas a mouse event handler. The store's copy of the type declared it asVoidFunction, so a handler that reads the event failed to type check even though the event is there at runtime:The precedence note mirrors what
NoticePropsin@wordpress/componentsalready documents: when bothurlandonClickare provided,urlwins and the action renders as an anchor.How?
One type widened in
packages/notices/src/store/types.ts, plus a doc comment.@wordpress/noticesalready depends on@wordpress/componentsand already imports React types elsewhere, so thereacttype import adds no new dependency. No runtime change.Note this only widens what callers may pass; the existing narrower handlers stay assignable, and the store's
Noticetype remains assignable to whatNoticeListexpects.Testing Instructions
npm run typecheckpasses.npx wp-scripts test-unit-js --config test/unit/jest.config.js packages/noticespasses.Testing Instructions for Keyboard
N/A — no user interface changes.
Use of AI Tools
This pull request was authored by Claude Code (Opus) under my direction and review. I reviewed the diff and confirmed the type check and unit tests locally before opening it. I take responsibility for the change.
Generated by Claude Code