Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(steps): Modify the rendering logic of the steps component based on the design draft #3399

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 9, 2025
Merged

fix(steps): Modify the rendering logic of the steps component based on the design draft #3399

merged 1 commit into from
May 9, 2025

Conversation

chenxi-20
Copy link
Collaborator

@chenxi-20 chenxi-20 commented May 8, 2025 •
edited by coderabbitai bot
Loading

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

  • Style
    • Updated the visual logic for the left step line, making its appearance depend on the status of the previous step and adjusting which statuses trigger the brand border color.
    • Changed the background color for completed step icons for improved visual consistency.

@chenxi-20 chenxi-20 added the bug Something isn't working label May 8, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 8, 2025 •
edited
Loading

Walkthrough

The changes update the logic for applying a CSS class to a step line element based on the statuses of the current and previous nodes, and adjust the background color for a specific icon class. No exported or public entity declarations were modified.

Changes

File(s) Change Summary
packages/vue/src/steps/src/mobile-first/mobile-first-normal.vue Updated the condition for applying the border-color-brand class to depend on the previous node's status and restricted applicable current node statuses.
packages/vue/src/steps/src/mobile-first/token/normal-token.ts Changed the background color for the icon-done class from bg-color-info-primary-subtler to bg-color-bg-1.

Poem

In the garden of steps, a border anew,
Logic now checks the node before you.
Icons wear a background, crisp and bright,
Marching through progress, left and right.
With every hop, the code refines—
A rabbit’s joy in tidy lines! 🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 99ba255 and 39474fc.

📒 Files selected for processing (2)
  • packages/vue/src/steps/src/mobile-first/mobile-first-normal.vue (1 hunks)
  • packages/vue/src/steps/src/mobile-first/token/normal-token.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (2)
packages/vue/src/steps/src/mobile-first/token/normal-token.ts (1)

14-14: Style update for completed steps.

The background color for completed step icons has been changed from bg-color-info-primary-subtler to bg-color-bg-1. This makes completed steps visually distinct from in-progress steps while maintaining the brand text color.

packages/vue/src/steps/src/mobile-first/mobile-first-normal.vue (1)

77-82: Improved step connection logic.

The rendering logic for step lines has been refined to better represent the progression state. Now the line connecting to a step only gets the brand color when:

  1. The previous step is completed ('done')
  2. The current step is either completed ('done') or unavailable ('disabled')

This change creates a more intuitive visual flow where the colored line represents a "path traveled" rather than just the current step's state.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@petercat-assistant PeterCat-assistant
Copy link

Walkthrough

This PR modifies the rendering logic of the steps component to align with the design draft. It includes changes to the conditional rendering of CSS classes and updates to token definitions for icons.

Changes

Files Summary
packages/vue/src/steps/src/mobile-first/mobile-first-normal.vue Adjusted the logic for applying the border-color-brand class based on the status of the previous step.
packages/vue/src/steps/src/mobile-first/token/normal-token.ts Changed the background color class for the icon-done token from bg-color-info-primary-subtler to bg-color-bg-1.

petercat-assistant[bot]
petercat-assistant bot reviewed May 8, 2025
View reviewed changes
packages/vue/src/steps/src/mobile-first/mobile-first-normal.vue
{ 'border-color-brand': ['done', 'doing'].includes(node[statusField]) }
{
'border-color-brand':
data[index - 1] &&
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure that data[index - 1] is valid before accessing data[index - 1][statusField] to prevent potential runtime errors if data[index - 1] is undefined.

@zzcr zzcr merged commit c181394 into dev May 9, 2025
10 of 11 checks passed
@zzcr zzcr deleted the fix/steps-mobile-first-20250508 branch May 9, 2025 02:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@petercat-assistant petercat-assistant[bot] petercat-assistant[bot] left review comments

@zzcr zzcr zzcr approved these changes

Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@chenxi-20 @zzcr