Skip to content
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.

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

fix: Lint error using onClick on a div #2756 #2778

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

GARY121github
Copy link
Contributor

@GARY121github GARY121github commented Dec 23, 2024

What does this PR do?

Fixes #2756

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Open the Audit Log and click on the Event

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
Screenshot 2024-12-24 at 12 09 12 AM

Summary by CodeRabbit

  • New Features

    • Enhanced command items in the filter component to behave like buttons, improving interactivity.
    • Updated styling for command items to ensure full-width display and maintain visual consistency.
  • Bug Fixes

    • Retained functionality for the "Clear filters" command, ensuring users can reset selected filters effectively.

Copy link

changeset-bot bot commented Dec 23, 2024

⚠️ No Changeset found

Latest commit: f8a7e8e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Dec 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 7:01pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 7:01pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 7:01pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 7:01pm

Copy link

vercel bot commented Dec 23, 2024

@GARY121github is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

📝 Walkthrough

Walkthrough

The pull request addresses a lint error in the Filter component by replacing a div with a Button component. This change improves accessibility by ensuring that click events have corresponding keyboard events. The modification maintains the existing filter functionality while enhancing the component's interactivity and adherence to accessibility guidelines.

Changes

File Change Summary
apps/dashboard/app/(app)/audit/components/filters/filter.tsx Replaced div with Button for command items, added w-full className, and maintained existing filter selection logic

Assessment against linked issues

Objective Addressed Explanation
Resolve lint error for onClick on div [#2756]
Improve accessibility for keyboard navigation

Possibly related PRs

Suggested Labels

Bug, 🕹️ oss.gg, :joystick: 150 points

Suggested Reviewers

  • chronark
  • mcstepp
  • perkinsjr

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the Bug Something isn't working label Dec 23, 2024
Copy link
Contributor

github-actions bot commented Dec 23, 2024

Thank you for following the naming conventions for pull request titles! 🙏

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🔭 Outside diff range comments (1)
apps/dashboard/app/(app)/audit/components/filters/filter.tsx (1)

Based on the search results, I can now provide a definitive response. Looking at other implementations in the codebase, I can see that CommandItem is typically used directly without being wrapped in a Button component. The other examples show proper usage patterns where CommandItem handles its own interactivity through the onSelect prop.

Remove the outer Button wrapper to avoid nested interactive elements.

The CommandItem component already provides:

  • Keyboard navigation (through the Command component)
  • Click handling via onSelect
  • Proper styling and focus management

Instead of the current nested structure, you should:

  1. Move the selection logic to the CommandItem's onSelect prop (which is already implemented correctly)
  2. Remove the wrapping Button component entirely
🔗 Analysis chain

Line range hint 84-116: Avoid nesting interactive elements for better accessibility.

Nesting a Button (interactive element) around a CommandItem (also interactive) can create accessibility and UX issues. Screen readers and keyboard navigation might misinterpret overlapping interactivity. Consider replacing the CommandItem or the Button so only one component manages clicks and focus.


Let me verify if the CommandItem component is indeed an interactive element by checking its implementation in the codebase.


Based on the search results, I can see that CommandItem is indeed an interactive element. It's built on top of CommandPrimitive.Item and includes interactive styles like cursor-pointer and keyboard navigation attributes (aria-selected). This confirms that we have a nested interactive element issue as mentioned in the review comment.

Let me verify if this is a common pattern in the codebase or if there are better examples of implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts found


Script:

#!/bin/bash
# Search for CommandItem component definition
ast-grep --pattern 'const CommandItem = $_'

# Search for any CommandItem import statements
rg 'import.*CommandItem' -A 2

# Search for CommandItem usage patterns
ast-grep --pattern 'CommandItem $$$'

Length of output: 7880


Script:

#!/bin/bash
# Search for other CommandItem implementations to see if there are better patterns
rg -B 5 -A 5 '<CommandItem'

Length of output: 11218

🧹 Nitpick comments (2)
apps/dashboard/app/(app)/audit/components/filters/filter.tsx (2)

84-85: Potential duplication of event handling logic.

You're already calling “handleSelection” inside the CommandItem’s onSelect. Wrapping the CommandItem with a Button that also calls “handleSelection” in onClick may cause confusion or lead to double triggers in some cases. Consider consolidating the logic by relying on a single, consistent event handler to simplify future maintenance and avoid potential side effects.


96-96: Consider removing redundant onSelect logic if using onClick event from the Button.

If the wrapping Button's onClick event is the primary way to toggle selection, evaluate if the onSelect inside the CommandItem is still needed. Removing duplicates helps keep the code DRY and easier to maintain.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 90c5da0 and f8a7e8e.

📒 Files selected for processing (1)
  • apps/dashboard/app/(app)/audit/components/filters/filter.tsx (3 hunks)

@ogzhanolguncu ogzhanolguncu added this pull request to the merge queue Dec 23, 2024
Merged via the queue into unkeyed:main with commit 886821d Dec 23, 2024
25 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lint error using onClick on a div
2 participants