preline/src/plugins/scroll-nav/interfaces.ts

Preline UI is an open-source set of prebuilt UI components based on the utility-first Tailwind CSS framework.

export interface IScrollNavOptions {
	paging?: boolean;
	autoCentering?: boolean;
}

export interface IScrollNavCurrentState {
	first: HTMLElement;
	last: HTMLElement;
	center: HTMLElement;
}

export interface IScrollNav {
	options?: IScrollNavOptions;

	getCurrentState(): IScrollNavCurrentState;
	goTo(el: Element, cb?: () => void): void;
	centerElement(el: HTMLElement, behavior: ScrollBehavior): void;
	destroy(): void;
}