@igo2/common
Version:
36 lines (35 loc) • 983 B
TypeScript
import { Placement } from '@floating-ui/utils';
export interface InteractiveTourStep {
element?: string;
position?: InteractiveTourPlacement;
title?: string;
text: string;
beforeShow?: InteractiveTourAction;
beforeChange?: InteractiveTourAction;
onShow?: InteractiveTourAction;
onHide?: InteractiveTourAction;
class?: string;
highlightClass?: string;
scrollToElement?: boolean;
disableInteraction?: boolean;
noBackButton?: boolean;
}
type InteractiveTourPlacement = 'auto' | Placement;
export interface InteractiveTourAction {
element?: string;
action: 'click';
condition?: string;
waitFor?: string;
maxWait?: number;
}
export interface InteractiveTourOptions {
steps: InteractiveTourStep[];
position?: InteractiveTourPlacement;
title?: string;
highlightClass?: string;
class?: string;
scrollToElement?: boolean;
disableInteraction?: boolean;
conditions?: string[];
}
export {};