preline/src/plugins/carousel/interfaces.ts

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

import { TCarouselOptionsSlidesQty } from './types';

export interface ICarouselOptions {
	currentIndex: number;
	loadingClasses?: string | string[];
	dotsItemClasses?: string;
	mode?: 'default' | 'scroll-nav';
	isAutoHeight?: boolean;
	isAutoPlay?: boolean;
	isCentered?: boolean;
	isDraggable?: boolean;
	isInfiniteLoop?: boolean;
	isRTL?: boolean;
	isSnap?: boolean;
	hasSnapSpacers?: boolean;
	slidesQty?: TCarouselOptionsSlidesQty | number;
	speed?: number;
	updateDelay?: number;
}

export interface ICarousel {
	options?: ICarouselOptions;

	recalculateWidth(): void;
	goToPrev(): void;
	goToNext(): void;
	goTo(i: number): void;
	destroy(): void;
}