Mixins / foldkit-mixins-ui

StepsView

interface · packages/mixins-ui/src/steps.ts:32

interface StepsView<Message> {
  readonly label: string
  readonly steps: ReadonlyArray<Step>
  readonly current: number
  readonly onSelect?: ((index: number) => NoInfer<Message>) | undefined
  readonly style?: NamedStyle<typeof StepsSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

StepsView.label

property · packages/mixins-ui/src/steps.ts:34

readonly label: string

The list's accessible name.

StepsView.steps

property · packages/mixins-ui/src/steps.ts:35

readonly steps: ReadonlyArray<Step>

StepsView.current

property · packages/mixins-ui/src/steps.ts:37

readonly current: number

The index of the step being taken.

StepsView.onSelect

property · packages/mixins-ui/src/steps.ts:39

readonly onSelect?: ((index: number) => NoInfer<Message>) | undefined

Makes each completed step a button that sends this with its index.

StepsView.style

property · packages/mixins-ui/src/steps.ts:41

readonly style?: NamedStyle<typeof StepsSlots> | undefined

A style of StepsSlots, for the look.

StepsView.mixins

property · packages/mixins-ui/src/steps.ts:43

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.