UNPKG

@gfazioli/mantine-onboarding-tour

Version:

A Mantine 9 onboarding tour component with focus-reveal overlays, cutout highlights, step-by-step popover navigation, and compound components for guided user experiences.

31 lines (30 loc) 1.72 kB
import { ElementProps, Factory, OverlayProps, TransitionOverride } from '@mantine/core'; import React from 'react'; import { OnboardingTourFocusRevealFocusedMode } from '../OnboardingTourFocusReveal/focus-reveal-modes'; import { ResponsivePopoverProps } from '../OnboardingTourFocusReveal/OnboardingTourFocusReveal'; export interface OnboardingTourFocusRevealGroupProps { /** OnboardingTourFocusReveal mode/effects when focused */ focusedMode?: OnboardingTourFocusRevealFocusedMode; /** Indicator if element should be revealed. Default `false` */ withReveal?: boolean; /** Will render overlay if set to `true` */ withOverlay?: boolean; /** Props passed down to `Overlay` component */ overlayProps?: OverlayProps & ElementProps<'div'>; /** Props passed down to the `Transition` component that used to animate the Overlay, use to configure duration and animation type, `{ duration: 150, transition: 'fade' }` by default */ transitionProps?: TransitionOverride; /** Props passed down to the `Popover` component. Position, offset, width, and arrowSize accept responsive objects. */ popoverProps?: ResponsivePopoverProps; /** Content */ children?: React.ReactNode; } export type OnboardingTourFocusRevealGroupStylesNames = 'onboarding-tour-focus-reveal-group'; export type OnboardingTourFocusRevealGroupFactory = Factory<{ props: OnboardingTourFocusRevealGroupProps; ref: HTMLDivElement; stylesNames: OnboardingTourFocusRevealGroupStylesNames; }>; export declare function OnboardingTourFocusRevealGroup(_props: OnboardingTourFocusRevealGroupProps): React.JSX.Element; export declare namespace OnboardingTourFocusRevealGroup { var displayName: string; }