@manta-eu/react/onboarding-modal

Type Aliases

OnboardingDismissReason

OnboardingDismissReason = "close-button" | "skip" | "escape" | "outside"

---

OnboardingModalProps

OnboardingModalProps = object

Properties

contentOffsetLeft?

optional contentOffsetLeft?: number

onComplete

onComplete: () => void

Returns

void

onDismiss

onDismiss: (reason) => void

Parameters

reason

OnboardingDismissReason

Returns

void

onStepChange?

optional onStepChange?: (step, index) => void

Parameters

step

OnboardingStep

index

number

Returns

void

open

open: boolean

steps

steps: OnboardingStep[]

---

OnboardingStep

OnboardingStep = object

Properties

description

description: string

hidden?

optional hidden?: boolean

image?

optional image?: object

alt?

optional alt?: string

src

src: string

imageContent?

optional imageContent?: ReactNode

primaryButtonLabel?

optional primaryButtonLabel?: string

sidebarHighlightId?

optional sidebarHighlightId?: string

title

title: string

Functions

OnboardingModal()

OnboardingModal(props): Element | null

Parameters

props

OnboardingModalProps

Returns

Element | null