UNPKG

ng-enjoyhint

Version:

<!-- This file is generated by 'pnpm run build', so it can include the API docs for the library. Do not edit this manually.

25 lines (24 loc) 1.17 kB
import { Signal } from '@angular/core'; import { Elements } from './util/dom-helpers'; import { IEnjoyHintOptions, ITutorialStep } from './lib.interfaces'; import { Overlay } from '@angular/cdk/overlay'; import * as i0 from "@angular/core"; export declare class EnjoyHintService { private readonly overlay; private readonly elements; private readonly originalOverflow; /** @ignore */ constructor(overlay: Overlay, elements: Elements, originalOverflow: string); private static readonly inProgressTutorials; /** Whether there is any active tutorial */ static readonly inProgress: Signal<boolean>; /** * Run an interactive tutorial * @param steps the tutorial steps to run * @param options optional object to override the default behavior * @returns a promise resolving when the tutorial is closed; resolves to `true` if the tutorial was completed, `false` if it was skipped */ runTutorial(steps: ITutorialStep[], options?: Partial<IEnjoyHintOptions>): Promise<boolean>; static ɵfac: i0.ɵɵFactoryDeclaration<EnjoyHintService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<EnjoyHintService>; }