Step progress
Show visitors where they are in a multi-step form.
Show visitors where they are in a multi-step form.
| Field | Value |
|---|
| Name | xp/form-field-step-progress |
| Title | Step progress |
| Category | xpac-form-util-field |
| API version | 3 |
| Keywords | xpac, form, steps, progress, stepper, wizard |
| Package | multi-step-form |
| Metadata file | dist/packages/multi-step-form/step-progress/block.json |
| Feature | Value |
|---|
className | Enabled |
color | {"text":true,"background":true,"__experimentalDefaultControls":{"text":true,"background":true}} |
customClassName | Disabled |
html | Disabled |
multiple | Enabled |
reusable | Disabled |
spacing | {"margin":["top","bottom"],"padding":true} |
typography | {"fontSize":true,"lineHeight":true,"__experimentalFontFamily":true,"__experimentalFontWeight":true,"__experimentalTextTransform":true,"__experimentalLetterSpacing":true,"__experimentalDefaultControls":{"fontSize":true}} |
| Name | Type | Default | Source/Enum |
|---|
activeColor | string | — | — |
activeTextColor | string | — | — |
className | string | — | — |
completedColor | string | — | — |
customActiveColor | string | — | — |
customActiveTextColor | string | — | — |
customCompletedColor | string | — | — |
customFormat | string | "" | — |
customTrackColor | string | — | — |
format | string | "step-of" | enum "step-of", "of", "slash", "percent", "custom" |
justification | string | "stretch" | enum "stretch", "left", "center", "right" |
lineWeight | string | "regular" | enum "thin", "regular", "thick" |
markerShape | string | "circle" | enum "circle", "rounded", "square" |
markerSize | string | "medium" | enum "small", "medium", "large" |
orientation | string | "horizontal" | enum "horizontal", "vertical" |
showCheck | boolean | true | — |
showCounter | boolean | true | — |
showNumbers | boolean | true | — |
showTitles | boolean | true | — |
titlePosition | string | "below" | enum "below", "beside" |
trackColor | string | — | — |
type | string | "stepper" | enum "stepper", "segments", "dots", "bar", "circle", "counter" |