fix: deprecation warning triggered by internal onClick #4557
Conversation
🦋 Changeset detectedLatest commit: 87c1bf0 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Warning Rate limit exceeded@wingkwong has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 22 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis pull request introduces patches for the Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.changeset/stale-moose-hear.md(1 hunks)packages/hooks/use-aria-button/src/index.ts(3 hunks)packages/hooks/use-aria-link/src/index.ts(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- .changeset/stale-moose-hear.md
🧰 Additional context used
🪛 Biome (1.9.4)
packages/hooks/use-aria-button/src/index.ts
[error] 116-116: Do not access Object.prototype method 'hasOwnProperty' from target object.
It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.
(lint/suspicious/noPrototypeBuiltins)
[error] 116-116: Do not access Object.prototype method 'hasOwnProperty' from target object.
It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.
(lint/suspicious/noPrototypeBuiltins)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: TypeScript
- GitHub Check: Build
🔇 Additional comments (3)
packages/hooks/use-aria-link/src/index.ts (2)
24-25: LGTM: Type property addition is well-documentedThe new optional
typeproperty is properly typed and documented, allowing for explicit type specification when a link behaves as a button.
70-77: Verify the condition for bypassing onClick warningThe logic to bypass the deprecation warning looks correct but contains duplicate conditions. The warning is bypassed when:
type === "button"(for<Link as="button" />)role === "button"(for<Button as={Link} />)Consider consolidating the conditions for better maintainability:
if ( deprecatedOnClick && typeof deprecatedOnClick === "function" && - // bypass since onClick is passed from <Link as="button" /> internally - type !== "button" && - // bypass since onClick is passed from <Button as={Link} /> internally - role !== "button" + // bypass internal onClick from Link/Button components + !(type === "button" || role === "button") ) {packages/hooks/use-aria-button/src/index.ts (1)
22-23: LGTM: Role property addition is well-documentedThe new optional
roleproperty is properly typed and documented, allowing for explicit role specification when a button behaves as a link.
📝 Description
Internal
onClicktriggers the deprecation warning while users have no control of it. This PR is to handle the following case⛳️ Current behavior (updates)
🚀 New behavior
💣 Is this a breaking change (Yes/No):
📝 Additional Information
Summary by CodeRabbit
Bug Fixes
onClickfunction in@nextui-org/use-aria-buttonand@nextui-org/use-aria-linkpackages.Enhancements
roleproperty toAriaButtonProps, allowing specification of button semantics.typeproperty toAriaLinkOptions, enhancing flexibility for element types.