mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
8fc13890b2
* feat(intro.js): rework UMD module definition. Closes #41108 - definition exposes both factory functions and namespace - backward compatible with existing code - add class access to test to cover fixed use-case - prettier as per project settings /cc @ippeiukai Thanks! * Add 'export as namespace' as per PR comment /cc @ippeiukai
101 lines
3.1 KiB
TypeScript
101 lines
3.1 KiB
TypeScript
// Type definitions for intro.js 2.4
|
|
// Project: https://github.com/usablica/intro.js
|
|
// Definitions by: Maxime Fabre <https://github.com/anahkiasen>
|
|
// Leon Montealegre <https://github.com/LeonMontealegre>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
declare function introJs(): introJs.IntroJs;
|
|
declare function introJs(element: HTMLElement): introJs.IntroJs;
|
|
declare function introJs(querySelector: string): introJs.IntroJs;
|
|
|
|
declare namespace introJs {
|
|
interface Step {
|
|
intro: string;
|
|
element?: string | HTMLElement | Element;
|
|
position?:
|
|
| 'top'
|
|
| 'left'
|
|
| 'right'
|
|
| 'bottom'
|
|
| 'bottom-left-aligned'
|
|
| 'bottom-middle-aligned'
|
|
| 'bottom-right-aligned'
|
|
| 'auto';
|
|
tooltipClass?: string;
|
|
highlightClass?: string;
|
|
scrollTo?: 'off' | 'tooltip' | 'element';
|
|
disableInteraction?: boolean;
|
|
}
|
|
|
|
interface Hint {
|
|
hint: string;
|
|
element?: string | HTMLElement | Element;
|
|
hintPosition?: string;
|
|
}
|
|
|
|
interface Options {
|
|
nextLabel?: string;
|
|
prevLabel?: string;
|
|
skipLabel?: string;
|
|
doneLabel?: string;
|
|
hidePrev?: boolean;
|
|
hideNext?: boolean;
|
|
tooltipPosition?: string;
|
|
tooltipClass?: string;
|
|
highlightClass?: string;
|
|
exitOnEsc?: boolean;
|
|
exitOnOverlayClick?: boolean;
|
|
showStepNumbers?: boolean;
|
|
keyboardNavigation?: boolean;
|
|
showButtons?: boolean;
|
|
showBullets?: boolean;
|
|
showProgress?: boolean;
|
|
scrollToElement?: boolean;
|
|
overlayOpacity?: number;
|
|
scrollPadding?: number;
|
|
positionPrecedence?: string[];
|
|
disableInteraction?: boolean;
|
|
hintPosition?: string;
|
|
hintButtonLabel?: string;
|
|
hintAnimation?: boolean;
|
|
steps?: Step[];
|
|
hints?: Hint[];
|
|
}
|
|
interface IntroJs {
|
|
start(): IntroJs;
|
|
exit(): IntroJs;
|
|
clone(): IntroJs;
|
|
|
|
goToStepNumber(stepId: number): IntroJs;
|
|
goToStep(step: number): IntroJs;
|
|
nextStep(): IntroJs;
|
|
previousStep(): IntroJs;
|
|
|
|
refresh(): IntroJs;
|
|
|
|
setOption(option: string, value: string | number | boolean): IntroJs;
|
|
setOptions(options: Options): IntroJs;
|
|
|
|
onexit(callback: Function): IntroJs;
|
|
onbeforechange(callback: (element: HTMLElement) => any): IntroJs;
|
|
onafterchange(callback: (element: HTMLElement) => any): IntroJs;
|
|
onchange(callback: (element: HTMLElement) => any): IntroJs;
|
|
oncomplete(callback: Function): IntroJs;
|
|
|
|
addHints(): IntroJs;
|
|
showHint(stepId: number): IntroJs;
|
|
showHints(): IntroJs;
|
|
hideHint(stepId: number): IntroJs;
|
|
hideHints(): IntroJs;
|
|
removeHint(stepId: number): IntroJs;
|
|
removeHints(): IntroJs;
|
|
|
|
onhintsadded(callback: Function): IntroJs;
|
|
onhintclick(callback: (hintElement: HTMLElement, item: Step, stepId: number) => any): IntroJs;
|
|
onhintclose(callback: (stepId: number) => any): IntroJs;
|
|
}
|
|
}
|
|
|
|
export = introJs;
|
|
export as namespace introJs;
|