feat: added Circular Progress

[dhavalveera]

Added Circular Progress component to flowbite-react for visualizing progress with circular markers. Enhances feedback with a clear and versatile progress display.

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a customizable circular progress indicator component, allowing for progress values and optional text labels.
  • Enhanced theming options for improved visual customization of the progress indicator.

• Bug Fixes

  • Improved accessibility by ensuring unique identifiers for the circular progress component.

• Documentation

  • Expanded documentation to include detailed implementation guides for the new circular progress features.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 0865ccc777e148d98ab5221045a91afd72450ce6

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

[vercel[bot]]

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 26, 2024 8:53am
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 26, 2024 8:53am

[coderabbitai[bot]]

Walkthrough

The changes introduce a new React functional component, CircularProgress, in the UI library, which implements a circular progress indicator. This component is defined in TypeScript and includes several interfaces for theming and properties management. The component supports accessibility features and customizable themes, allowing for dynamic rendering of progress values and optional text labels.

Changes

File Path	Change Summary
packages/ui/src/components/Progress/ProgressCircular.tsx	Defined CircularProgress component with props for progress and labels, utilizing SVG for rendering. Added interfaces: FlowbiteCircularProgressTheme, CircularProgressColor, and CircularProgressProps.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant CircularProgress
    participant Theme

    User->>UI: Request Circular Progress
    UI->>CircularProgress: Render with props
    CircularProgress->>Theme: Apply circular styles
    CircularProgress-->>UI: Return rendered component
    UI-->>User: Display Circular Progress

🐰 In the meadow where circles spin,
A progress tale begins to win.
With colors bright and labels clear,
The joy of progress draws us near.
Hop along, dear friends, and see,
The magic of circularity! 🌼

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/ui/src/components/Progress/ProgressCircular.tsx

Oops! Something went wrong! :(

ESLint: 8.57.0

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "/packages/ui".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in "packages/ui/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[dhavalveera]

@SutuSebastian --- can you please review this PR, if you've time to?

[dhavalveera]

@SutuSebastian -- I've added useMemo() to optimize the re-render of component everytime