Interface OnboardingHighlightProps

Props for the OnboardingHighlight component.

Source

interface OnboardingHighlightProps {
  /** Whether the highlight is currently active and visible. */
  isActive: boolean;
  /** Spotlight configuration for the element to highlight. */
  spotlight?: ElementSpotlight;
  /** Callback fired when a highlighted action is completed. */
  onActionComplete?: () => void;
}
interface OnboardingHighlightProps {
    isActive: boolean;
    spotlight?: ElementSpotlight;
    onActionComplete?: () => void;
}

Properties

isActive spotlight? onActionComplete?

Properties

isActive

isActive: boolean

Whether the highlight is currently active and visible.

Optionalspotlight

spotlight?: ElementSpotlight

Spotlight configuration for the element to highlight.

OptionalonActionComplete

onActionComplete?: () => void

Callback fired when a highlighted action is completed.

Settings

Member Visibility

On This Page

Properties