On this page
@addTagHelper *, Webority.Ui.RazorStep states
Mark each step done, skipped or to do, so a new user sees what is left and where to go next.
Two of four done
- Done: Add your company
- Invite your teamUp to 5 people on the trial
- Skipped: Connect email
- Create your first invoice
Complete
Once every step is done or skipped, the card starts folded, so a finished setup stops taking up the screen.
All set
- Done: Add your company
- Done: Invite your team
- Skipped: Connect email
- Done: Create your first invoice
Dismiss and restore
Dismiss the checklist to a single button that brings it back, and give each one a storage key to keep the choice.
Remembered across visits
- Done: Add your company
- Invite your teamUp to 5 people on the trial
- Skipped: Connect email
- Create your first invoice
Every option
Every value of every prop, one cell each.
steps: status, all four
status="todo" (default)- Choose a plan
- Add your company
status="done"- Done: Add your company
status="current"- Add your company
status="skipped"- Skipped: Add your company
steps: label, description and href
label: what to do, required- Invite your team
description: a second line under the label- Invite your teamUp to 5 people on the trial
href: the label becomes a linktitle
title="Get started" (default)- Add your company
title="Set up Acme"- Add your company
defaultCollapsed
default-collapsed unset (default): folds when all done- Done: Add your company
- Done: Invite your team
default-collapsed="false"- Done: Add your company
- Invite your team
default-collapsed="true"- Done: Add your company
- Invite your team
defaultDismissed
default-dismissed="false" (default)- Add your company
default-dismissed="true"- Add your company
storageKey
storage-key="every-option": remembers a dismissal- Add your company
dismissLabel and restoreLabel
dismiss-label="Close setup": names the close icon- Add your company
restore-label="Bring it back": the restore button text- Add your company
callbacks: onClose, onRestore and onCollapsedChange
onClose (React only): raises wui:onboarding:dismiss- Add your company
onRestore (React only): raises wui:onboarding:restore- Add your company
onCollapsedChange (React only): raises wui:onboarding:collapse- Add your company
linkComponent
linkComponent (React only): steps take hrefclassName
className (React only): Razor sets no root class- Add your company
Guidance
What to do, and what to avoid.
Use it when
- A new user's first visit, where a few setup steps unlock the product.
- Setup that spans several screens and may be done in any order.
Reach for something else when
- A strict sequence the user must follow in one flow. → AppStepper or AppWizard
- A guided walk over one screen's controls. → AppTour
Reference
Try every prop, read the full list, and check keyboard and screen reader behaviour.
10 props. The 4 most used come first.
Used on most screens 4 props
| Prop | Type | Default | Description |
|---|---|---|---|
| titledefault Get started | string | Get started | The heading, and the name of the progress bar. |
| default-collapseddefault - | bool | - | Whether the steps start collapsed. Unset, they start collapsed when every step is done or skipped. |
| default-dismisseddefault false | bool | false | Whether the checklist starts dismissed, showing only the restore button. |
| storage-keydefault - | string | - | Remembers a dismissal across visits under this key, one per checklist. Unset, the dismissal lasts the page. |
Less common 6 props
| Prop | Type | Default | Description |
|---|---|---|---|
| dismiss-labeldefault Dismiss checklist | string | Dismiss checklist | The name and tooltip of the close icon. |
| restore-labeldefault Show setup checklist | string | Show setup checklist | The text of the button that brings a dismissed checklist back. |
| (app-onboarding-step) labeldefault - | string | - | What to do ("Invite your team"). |
| (app-onboarding-step) descriptiondefault - | string | - | A secondary line under the label. |
| (app-onboarding-step) hrefdefault - | string | - | Makes the label a link to where the step is done. |
| (app-onboarding-step) statusdefault todo | done | current | skipped | todo | todo | The step's state. With none current, the first step to do is. |
Screen reader
5 notes- The card is named by its title, and the progress bar is named by the same title.
- The heading toggle sets aria-expanded and aria-controls, so a screen reader hears whether the steps are open.
- The progress bar is a progressbar whose value is the number of steps done, read as a count such as 2 of 4 done.
- A step that is done or skipped is read out as Done or Skipped before its label, so the mark alone carries no state.
- The current step carries aria-current set to step.