Interface OnboardingOverlayProps

Props for the OnboardingOverlay component.

Source

interface OnboardingOverlayProps {
  /** Position of the overlay on the screen. Defaults to "bottom-right". */
  position?:
    | "bottom-right"
    | "bottom-left"
    | "top-right"
    | "top-left"
    | "center";
  /** Whether to display the step progress indicator. Defaults to true. */
  shouldShowProgress?: boolean;
}
interface OnboardingOverlayProps {
    position?:
        | "center"
        | "bottom-right"
        | "bottom-left"
        | "top-right"
        | "top-left";
    shouldShowProgress?: boolean;
}

Properties

position? shouldShowProgress?

Properties

Optionalposition

position?: "center" | "bottom-right" | "bottom-left" | "top-right" | "top-left"

Position of the overlay on the screen. Defaults to "bottom-right".

OptionalshouldShowProgress

shouldShowProgress?: boolean

Whether to display the step progress indicator. Defaults to true.

Settings

Member Visibility

On This Page

Properties