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(theme): add pointer-events-none to skeleton base #2972

Merged
merged 1 commit into from May 13, 2024
Merged

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented May 10, 2024

Closes #1714

📝 Description

as titled

⛳️ Current behavior (updates)

if you put a button with onPress inside skeleton, the onPress can be triggered.

🚀 New behavior

The content should be hidden and events should not be triggered

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the user interface by applying a pointer-events-none style to the skeleton component, ensuring it does not interfere with user interactions.

Copy link

vercel bot commented May 10, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 10, 2024 3:28am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 10, 2024 3:28am

Copy link

changeset-bot bot commented May 10, 2024

🦋 Changeset detected

Latest commit: 72ad5f9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@nextui-org/theme Patch
@nextui-org/react Patch

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

Copy link
Contributor

coderabbitai bot commented May 10, 2024

Walkthrough

This update introduces a modification to the @nextui-org/theme package, specifically to the skeleton component. The change involves adding the pointer-events-none class to the skeleton component, ensuring that any hidden content under the skeleton, such as buttons, cannot trigger events like clicks during the skeleton's display.

Changes

File Path Change Summary
.../src/components/skeleton.ts Added pointer-events-none to the skeleton component.

Assessment against linked issues

Objective Addressed Explanation
Prevent hidden content under Skeleton from being clickable to trigger events like onPress [#1714]

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

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

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 633f9d2 and 72ad5f9.
Files selected for processing (2)
  • .changeset/slow-mice-act.md (1 hunks)
  • packages/core/theme/src/components/skeleton.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • .changeset/slow-mice-act.md
Additional comments not posted (1)
packages/core/theme/src/components/skeleton.ts (1)

22-22: Addition of pointer-events-none correctly implements the requested feature to prevent interaction with elements covered by the Skeleton component.

Verification successful

The addition of the pointer-events-none class in the skeleton function within packages/core/theme/src/components/skeleton.ts correctly implements the requested feature to prevent interaction with elements covered by the Skeleton component. This confirms that the implementation aligns with the intended functionality as described in the review comment.

  • File: packages/core/theme/src/components/skeleton.ts
  • Location: base slot of the skeleton function
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the correct application of `pointer-events-none` in the Skeleton component.

# Test: Search for the usage of the Skeleton component in the project to ensure it behaves as expected.
rg --type css 'skeleton'

Length of output: 24



Script:

#!/bin/bash
# Description: Search for the usage of the Skeleton component in JavaScript or TypeScript files to verify the application of `pointer-events-none`.

# Search for references to the Skeleton component in JavaScript or TypeScript files.
rg --type js,ts 'Skeleton' --files-with-matches

Length of output: 77



Script:

#!/bin/bash
# Description: Correctly search for the usage of the Skeleton component in JavaScript and TypeScript files to verify the application of `pointer-events-none`.

# Search for references to the Skeleton component in JavaScript files.
rg --type js 'Skeleton' --files-with-matches

# Search for references to the Skeleton component in TypeScript files.
rg --type ts 'Skeleton' --files-with-matches

Length of output: 816



Script:

#!/bin/bash
# Description: Inspect the implementation of the Skeleton component to verify the application of `pointer-events-none`.

# Display the contents of the Skeleton component implementation files.
cat packages/components/skeleton/src/skeleton.tsx
cat packages/components/skeleton/src/use-skeleton.ts

Length of output: 2716



Script:

#!/bin/bash
# Description: Inspect the theme configuration or function where `pointer-events-none` might be defined or applied.

# Display the contents of the theme configuration or relevant function for the Skeleton component.
cat packages/core/theme/src/components/skeleton.ts

Length of output: 1927

@jrgarciadev jrgarciadev merged commit 5f735a9 into canary May 13, 2024
8 checks passed
@jrgarciadev jrgarciadev deleted the fix/eng-810 branch May 13, 2024 01:57
@wingkwong wingkwong added this to the v2.3.7 milestone May 14, 2024
Gaic4o pushed a commit to Gaic4o/nextui that referenced this pull request May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants