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: menu-badge color not correct #4089

Merged
merged 1 commit into from
Aug 9, 2024
Merged

fix: menu-badge color not correct #4089

merged 1 commit into from
Aug 9, 2024

Conversation

likui628
Copy link
Collaborator

@likui628 likui628 commented Aug 8, 2024

Description

#4088

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Introduced a function to validate color strings, enhancing color input reliability.
    • Updated the badge component to ensure only valid colors are applied.
  • Bug Fixes

    • Improved the robustness of color conversion utilities by implementing explicit color validation tests.
  • Refactor

    • Adjusted the badge component's logic to incorporate the new color validation function.

Copy link

changeset-bot bot commented Aug 8, 2024

⚠️ No Changeset found

Latest commit: 2c834eb

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

Copy link
Contributor

coderabbitai bot commented Aug 8, 2024

Walkthrough

The updates introduce a new function, isValidColor, enhancing color validation within the codebase. This function is integrated into the testing suite and several components, ensuring that only valid color inputs are processed. The changes improve the robustness and reliability of color-related functionalities, allowing for better handling of user inputs and enhancing overall component behavior.

Changes

File Change Summary
packages/@core/base/shared/src/color/convert.ts Added isValidColor function for validating color strings; updated exports to include this new function.
packages/@core/base/shared/src/color/convert.test.ts Introduced tests for isValidColor, validating both valid and invalid color inputs.
packages/@core/ui-kit/shadcn-ui/src/components/menu-badge/menu-badge.vue Modified badge logic to use isValidColor for checking color validity; updated import and adjusted formatting for consistency.

Poem

🐰 In the land of hues where colors play,
A new friend, isValidColor, brightens the way.
With checks in place, our badges gleam,
No more invalid shades to ruin the dream!
So hop along, let's code with delight,
For every color now feels just right! 🌈


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

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 UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3f04f6b and 2c834eb.

Files selected for processing (3)
  • packages/@core/base/shared/src/color/convert.test.ts (2 hunks)
  • packages/@core/base/shared/src/color/convert.ts (1 hunks)
  • packages/@core/ui-kit/shadcn-ui/src/components/menu-badge/menu-badge.vue (3 hunks)
Additional comments not posted (5)
packages/@core/ui-kit/shadcn-ui/src/components/menu-badge/menu-badge.vue (2)

6-6: Update import statement to use isValidColor.

The import of convertToRgb has been replaced with isValidColor, aligning with the new approach to color validation.


37-39: Enhance color validation in badgeStyle.

The badgeStyle computed property now checks for valid colors using isValidColor, ensuring that only valid color values are applied.

packages/@core/base/shared/src/color/convert.ts (2)

49-54: Add isValidColor function for color validation.

The isValidColor function uses TinyColor to verify if a given color string is valid, returning a boolean result. This addition enhances the module's capability to handle color inputs.


56-62: Update exports to include isValidColor.

The export list now includes isValidColor, making it available for use in other parts of the codebase.

packages/@core/base/shared/src/color/convert.test.ts (1)

48-58: Add tests for isValidColor function.

The new test cases verify the functionality of isValidColor, ensuring it correctly identifies valid and invalid color strings. This enhances the robustness of the color validation logic.

@anncwb anncwb added the bug Something isn't working label Aug 8, 2024
@vince292007 vince292007 merged commit de90b07 into main Aug 9, 2024
16 checks passed
@vince292007 vince292007 deleted the fix-badge-color branch August 9, 2024 02:53
@github-actions github-actions bot locked and limited conversation to collaborators Sep 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants