Athenic UI Documentation

Stepper

Stepper

Stepper

import { Stepper } from "athenic-ui";

Example - Horizontal

<Stepper
currentStep={2}
direction="horizontal"
steps={["Sign Up", "Verify your Account", "Complete registration"]}
/>

Example - Vertical

<Stepper
currentStep={2}
direction="vertical"
steps={["Sign Up", "Verify your Account", "Complete registration"]}
/>

Example - With other Components

<Card title="Register">
<Stepper currentStep={stepperCardExample} steps={stepperCardExampleSteps} />
<br />
<Button
size="small"
variant="primary"
onClick={() => {
stepperCardExample > 1
? setStepperCardExample(stepperCardExample - 1)
: null;
console.log(stepperCardExample);
}}
>
👈 Previous
</Button>
<Button
size="small"
variant="primary"
onClick={() => {
stepperCardExample <= stepperCardExampleSteps.length
? setStepperCardExample(stepperCardExample + 1)
: null;
console.log(stepperCardExample);
}}
>
Next 👉
</Button>
</Card>

Props

  • steps: Steps
  • direction?: StepperDirection
  • currentStep: number

Types

  • Step: string
  • Steps: Step[]
  • StepperDirection: "horizontal" | "vertical"
  • StepState: { description: string; completed: boolean; selected: boolean; highlighted: boolean; }[]
Edit this page on GitHub