Microguide

The Microguide supports the onboarding of new users, as well as the introduction of new features to existing users. It can have one or multiple steps, each of which has three optional slots: Title, Visual and Content.

OverviewPropertiesUsage

MicroguideProps

extends, , ,

Name	Type	Default	Description
open		-	Whether the Microguide is currently shown or not. Has to be controlled by the consumer.
placement?	| | |	'bottom-right'	Placement of the Microguide.
onClose	(currentStep: , finished: ) =>	-	Callback fired when closing the Microguide. Indicates the current step (zero-based) when closing and whether the Microguide was finished (i.e. closed in the last step).
onStepChange?	(step: ) =>	-	Callback fired when the user navigates between steps. Indicates the target step (zero-based).

Microguide.Step

MicroguideStepProps — deprecated

No longer necessary as it is replaced by PropsWithChildren.

extends

Microguide.Content

ContentProps

extends, ,

Microguide.Title

You can use the Microguide.Title component to render a title for the Microguide overlay.

TitleProps

extends, ,

Microguide.Visual

VisualProps

extends, ,