@sourceloop/user-onboarding-client
Version:
Library for providing a smooth user onboarding
44 lines • 1.11 kB
TypeScript
import { TourButton } from './tour-button';
import { Type } from '@angular/core';
export interface TourStep {
id: string;
nextStepId: string;
prevStepId: string;
title?: string;
text: string | {
component: string;
} | (() => string);
arrow?: boolean;
attachTo?: {
element: string | Element;
on: string;
type: 'string' | 'function' | 'element';
scrollTo: boolean;
};
classes?: string;
advanceOn?: {
element: string | Element;
event: string;
elementType: 'string' | 'function' | 'element';
};
buttons?: TourButton[];
currentRoute?: string;
nextRoute?: string;
prevRoute?: string;
cancelIcon?: {
enabled?: boolean;
label?: string;
};
modalOverlayOpeningRadius?: number;
modalOverlayOpeningPadding?: number;
popperOptions?: object;
}
export declare type ComponentStep = {
forStep: string;
component: Type<unknown>;
};
export declare type HTMLStep = {
forStep: string;
html: () => string;
};
//# sourceMappingURL=tour-step.d.ts.map