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(skeleton): missing disableAnimation behaviour in skeleton #2538

Merged
merged 1 commit into from
Mar 31, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Mar 18, 2024

Closes #2537

📝 Description

the default variants wont't let custom variants to override

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

  • first two skeletons with disableAnimation = true
pr-2538-demo.webm

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Introduced new dependencies to enhance UI components.
  • Bug Fixes
    • Fixed missing disableAnimation behavior in the skeleton component.
  • Refactor
    • Removed defaultVariants property from the skeleton component for optimization.

Copy link

changeset-bot bot commented Mar 18, 2024

🦋 Changeset detected

Latest commit: d94cd25

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

This PR includes changesets to release 3 packages
Name Type
@nextui-org/skeleton Patch
@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

vercel bot commented Mar 18, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 18, 2024 6:46am

Copy link

vercel bot commented Mar 18, 2024

@wingkwong is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Mar 18, 2024

Walkthrough

This update introduces dependencies on @nextui-org/skeleton and @nextui-org/theme to address a bug where the skeleton component did not respect the disableAnimation property. Additionally, it involves the removal of the defaultVariants property from the skeleton component, streamlining its functionality and ensuring animations can be disabled as expected.

Changes

Files Change Summary
.changeset/eleven-maps-admire.md Added dependencies and fixed disableAnimation in the skeleton component.
packages/core/theme/src/components/skeleton.ts Removed defaultVariants property from the skeleton component.

Assessment against linked issues

Objective Addressed Explanation
[#2537]: Skeleton does not respect disableAnimation

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between e67b3af and 756f32a.
Files selected for processing (2)
  • .changeset/eleven-maps-admire.md (1 hunks)
  • packages/core/theme/src/components/skeleton.ts (1 hunks)
Additional comments: 1
packages/core/theme/src/components/skeleton.ts (1)
  • 59-64: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-48]

The changes to the skeleton component, including the removal of the defaultVariants property, appear to align with the objective of fixing the disableAnimation behavior. However, it would be beneficial to add comments explaining how the disableAnimation property is now handled, especially for future maintainability and clarity for other developers.

.changeset/eleven-maps-admire.md Outdated Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 756f32a and 430ccbc.
Files selected for processing (1)
  • .changeset/eleven-maps-admire.md (1 hunks)

.changeset/eleven-maps-admire.md Outdated Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 756f32a and 67605aa.
Files selected for processing (1)
  • .changeset/eleven-maps-admire.md (1 hunks)
Additional comments: 2
.changeset/eleven-maps-admire.md (2)
  • 1-4: The metadata section correctly identifies the affected packages (@nextui-org/skeleton and @nextui-org/theme) and the type of version bump (patch). This is appropriate for the changes described, which address a bug fix.
  • 6-6: The description clearly outlines the fix for the missing disableAnimation behavior in the Skeleton component. The term disableAnimation is correctly used here, referring to a specific property in the context of the component's API, and should not be altered.

@wingkwong wingkwong marked this pull request as draft March 18, 2024 03:55
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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between e67b3af and d94cd25.
Files selected for processing (2)
  • .changeset/eleven-maps-admire.md (1 hunks)
  • packages/core/theme/src/components/skeleton.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/core/theme/src/components/skeleton.ts
Additional comments: 1
.changeset/eleven-maps-admire.md (1)
  • 1-6: The changeset document clearly outlines the patch updates for @nextui-org/skeleton and @nextui-org/theme packages and provides a concise description of the fix related to the disableAnimation behavior in the skeleton component. Everything looks good here.

@jrgarciadev jrgarciadev added this to the v2.3.0 milestone Mar 31, 2024
@jrgarciadev jrgarciadev merged commit 0359bf3 into nextui-org:main Mar 31, 2024
7 of 8 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.

[BUG] - Skeleton does not respect disableAnimation
3 participants