Properties
Optional arrow
arrow?: boolean | {
pointAtCenter: boolean;
}
Optional className
className?: string
Optional closeIcon
closeIcon?: ReactNode
Optional cover
cover?: ReactNode
Optional current
current?: number
Optional description
description?: ReactNode
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 nextButtonProps
nextButtonProps?: {
children?: ReactNode;
className?: string;
onClick?: (() => void);
style?: CSSProperties;
}
Type declaration
Optional children?: ReactNode
Optional className?: string
Optional onClick?: (() => void)
Optional style?: CSSProperties
Optional onClose
onClose?: (() => void)
Optional onFinish
onFinish?: (() => void)
Optional onNext
onNext?: (() => void)
Optional onPrev
onPrev?: (() => void)
Optional placement
placement?: PlacementType
Optional prefixCls
prefixCls?: string
Optional prevButtonProps
prevButtonProps?: {
children?: ReactNode;
className?: string;
onClick?: (() => void);
style?: CSSProperties;
}
Type declaration
Optional children?: ReactNode
Optional className?: string
Optional onClick?: (() => void)
Optional style?: CSSProperties
Optional renderPanel
renderPanel?: ((step, current) => ReactNode)
Type declaration
- (step, current): ReactNode
Parameters
step: TourStepProps
current: number
Returns ReactNode
Optional scrollIntoViewOptions
scrollIntoViewOptions?: boolean | ScrollIntoViewOptions
Optional style
style?: CSSProperties
Optional total
total?: number
Optional type
type?: "default" | "primary"