Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 16, 2025

Prev Next function return step index

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5372

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Update the step component to return the current step index when moving between steps. Add a reset method to reset the step to its initial state.

Bug Fixes:

Enhancements:

  • Modify the Next and Prev methods to return the current step index after the step change.
  • Renamed the Next and Prev methods to better reflect their updated functionality.
  • Add a Reset method to reset the step to the initial state

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 16, 2025

Reviewer's Guide by Sourcery

The Prev and Next methods in the Step component were modified to return the current step index.

Sequence diagram for the Prev method

sequenceDiagram
  participant Step
  Step->>Step: _currentStepIndex = Math.Max(0, _currentStepIndex - 1)
  Step->>Step: StateHasChanged()
  Step-->>Step: return _currentStepIndex
Loading

Sequence diagram for the Next method

sequenceDiagram
  participant Step
  Step->>Step: _currentStepIndex = Math.Min(Items.Count, _currentStepIndex + 1)
  alt IsFinished && OnFinishedCallback != null
    Step->>Step: await OnFinishedCallback()
  end
  Step->>Step: StateHasChanged()
  Step-->>Step: return _currentStepIndex
Loading

Updated class diagram for the Step component

classDiagram
  class Step {
    -int _currentStepIndex
    +List~StepItem~ Items
    +bool IsFinished
    +Func~Task~ OnFinishedCallback
    +void Prev()
    +Task Next()
    +void Reset()
  }

  Step -- StepItem : Contains
Loading

File-Level Changes

Change Details Files
Modified the Prev and Next methods in the Step component to return the current step index.
  • Updated the Prev method to return the current step index after moving to the previous step.
  • Updated the Next method to return the current step index after moving to the next step.
src/BootstrapBlazor/Components/Step/Step.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5372 Return _currentStepIndex in the Prev method.
#5372 Return _currentStepIndex in the Next method.
#5372 Make the StepIndex return _currentStepIndex. The PR does not modify the StepIndex property to return _currentStepIndex.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 16, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 16, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider whether the return value of Prev and Next is actually useful to callers.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang enabled auto-merge (squash) February 16, 2025 10:46
@codecov
Copy link

codecov bot commented Feb 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (459ea17) to head (f7fe3ff).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5376   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29218     29220    +2     
  Branches      4125      4125           
=========================================
+ Hits         29218     29220    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 19f6dfe into main Feb 16, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-step branch February 16, 2025 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Step): Prev Next function return step index

2 participants