search

Brisanet / ion-react

Ion design system in react
https://main--63da5890a06a8f8f995110dd.chromatic.com/
MIT License
10 stars 1 forks source link

feat: add dot badge #167

Closed danilo-moreira-brisa closed 5 months ago

danilo-moreira-brisa commented 6 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent updates enhance the IonBadge component, introducing new properties and styles to support dot badges with icons and custom colors. New test cases and storybook stories ensure the component's functionality and appearance are well-documented and easily adjustable through UI controls.

Changes

Files Change Summary
.../badge/badge.test.tsx Added getDotBadge function, updated test descriptions and assertions, new test cases for dot badges.
.../badge/badge.tsx Enhanced IonBadge with new props (dot, icon, size, status, customColor). Added new types.
.../badge/styles.ts Added DotStylesProps, DotContainer, and Dot styled components. Updated imports and types.
.../badge/badge.stories.tsx Updated storybook title, added control parameters for 'label' and 'type'.
.../badge/dotBadge.stories.tsx New story for dot badge variations (dot-only, with icon, with custom color).

🐇✨ In the land of code, where the bits align, A badge was born, oh so fine! With dots and icons, colors so bright, A rabbit hopped with sheer delight. Celebrate the badge, a new design in sight! 🎉 🐇✨

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 8305361308660c52c293ae0b5dde223ea43f3b33 and e0bccac0b6a93e1bcbabe323244dec65f40d8863.
Files ignored due to path filters (1) * `src/components/badge/__snapshots__/badge.test.tsx.snap` is excluded by `!**/*.snap`
Files selected for processing (5) * src/components/badge/badge.test.tsx (1 hunks) * src/components/badge/badge.tsx (1 hunks) * src/components/badge/styles.ts (2 hunks) * src/stories/badge/badge.stories.tsx (1 hunks) * src/stories/badge/dotBadge.stories.tsx (1 hunks)
Files skipped from review due to trivial changes (1) * src/stories/badge/dotBadge.stories.tsx
Additional comments not posted (14)
src/stories/badge/badge.stories.tsx (2)
`6-6`: Updated the storybook title to better categorize the badge types. --- `8-10`: Added new parameters for controls to allow interactive customization and testing within the storybook environment.
src/components/badge/badge.tsx (5)
`9-14`: Introduced new `BadgeStatus` type to support different statuses like 'negative', 'positive', 'warning', and 'info'. --- `16-16`: Added `BadgeDotSizes` type to define available sizes for the dot badge. --- `19-25`: Updated `BadgeProps` to include new properties for the dot badge feature, enhancing the component's versatility. --- `28-32`: Defined `ICON_SIZE` mapping to associate dot sizes with numerical values, facilitating styling adjustments. --- `36-71`: Enhanced the `IonBadge` component to conditionally render a dot badge with optional icon and custom color. Ensure thorough testing of all conditional branches.
src/components/badge/styles.ts (3)
`8-13`: Introduced `DotStylesProps` to handle styling based on the dot badge's size, status, and other properties. --- `67-77`: Added `DotContainer` styled component to manage layout and styling of the dot badge container. --- `79-91`: Added `Dot` styled component to apply specific styles to the dot badge based on its properties. Ensure that the fallback color matches the intended design specifications.
src/components/badge/badge.test.tsx (4)
`21-23`: Added `getDotBadge` function to facilitate testing of the dot badge feature. --- `95-104`: Added test cases to verify the default rendering of the dot badge. Ensure that all style rules are correctly applied. --- `108-112`: Added test case to verify the rendering of the dot badge with a label. Ensure label visibility and correctness. --- `116-134`: Added test cases to verify the conditional rendering of icons in dot badges based on size. Ensure that icons are rendered correctly for sizes greater than 'xs' and not rendered for 'xs'.
--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.