driver.js/dist/driver.js.d.ts

<h1 align="center"><img height="150" src="https://driverjs.com/driver.svg" /><br> Driver.js</h1>

// Generated by dts-bundle-generator v8.0.1

export type StageDefinition = {
	x: number;
	y: number;
	width: number;
	height: number;
};
export type State = {
	isInitialized?: boolean;
	activeIndex?: number;
	activeElement?: Element;
	activeStep?: DriveStep;
	previousElement?: Element;
	previousStep?: DriveStep;
	popover?: PopoverDOM;
	__previousElement?: Element;
	__activeElement?: Element;
	__previousStep?: DriveStep;
	__activeStep?: DriveStep;
	__activeOnDestroyed?: Element;
	__resizeTimeout?: number;
	__transitionCallback?: () => void;
	__activeStagePosition?: StageDefinition;
	__overlaySvg?: SVGSVGElement;
};
declare function getState(): State;
declare function getState<K extends keyof State>(key: K): State[K];
export type DriverHook = (element: Element | undefined, step: DriveStep, opts: {
	config: Config;
	state: State;
}) => void;
export type Config = {
	steps?: DriveStep[];
	animate?: boolean;
	overlayColor?: string;
	overlayOpacity?: number;
	smoothScroll?: boolean;
	allowClose?: boolean;
	stagePadding?: number;
	stageRadius?: number;
	disableActiveInteraction?: boolean;
	allowKeyboardControl?: boolean;
	popoverClass?: string;
	popoverOffset?: number;
	showButtons?: AllowedButtons[];
	disableButtons?: AllowedButtons[];
	showProgress?: boolean;
	progressText?: string;
	nextBtnText?: string;
	prevBtnText?: string;
	doneBtnText?: string;
	onPopoverRender?: (popover: PopoverDOM, opts: {
		config: Config;
		state: State;
	}) => void;
	onHighlightStarted?: DriverHook;
	onHighlighted?: DriverHook;
	onDeselected?: DriverHook;
	onDestroyStarted?: DriverHook;
	onDestroyed?: DriverHook;
	onNextClick?: DriverHook;
	onPrevClick?: DriverHook;
	onCloseClick?: DriverHook;
};
declare function configure(config?: Config): void;
declare function getConfig(): Config;
declare function getConfig<K extends keyof Config>(key: K): Config[K];
export type Side = "top" | "right" | "bottom" | "left" | "over";
export type Alignment = "start" | "center" | "end";
export type AllowedButtons = "next" | "previous" | "close";
export type Popover = {
	title?: string;
	description?: string;
	side?: Side;
	align?: Alignment;
	showButtons?: AllowedButtons[];
	showProgress?: boolean;
	disableButtons?: AllowedButtons[];
	popoverClass?: string;
	progressText?: string;
	doneBtnText?: string;
	nextBtnText?: string;
	prevBtnText?: string;
	onPopoverRender?: (popover: PopoverDOM, opts: {
		config: Config;
		state: State;
	}) => void;
	onNextClick?: DriverHook;
	onPrevClick?: DriverHook;
	onCloseClick?: DriverHook;
};
export type PopoverDOM = {
	wrapper: HTMLElement;
	arrow: HTMLElement;
	title: HTMLElement;
	description: HTMLElement;
	footer: HTMLElement;
	progress: HTMLElement;
	previousButton: HTMLButtonElement;
	nextButton: HTMLButtonElement;
	closeButton: HTMLButtonElement;
	footerButtons: HTMLElement;
};
declare function requireRefresh(): void;
export type DriveStep = {
	element?: string | Element;
	onHighlightStarted?: DriverHook;
	onHighlighted?: DriverHook;
	onDeselected?: DriverHook;
	popover?: Popover;
};
export declare function driver(options?: Config): {
	isActive: () => boolean;
	refresh: typeof requireRefresh;
	drive: (stepIndex?: number) => void;
	setConfig: typeof configure;
	setSteps: (steps: DriveStep[]) => void;
	getConfig: typeof getConfig;
	getState: typeof getState;
	getActiveIndex: () => number | undefined;
	isFirstStep: () => boolean;
	isLastStep: () => boolean;
	getActiveStep: () => DriveStep | undefined;
	getActiveElement: () => Element | undefined;
	getPreviousElement: () => Element | undefined;
	getPreviousStep: () => DriveStep | undefined;
	moveNext: () => void;
	movePrevious: () => void;
	moveTo: (index: number) => void;
	hasNextStep: () => false | DriveStep;
	hasPreviousStep: () => false | DriveStep;
	highlight: (step: DriveStep) => void;
	destroy: () => void;
};
export type Driver = ReturnType<typeof driver>;

export {};