@atom-learning/components 2.11.1 → 2.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -3
- package/dist/components/chip/Chip.js +1 -1
- package/dist/components/empty-state/EmptyStateBody.d.ts +3 -2
- package/dist/components/heading/Heading.d.ts +1 -0
- package/dist/components/heading/Heading.js +1 -1
- package/dist/components/label/Label.js +1 -1
- package/dist/components/link/Link.d.ts +2 -1
- package/dist/components/link/Link.js +1 -1
- package/dist/components/list/List.d.ts +2 -1
- package/dist/components/list/List.js +1 -1
- package/dist/components/navigation/NavigationMenuItem.d.ts +3 -2
- package/dist/components/stepper/Stepper.js +1 -1
- package/dist/components/stepper/StepperStepBullet.js +1 -1
- package/dist/components/stepper/StepperStepContainer.d.ts +2 -1
- package/dist/components/stepper/StepperStepContainer.js +1 -1
- package/dist/components/stepper/StepperStepLabel.d.ts +3 -2
- package/dist/components/stepper/StepperSteps.js +1 -1
- package/dist/components/stepper/stepper-context/StepperContext.js +1 -1
- package/dist/components/stepper/types.d.ts +3 -0
- package/dist/components/text/Text.d.ts +37 -5
- package/dist/components/text/Text.js +1 -1
- package/dist/components/top-bar/TopBarBrand.d.ts +3 -2
- package/dist/docgen.json +1 -1
- package/dist/docs/Stepper.mdx +26 -2
- package/dist/index.cjs.js +1 -1
- package/package.json +1 -1
package/dist/docs/Stepper.mdx
CHANGED
|
@@ -84,7 +84,7 @@ Below is an example that shows how to use the controlled component. Each object
|
|
|
84
84
|
status: 'active'
|
|
85
85
|
},
|
|
86
86
|
{
|
|
87
|
-
label: 'Step
|
|
87
|
+
label: 'Step 3',
|
|
88
88
|
status: 'default'
|
|
89
89
|
}
|
|
90
90
|
]}
|
|
@@ -109,7 +109,7 @@ Below is an example that shows how to hide step labels
|
|
|
109
109
|
status: 'active'
|
|
110
110
|
},
|
|
111
111
|
{
|
|
112
|
-
label: 'Step
|
|
112
|
+
label: 'Step 3',
|
|
113
113
|
status: 'default'
|
|
114
114
|
}
|
|
115
115
|
]}
|
|
@@ -119,6 +119,30 @@ Below is an example that shows how to hide step labels
|
|
|
119
119
|
</Stepper>
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
+
The root `Stepper` component also allows the user to pass a `showCompletedIcons` prop in order to replace step numbers with tick icons when the step has been completed. This defaults to `false`.
|
|
123
|
+
|
|
124
|
+
```tsx preview
|
|
125
|
+
<Stepper
|
|
126
|
+
steps={[
|
|
127
|
+
{
|
|
128
|
+
label: 'Step 1',
|
|
129
|
+
status: 'completed'
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
label: 'Step 2',
|
|
133
|
+
status: 'active'
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
label: 'Step 3',
|
|
137
|
+
status: 'default'
|
|
138
|
+
}
|
|
139
|
+
]}
|
|
140
|
+
showCompletedIcons
|
|
141
|
+
>
|
|
142
|
+
<Stepper.Steps />
|
|
143
|
+
</Stepper>
|
|
144
|
+
```
|
|
145
|
+
|
|
122
146
|
The root `Stepper` component also allows the user to pass a `direction` prop in order to the alternate the component direction .
|
|
123
147
|
|
|
124
148
|
Below is an example that shows how to render steps in vertical direction.
|