Interface TourProps

interface TourProps {
    animated?: boolean | {
        placeholder: boolean;
    };
    arrow?: boolean | {
        pointAtCenter: boolean;
    };
    builtinPlacements?: BuildInPlacements | ((config?) => undefined | BuildInPlacements);
    className?: string;
    closeIcon?: ReactNode;
    current?: number;
    defaultCurrent?: number;
    disabledInteraction?: boolean;
    gap?: Gap;
    getPopupContainer?: ((node) => HTMLElement);
    indicatorsRender?: ((current, total) => ReactNode);
    mask?: boolean | {
        color?: string;
        style?: CSSProperties;
    };
    onChange?: ((current) => void);
    onClose?: ((current) => void);
    onFinish?: (() => void);
    onPopupAlign?: ((element, align) => void);
    open?: boolean;
    placement?: PlacementType;
    prefixCls?: string;
    rootClassName?: string;
    scrollIntoViewOptions?: boolean | ScrollIntoViewOptions;
    steps?: TourStepProps[];
    type?: "default" | "primary";
    zIndex?: number;
}

Hierarchy

  • Omit<RCTourProps, "renderPanel">
    • TourProps

Properties

animated? arrow? builtinPlacements? className? closeIcon? current? defaultCurrent? disabledInteraction? gap? getPopupContainer? indicatorsRender? mask? onChange? onClose? onFinish? onPopupAlign? open? placement? prefixCls? rootClassName? scrollIntoViewOptions? steps? type? zIndex?

Properties

Optional animated

animated?: boolean | {
    placeholder: boolean;
}

Type declaration

  • placeholder: boolean

Optional arrow

arrow?: boolean | {
    pointAtCenter: boolean;
}

Type declaration

  • pointAtCenter: boolean

Optional builtinPlacements

builtinPlacements?: BuildInPlacements | ((config?) => undefined | BuildInPlacements)

Type declaration

    • (config?): undefined | BuildInPlacements

    • Parameters

      • Optional config: {
            arrowPointAtCenter?: boolean;
        }
        • Optional arrowPointAtCenter?: boolean

      Returns undefined | BuildInPlacements

Optional className

className?: string

Optional closeIcon

closeIcon?: ReactNode

Optional current

current?: number

Optional defaultCurrent

defaultCurrent?: number

Optional disabledInteraction

disabledInteraction?: boolean

Optional gap

gap?: Gap

Optional getPopupContainer

getPopupContainer?: ((node) => HTMLElement)

Type declaration

Optional indicatorsRender

indicatorsRender?: ((current, total) => ReactNode)

Type declaration

    • (current, total): ReactNode

    • Parameters

      • current: number
      • total: number

      Returns ReactNode

Optional mask

mask?: boolean | {
    color?: string;
    style?: CSSProperties;
}

Type declaration

  • Optional color?: string
  • Optional style?: CSSProperties

Optional onChange

onChange?: ((current) => void)

Type declaration

    • (current): void

    • Parameters

      • current: number

      Returns void

Optional onClose

onClose?: ((current) => void)

Type declaration

    • (current): void

    • Parameters

      • current: number

      Returns void

Optional onFinish

onFinish?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onPopupAlign

onPopupAlign?: ((element, align) => void)

Type declaration

    • (element, align): void

    • Parameters

      Returns void

Optional open

open?: boolean

Optional placement

placement?: PlacementType

Optional prefixCls

prefixCls?: string

Optional rootClassName

rootClassName?: string

Optional scrollIntoViewOptions

scrollIntoViewOptions?: boolean | ScrollIntoViewOptions

Optional steps

steps?: TourStepProps[]

Optional type

type?: "default" | "primary"

Optional zIndex

zIndex?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc