Navigation

Steps

@xui/steps

A step / wizard progress indicator. Bind current to the active index; each step's status (finish / process / wait) is derived automatically, or overridden per step. clickable lets the user jump between steps.

Install

pnpm add @xui/steps

Add the barrel to a standalone component's imports:

import { XuiStepsImports } from '@xui/steps';

@Component({
  imports: [XuiStepsImports],
  // …
})

Examples

Horizontal

Loading preview…

With error

Loading preview…

Vertical

Loading preview…

API

XuiStep

componentxui-step

One step inside {@link XuiSteps}. title/description describe it; status overrides the status the parent would otherwise derive from current.

Inputs

NameTypeDefaulttitlestringThe step's name, shown beside its marker.''descriptionstringSupporting detail under the title.''statusXuiStepStatusForce a status instead of deriving it from the active step.

XuiSteps

componentxui-steps

A step / wizard progress indicator. Wrap <xui-step> entries and bind current (two-way) to the active index; each step's status is derived (finish before, process at, wait after) unless the step overrides it. With clickable, clicking a step moves current.

Inputs

NameTypeDefaultclassClassValueExtra classes, merged into the component's own rather than replacing them.''currenttwo-waynumberZero-based index of the active step. Everything before it reads as done, everything after as pending. Two-way bindable.0orientation'horizontal' | 'vertical'Run the steps across the page or down it.this.config.orientationclickablebooleanLet a step header jump to that step. Off by default, so the sequence stays under the host's control.this.config.clickable

Source

libs/ui/steps/xui

xUI 2.0.0 — Apache 2.0 licensed. Built with Angular and Tailwind CSS.