Interface RenderWizardOptions

Options accepted by renderWizard.

interface RenderWizardOptions {
    activeIndex?: number;
    height?: number;
    labels?: WizardLabels;
    navigationCharacters?: WizardNavigationCharacters;
    markers?: StepIndicatorMarkers;
    steps: readonly WizardStep[];
    width?: number;
}

Index

Properties

activeIndex? height? labels? navigationCharacters? markers? steps width?

Properties

`Optional`activeIndex

activeIndex?: number

Active zero-based step index.

`Optional`height

height?: number

Maximum rendered height.

`Optional`labels

labels?: WizardLabels

Footer labels.

`Optional`navigationCharacters

navigationCharacters?: WizardNavigationCharacters

Directional characters used by the navigation footer.

`Optional`markers

markers?: StepIndicatorMarkers

Step-indicator markers.

steps

steps: readonly WizardStep[]

Ordered, non-empty Wizard pages.

`Optional`width

width?: number

Maximum terminal-cell width.