Skip to content

Stepper

widgetsdisplay

Stepper: renders a sequence of steps with status indicators

Installation

$ bunx termuijs add stepper

Copies the source into src/components/stepper/ and installs @termuijs/core, @termuijs/widgets.

Usage

ts
import { Stepper } from '@termuijs/widgets'
ts
new Stepper(steps: StepperStep[], style: Partial<Style> = {}, opts: StepperOptions = {},)

API Reference

Stepper

PropTypeRequiredDescription
stepsStepperStep[]required
orientationStepperOrientationoptionalLayout direction
activeColorColoroptionalColor for active step
completedColorColoroptionalColor for completed step
pendingColorColoroptionalColor for pending step
#display#stepper