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

feat(tooltip): Disable point events on all tooltips to prevent underlying elements from being blocked. #183

Merged
merged 3 commits into from
Feb 20, 2025

Conversation

junhaoliao
Copy link
Member

@junhaoliao junhaoliao commented Feb 17, 2025

Description

This PR disables pointer events on all tooltips to ensure that underlying elements remain interactive. Previously, tooltips could block interactions with elements beneath them. This change improves the user experience by preventing tooltips from interfering with user interactions.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  1. Manually tested all tooltips to confirm that pointer events are disabled and verified that underlying elements remain interactive when tooltips are displayed. Ensured that tooltip visibility and functionality remain unaffected.

Summary by CodeRabbit

  • Style
    • Improved tooltip styling to ensure tooltips no longer intercept mouse actions, allowing smoother interactions with underlying elements.
    • Enhanced the visual presentation of log level selection by removing outdated styles for a cleaner, more intuitive interface.

Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

This pull request removes tooltip-related styling from the LogLevelSelect component and adjusts tooltip configuration. The CSS file no longer includes the .log-level-select-option-text-tooltip class. In the component’s TSX file, the slotProps attribute for the Tooltip component is removed. Additionally, the theme file is updated to include a style override for the JoyTooltip component, setting its pointerEvents to "none".

Changes

Files Changes
src/components/StatusBar/LogLevelSelect/index.css
src/components/StatusBar/LogLevelSelect/index.tsx
Removed the .log-level-select-option-text-tooltip class and its styles from the CSS file; removed the slotProps attribute from the Tooltip component in TSX.
src/components/theme.tsx Added a new styleOverrides property for JoyTooltip in the theme, setting pointerEvents to "none".

Possibly related PRs

Suggested reviewers

  • kirkrodrigues
  • davemarco

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 10b7cf5 and 69f0060.

📒 Files selected for processing (3)
  • src/components/StatusBar/LogLevelSelect/index.css (0 hunks)
  • src/components/StatusBar/LogLevelSelect/index.tsx (0 hunks)
  • src/components/theme.tsx (1 hunks)
💤 Files with no reviewable changes (2)
  • src/components/StatusBar/LogLevelSelect/index.css
  • src/components/StatusBar/LogLevelSelect/index.tsx
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ...

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • src/components/theme.tsx
🔇 Additional comments (1)
src/components/theme.tsx (1)

63-67:

❓ Verification inconclusive

LGTM! The change effectively prevents tooltips from blocking underlying elements.

The addition of pointerEvents: "none" to the JoyTooltip's root style is an elegant solution that allows users to interact with elements beneath tooltips while maintaining tooltip visibility.

Please verify that this change doesn't impact tooltip accessibility for keyboard users. Run the following web search to confirm:


🌐 Web query:

Does setting pointer-events: none affect keyboard accessibility or screen readers?

💡 Result:

Setting pointer-events: none does not fully prevent keyboard interaction and can create inconsistencies for screen reader users. Here’s a breakdown of its effects:

Keyboard Accessibility

  • Elements remain focusable via keyboard navigation (e.g., using the Tab key) unless explicitly removed from the focus order[5][10].
  • Keyboard-triggered events (e.g., Enter/Space on buttons) may still activate elements styled with pointer-events: none, depending on the browser[3][5].
  • Example: A "disabled" button using pointer-events: none will appear visually inactive but can still be focused and activated via keyboard[2][6].

Screen Reader Behavior

  • Visibility: Screen readers may still announce elements with pointer-events: none if they are focusable or have semantic roles (e.g., buttons)[2][3].
  • Interaction Issues:
    • iOS VoiceOver users cannot activate elements with pointer-events: none, creating a mismatch between visual and functional states[3].
    • Other screen readers may inconsistently handle these elements, as pointer-events is not part of standard accessibility APIs[3][5].

Best Practices

  1. Avoid pointer-events: none for interactive HTML elements like buttons or inputs. Use semantic HTML attributes instead:

    <button disabled>Disabled Button</button> <!-- Correct method -->

    This ensures full accessibility by:

    • Removing the element from the focus order.
    • Communicating the disabled state to assistive technologies[2][5][7].
  2. Reserve pointer-events: none for non-interactive graphical overlays (e.g., decorative elements) where interaction is unnecessary[2][10].

Summary

While pointer-events: none blocks mouse/touch interactions, it fails to address keyboard and screen reader accessibility, leading to potential usability gaps. Always use semantic HTML attributes like disabled for interactive controls requiring full accessibility support[2][5][7].

Citations:


Review Note: Verify Comprehensive Accessibility

LGTM! The addition of pointerEvents: "none" in the JoyTooltip's root style effectively prevents mouse interactions from blocking underlying elements. However, note that while this setting blocks pointer events, it does not fully disable keyboard interactions and may lead to inconsistencies for screen reader users. Please confirm through accessibility testing that keyboard navigation and screen reader behaviour remain unaffected, ensuring that tooltips continue to function as intended without introducing unintended interactive elements.


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.

@junhaoliao junhaoliao requested a review from Henry8192 February 17, 2025 15:07
Copy link
Collaborator

@Henry8192 Henry8192 left a comment

Choose a reason for hiding this comment

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

LGTM. The behaviors are identical.

@junhaoliao junhaoliao merged commit 773629c into y-scope:main Feb 20, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants