Wrapper

The MiniWizard component wrapper.

circle-info

This is a compound component.

API

This component extends the native <div>arrow-up-right API. That's why the className prop is not included in the table.

Props
Type
Required

children

ReactNode

βœ…

selectedStep

string

βœ…

heading

ReactNode

❌

isOpen

boolean

❌

onClose

() => void;

βœ…

completedStepsBehavior

'resetAtClosing' | 'notResetingAtClosing'

❌

chevron-rightchildrenhashtag

The children in this case, because it is a compound component, should be the ones provided by this design system.

chevron-rightselectedStephashtag

Controls the content, footer and selected step.

chevron-rightheadinghashtag

The title of the MiniWizard.

chevron-rightisOpenhashtag

Used to control the open/closed state of the MiniWizard.

chevron-rightonClosehashtag

Function executed when the MiniWizard is closed.

chevron-rightcompletedStepsBehaviorhashtag

The behavior the MiniWizard uses. Either resetting itself after closing, or keeping the state. Client side only.

Last updated