refactor(badge): [badge] refactor theme vars

[Youyou-smiles]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features
  • Introduced customizable left margin for badge components using a new CSS variable.
  • Default badge variant now has no left margin for improved layout control.

[coderabbitai]

Walkthrough

The changes involve modifications to the badge component's styling in two LESS files. In index.less, a new left margin property is introduced for the badge, while the default variant is set to have no left margin. The vars.less file adds a new CSS variable for the left margin, enhancing the badge's layout flexibility.

Changes

File Path	Change Summary
packages/theme/src/badge/index.less	Added margin-left: var(--tv-Badge-margin-left); to the main badge class and set margin-left: 0; for the &--default modifier.
packages/theme/src/badge/vars.less	Introduced new CSS variable --tv-Badge-margin-left: var(--tv-space-sm); in the .inject-Badge-vars() function.

Possibly related PRs

• feat(badge): [badge] Adapting to the SMB theme #2087: Changes to the badge component adapting it to the SMB theme, related to margin properties.
• feat(badge): [badge] Adapting to the SMB theme #2107: Adaptation of the badge component to the SMB theme, potentially aligning with margin changes.
• feat(badge): [badge]: Adapting to the SMB theme #2167: Focuses on adapting the badge component to the SMB theme, which may include relevant styling changes.
• refactor(badge): [badge] refactor badge theme vars #2229: Refactors badge theme variables, related to the margin properties introduced.
• feat(card): Adapting to the SMB themes #2231: Adapts the card component to the SMB theme, indirectly relating to overall theme adjustments including badge styling.

Suggested labels

refactoring

Suggested reviewers

• zzcr

Poem

🐰 In the garden where badges bloom,
A margin left, to give them room.
With styles anew, they stand so bright,
Customizable, a lovely sight!
Hopping through code, we cheer with glee,
For badges now dance, wild and free! 🌼

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

packages/theme/src/badge/vars.less (1)

28-29: LGTM! Consider adding an English comment.

The addition of --tv-Badge-margin-left is a good improvement, allowing for more flexible positioning of badges. The naming and value are consistent with existing conventions.

Consider adding an English translation of the comment for better international developer experience:

-  // 标记左边距
+  // 标记左边距 (Badge left margin)
   --tv-Badge-margin-left: var(--tv-space-sm);

packages/theme/src/badge/index.less (1)

37-37: Great refactoring of theme variables!

These changes successfully introduce a customizable left margin for badges while maintaining the existing appearance of default badges. This refactoring enhances the component's flexibility without introducing breaking changes, which aligns perfectly with the PR objectives.

To ensure smooth adoption of this new feature:

1. Consider updating the component's documentation to mention the new --tv-Badge-margin-left CSS variable.
2. Provide examples of how users can customize the left margin in different scenarios.

Also applies to: 65-65

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bc0ffc5 and 11e5d89.

📒 Files selected for processing (2)

• packages/theme/src/badge/index.less (2 hunks)
• packages/theme/src/badge/vars.less (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

packages/theme/src/badge/index.less (2)

37-37: Excellent addition of customizable left margin!

The introduction of margin-left: var(--tv-Badge-margin-left); enhances the flexibility of the badge component. This change allows for easy customization of the left margin through a CSS variable, which is consistent with the component's theming approach and aligns well with the PR's refactoring objectives.

---

65-65: Good job maintaining consistency for default badges!

Setting margin-left: 0; for the default badge variant ensures that it maintains its original appearance without any left margin. This change effectively overrides the general margin-left property introduced earlier, preserving backwards compatibility for the default badge style. It's a thoughtful addition that complements the earlier change.