refactor(progress): [progress] refactor the progress theme

[chenxi-20]

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

  • Updated theming and styling for the progress component, enhancing visual representation and layout.

• Bug Fixes

  • Improved consistency in naming conventions for progress component styles.

• Refactor

  • Removed outdated styles and functions, streamlining the progress component's codebase.
  • Updated CSS variable naming conventions for better clarity.

[coderabbitai]

Walkthrough

The changes in this pull request involve the removal of the progress.less file, which contained a mixin for customizing progress component styles. Additionally, several JavaScript and LESS files related to the progress component have been updated to reflect a new naming convention, changing prefixes from ti- to tv-. This includes updates to theme variables and the introduction of new functions for injecting CSS variables, enhancing the overall theming structure of the progress component.

Changes

File Path	Change Summary
packages/theme/src/mixins/progress.less	Removed the mixin .progress-status(@color) which defined styles for the progress component.
packages/theme/src/progress/aurora-theme.js	Updated key for warning background color from 'ti-progress-warning-bg-color' to 'tv-Progress-bg-color-warning'.
packages/theme/src/progress/old-theme.js	Renamed multiple keys from ti-progress- to tv-Progress- for consistency in theming.
packages/theme/src/progress/vars.less	Replaced function .component-css-vars-progress() with .inject-Progress-vars(), updating naming conventions.
packages/theme/src/progress/index.less	Replaced import for progress.less with .inject-Progress-vars() and added nested styles for progress.

Possibly related PRs

• feat: optimize theme style variables #2157: Involves optimizing theme style variables, renaming CSS variables from --ti- to --tv-, similar to the main PR.
• refactor(numeric): [numeric]refactor numeric theme vars #2200: Refactors numeric theme variables with a similar renaming convention, aligning with the main PR's changes.
• refactor(collapse): [collapse] refactor collapse theme vars #2201: Focuses on refactoring collapse theme variables, updating names and structures in line with the main PR.
• refactor(dialog-box): [dialog-box] refactor dialog-box theme vars #2202: Refactors dialog box theme variables, transitioning from --ti- to --tv-, consistent with the main PR's changes.

Suggested reviewers

• zzcr

🐇 In a world of colors bright,
The progress bar takes flight.
With themes anew, it shines so clear,
A joyful hop, we bring good cheer!
From ti- to tv-, we’ve made the change,
In rabbit style, let’s rearrange! 🐇

---

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: 6

🧹 Outside diff range and nitpick comments (1)

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

13-13: Ensure consistent naming conventions for mixin functions.

The function name has been changed from .component-css-vars-progress() to .inject-Progress-vars(). Consider using a consistent naming convention by using lowercase letters and hyphens, such as .inject-progress-vars(), to improve readability and maintain consistency across the codebase.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 69b6208 and c329b5f.

📒 Files selected for processing (5)

• packages/theme/src/mixins/progress.less (0 hunks)
• packages/theme/src/progress/aurora-theme.js (1 hunks)
• packages/theme/src/progress/index.less (2 hunks)
• packages/theme/src/progress/old-theme.js (1 hunks)
• packages/theme/src/progress/vars.less (1 hunks)

💤 Files with no reviewable changes (1)

• packages/theme/src/mixins/progress.less

🧰 Additional context used

🔇 Additional comments (5)

packages/theme/src/progress/old-theme.js (5)

2-2: LGTM: Consistent renaming pattern applied.

The key has been renamed from 'ti-progress-exception-bg-color' to 'tv-Progress-bg-color-exception', following a consistent pattern. The value remains unchanged, maintaining the use of the CSS variable.

---

3-3: LGTM: Consistent renaming with semantic improvement.

The key has been renamed from 'ti-progress-bar-text-margin-left' to 'tv-Progress-right-text-margin-left'. This change not only follows the consistent renaming pattern but also improves the semantic meaning by specifying 'right-text' instead of 'bar-text'.

---

4-4: LGTM: Consistent renaming with simplified key.

The key has been renamed from 'ti-progress-bar-inner-bg-color' to 'tv-Progress-inner-bg-color'. This change follows the consistent renaming pattern and simplifies the key by removing the redundant 'bar-' prefix.

---

5-5: LGTM: Consistent renaming with simplified key.

The key has been renamed from 'ti-progress-bar-outer-bg-color' to 'tv-Progress-outer-bg-color'. This change follows the consistent renaming pattern and simplifies the key by removing the redundant 'bar-' prefix.

---

1-6: Summary: Consistent theme refactoring with improved naming conventions.

The changes in this file demonstrate a systematic refactoring of the progress theme:

1. All keys have been renamed from 'ti-progress-' to 'tv-Progress-', improving consistency with the new naming convention.
2. The capitalization of 'Progress' in the keys aligns with proper naming conventions for components.
3. Some keys have been simplified (e.g., removing redundant 'bar-' prefixes), enhancing clarity.
4. All values remain unchanged, preserving the existing theming functionality.

These changes align well with the PR objectives of refactoring the progress theme without introducing functional changes. The new naming convention should improve code readability and maintainability.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c329b5f and 2ad0c90.

📒 Files selected for processing (5)

• packages/theme/src/mixins/progress.less (0 hunks)
• packages/theme/src/progress/aurora-theme.js (1 hunks)
• packages/theme/src/progress/index.less (2 hunks)
• packages/theme/src/progress/old-theme.js (1 hunks)
• packages/theme/src/progress/vars.less (1 hunks)

💤 Files with no reviewable changes (1)

• packages/theme/src/mixins/progress.less

🚧 Files skipped from review as they are similar to previous changes (3)

• packages/theme/src/progress/aurora-theme.js
• packages/theme/src/progress/index.less
• packages/theme/src/progress/old-theme.js

🧰 Additional context used

🔇 Additional comments (3)

packages/theme/src/progress/vars.less (3)

13-22: Excellent refactoring of the progress component variables!

The changes in this section demonstrate several improvements:

1. The function name .inject-Progress-vars() is more descriptive and follows a consistent naming convention.
2. The use of CSS variables with fallback values (e.g., var(--tv-color-bg-gray-2, #e6e6e6)) enhances theming flexibility while providing default values.
3. The variable names are clear and self-explanatory, improving code readability.

These changes will make the progress component more maintainable and easier to customize.

---

34-36: Well-defined variables for right-side text styling

The variables for the right-side text margin and color are well-defined and consistent with the overall pattern:

1. --tv-Progress-right-text-margin-left uses a spacing variable with a fallback.
2. --tv-Progress-right-text-color uses a color variable with a fallback.

These definitions maintain consistency and flexibility in the theming system.

---

26-30: ⚠️ Potential issue

Use a CSS variable for the exception background color

While the success and warning states use CSS variables with fallback values, the exception state still uses a hard-coded color value. This inconsistency was previously noted but hasn't been addressed.

To maintain consistency and improve theming flexibility, consider updating line 30 as follows:

- --tv-Progress-bg-color-exception: #c7000b;
+ --tv-Progress-bg-color-exception: var(--tv-color-exception-bg, #c7000b);

This change will align the exception state with the pattern used for other states and enhance the overall theming capabilities of the progress component.