Skip to content

OrigamStepper ​

A multi-step progress indicator used to guide users through sequential flows (Account → Profile → Plan → Confirm). Supports horizontal and vertical orientations, active/done/pending/error states, connecting lines, icons, and clickable navigation.

Usage ​

Basic (declarative items array) ​

vue
<origam-stepper
  :items="[
    { title: 'Account', subtitle: 'Email & password' },
    { title: 'Profile', subtitle: 'Personal info' },
    { title: 'Plan', subtitle: 'Choose plan' },
    { title: 'Confirm', subtitle: 'Review & submit' }
  ]"
  :model-value="1"
/>

Vertical orientation ​

vue
<origam-stepper
  :items="steps"
  v-model="currentStep"
  orientation="vertical"
/>

Clickable with v-model ​

vue
<origam-stepper
  v-model="currentStep"
  :items="steps"
  :clickable="true"
/>

Explicit item statuses ​

vue
<origam-stepper
  :items="[
    { title: 'Account', status: 'done' },
    { title: 'Profile', status: 'done' },
    { title: 'Plan',    status: 'active' },
    { title: 'Billing', status: 'error' },
    { title: 'Confirm', status: 'pending' }
  ]"
/>

With icons ​

vue
<origam-stepper
  :items="[
    { title: 'Account',  icon: MDI_ICONS.ACCOUNT },
    { title: 'Settings', icon: MDI_ICONS.COG },
    { title: 'Payment',  icon: MDI_ICONS.CREDIT_CARD },
    { title: 'Confirm',  icon: MDI_ICONS.CHECK_CIRCLE }
  ]"
  :model-value="0"
/>

Props — IStepperProps ​

PropTypeDefaultDescription
itemsIStepperItem[]undefinedDeclarative step definitions
modelValuenumber0Index of the active step (0-based)
orientation'horizontal' | 'vertical''horizontal'Layout direction
clickablebooleanfalseAllow jumping to steps by clicking
showConnectorsbooleantrueShow connector lines between steps
colorTColor—Intent color (forwarded via provide/inject)
densityTDensity'default'Compact, default, or comfortable
sizeTSize'default'Component size scale
+ all ICommonsComponentPropsid, class, style

IStepperItem payload ​

FieldTypeRequiredDescription
titlestringYesStep label
subtitlestringNoSecondary descriptive text
iconTIconNoOverrides the number indicator with a custom icon
statusTStepperItemStatusNoExplicit status; overrides auto-computed status

Status resolution ​

When status is not explicitly set on an item, it is computed from the wrapper's modelValue:

  • index < modelValue → done (checkmark shown)
  • index === modelValue → active (filled primary indicator)
  • index > modelValue → pending (outlined muted indicator)
  • Explicit status prop always wins over computed status.

Status values (TStepperItemStatus) ​

ValueIndicator
pendingOutlined circle, muted number
activeFilled primary circle, number
doneFilled primary circle, checkmark icon
errorFilled danger circle, exclamation icon

Connector lines ​

A thin horizontal (or vertical) line connects adjacent steps. The connector color is:

  • --origam-stepper---connector-color (default: color.border.subtle) when the preceding step is pending
  • --origam-stepper---connector-color-done (default: color.action.primary.bg) when the preceding step is done or active

Disable connectors with :show-connectors="false".

Accessibility ​

  • The wrapper renders as <nav aria-label="Progress steps">.
  • Each item has aria-current="step" when active.
  • Clickable items render as <button> elements with full keyboard focus support.
  • Icon-only indicators have aria-hidden="true" — the step number and title convey semantics.

Design tokens ​

CSS variableDefault sourceDescription
--origam-stepper---indicator-sizespace.8 (32px)Indicator circle diameter
--origam-stepper---indicator-active-bgcolor.action.primary.bgActive indicator background
--origam-stepper---indicator-done-bgcolor.action.primary.bgDone indicator background
--origam-stepper---indicator-error-bgcolor.feedback.danger.bgError indicator background
--origam-stepper---connector-colorcolor.border.subtlePending connector color
--origam-stepper---connector-color-donecolor.action.primary.bgDone connector color
--origam-stepper---title-font-sizefont.size.mdStep title font size
--origam-stepper---subtitle-colorcolor.text.secondarySubtitle text color