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: remove circular-progress tv to progress #3321

Open
wants to merge 2 commits into
base: canary
Choose a base branch
from

Conversation

winchesHe
Copy link
Member

@winchesHe winchesHe commented Jun 25, 2024

Closes #

nextui-org/nextui-cli#85

📝 Description

Add a brief description

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes

    • Removed the circular-progress component to streamline progress functionalities within the app.
    • Replaced the circular-progress component with an updated progress component for more consistent user experience.
  • New Features

    • Introduced a new circularProgress component with enhanced slots and variant options for better styling and customization.

Copy link

vercel bot commented Jun 25, 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 Jun 26, 2024 2:57pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2024 2:57pm

Copy link

changeset-bot bot commented Jun 25, 2024

🦋 Changeset detected

Latest commit: c3f86f5

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 Minor
@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 Jun 25, 2024

Walkthrough

This update focuses on modifying the @nextui-org/theme package by removing the circular-progress component. In its place, the progress component has been enhanced to cover similar functionalities. The update streamlines component usage by centralizing progress-indicating features under the progress component.

Changes

File/Path Change Summary
.../theme/src/components/index.ts Removed the export of the circular-progress component, added circularProgress with styling. Updated exports to include circularProgress alongside progress.
.changeset/strange-spoons-behave.md Documented the removal of the circular-progress TV to progress functionality.
.changeset/angry-maps-serve.md Documented the minor update replacing the circular-progress component with the progress component.

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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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 720f2f5 and ca7d3d7.

Files selected for processing (3)
  • .changeset/strange-spoons-behave.md (1 hunks)
  • packages/core/theme/src/components/index.ts (1 hunks)
  • packages/core/theme/src/components/progress.ts (1 hunks)
Additional comments not posted (5)
.changeset/strange-spoons-behave.md (1)

2-5: Verify versioning and description in changeset.

The changeset correctly identifies the package and the patch level. Ensure that the description "Remove circular-progress tv to progress" accurately reflects the changes made in the PR, as it seems a bit unclear.

packages/core/theme/src/components/index.ts (1)

Line range hint 1-38: Review exports for consistency with PR objectives.

The file lists multiple component exports. It's crucial to verify that the export of circular-progress has been removed and replaced by progress as described in the PR. However, this file does not show the removal explicitly, which could be due to the way the changes are presented here.

packages/core/theme/src/components/progress.ts (3)

239-243: Check type declarations for consistency.

The type declarations for ProgressVariantProps and ProgressSlots are consistent with the implementation of the progress component. Similarly, ensure that the types for CircularProgressVariantProps and CircularProgressSlots accurately reflect the properties and slots of the circularProgress component.


245-245: Confirm export of progress and circularProgress components.

The explicit export of both progress and circularProgress components is crucial for their availability in other parts of the application. This change aligns with the PR's objectives and should be noted in the documentation if not already done.


139-238: Review new circularProgress component implementation.

The implementation of the circularProgress component is well-documented and includes a variety of configurations for slots and variants. Ensure that the example usage in the comments is accurate and that the component behaves as expected in different configurations.

Verification successful

Review new circularProgress component implementation.

The circularProgress component is well-integrated and used in various parts of the codebase, including demos, documentation, and storybook files. The component appears to support a wide range of configurations and is documented for different use cases and variants. The example usage in the comments is accurate and aligns with the actual implementation.

  • Verified Files:
    • apps/docs/components/demos/speed-progress.tsx
    • apps/docs/content/docs/components/circular-progress.mdx
    • packages/components/progress/stories/circular-progress.stories.tsx
    • packages/components/progress/src/use-circular-progress.ts

Based on the content of these files, the circularProgress component behaves as expected across different configurations.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the behavior of `circularProgress` in different configurations.

# Test: Check the component in a development environment.
echo "Manual testing required in development environment."

Length of output: 112



Script:

#!/bin/bash
# Search for instances of circularProgress in the codebase to verify its usage and configurations.

# Find all occurrences of circularProgress in the repository
rg 'circularProgress' --glob '!node_modules/*'

Length of output: 2363



Script:

#!/bin/bash
# Display the content of files where `circularProgress` is used to verify its configurations and usage.

# List of files to inspect
files=(
  "apps/docs/components/demos/speed-progress.tsx"
  "apps/docs/content/docs/components/circular-progress.mdx"
  "packages/components/progress/stories/circular-progress.stories.tsx"
  "packages/components/progress/src/use-circular-progress.ts"
)

# Loop through each file and display its content
for file in "${files[@]}"; do
  echo "File: $file"
  echo "-------------------------------------"
  cat "$file"
  echo -e "\n\n"
done

Length of output: 19386

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

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

Should it be a breaking change? Let's say I use individual package and my tailwindcss setup is like

"./node_modules/@nextui-org/theme/dist/components/circular-progress.js",

With the change introduced in this PR, I need to change it to

"./node_modules/@nextui-org/theme/dist/components/progress.js",

@winchesHe
Copy link
Member Author

Should it be a breaking change? Let's say I use individual package and my tailwindcss setup is like

"./node_modules/@nextui-org/theme/dist/components/circular-progress.js",

With the change introduced in this PR, I need to change it to

"./node_modules/@nextui-org/theme/dist/components/progress.js",

ya, maybe could upgrade in next minor version, and let user know that

@wingkwong wingkwong added the 💥 Type: Breaking Change This PR includes breaking changes label Jun 26, 2024
@wingkwong wingkwong added this to the v2.5.0 milestone Jun 26, 2024
@wingkwong
Copy link
Member

Let's put it in v2.5.0.

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 ca7d3d7 and c3f86f5.

Files selected for processing (1)
  • .changeset/angry-maps-serve.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • .changeset/angry-maps-serve.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💥 Type: Breaking Change This PR includes breaking changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants