Allowed passing customized icon for completed steps in Stepper
#2345
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smmr-dn
changed the title
Stepper
…TwinUI into uyen/stepper-custom-icon
smmr-dn
requested review from
mayank99 and
r100-stack
and removed request for
a team
mayank99
reviewed
Nov 18, 2024
r100-stack
reviewed
Nov 18, 2024
mayank99
reviewed
Nov 18, 2024
…TwinUI into uyen/stepper-custom-icon
r100-stack
reviewed
Nov 19, 2024
r100-stack
approved these changes
Nov 19, 2024
|
|
||
| By default, each step circle shows the step number. However, users can customize the icon or content displayed for each step in the `Stepper` component by providing the `stepContent` property in each item of the `steps` array. | ||
|
|
||
| This property is a function that takes the step index and returns custom content to represent the status of each step. A common use case for this customization is to indicate step completion. |
There was a problem hiding this comment.
nit: it no longer takes the step index.
Suggested change
| This property is a function that takes the step index and returns custom content to represent the status of each step. A common use case for this customization is to indicate step completion. | |
| This property is a function that returns custom content to represent the status of each step. A common use case for this customization is to indicate step completion. |
There was a problem hiding this comment.
I have made the change.
mayank99
approved these changes
Nov 19, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Added a new
stepContentprop in thestepsarray forSteppercomponent which allows users passing in their customized icon or content to replace the default step number for completed steps.Testing
Added unit tests.
Docs
Added minor changeset. Updated documentation as well as stories for
Stepper.After-PR TODO:
Stepper#2345 (comment))