setup-wizard-item.md

SetupWizardItem

Source

An item that represents one step in a SetupWizard.

Usage

You should have the chayns-components package installed. If that is not the case already, run

yarn add chayns-components

or

npm i chayns-components

After the chayns-components package is installed, you can import the component and use it with React:

import React from 'react'
import { SetupWizardItem } from 'chayns-components';

// ...

<SetupWizardItem {...} />

Props

The SetupWizardItem-component takes the following props:

Name	Type	Default	Required
step	number		✓
title	string		✓
required	boolean	false
right	ReactNode | { complete: ReactNode, notComplete: ReactNode }

step

step: number;

The index of the step (0-based).

---

title

title: string;

The title of the step.

---

required

required?: boolean

Wether the step is required to continue the wizard.

---

right

right?: ReactNode | { complete: ReactNode, notComplete: ReactNode }

A component that is shown on the right hand of the accordion head.