embla-carousel-auto-scroll
Version:
An auto scroll plugin for Embla Carousel
24 lines (23 loc) • 772 B
TypeScript
import { OptionsType } from './Options.js';
import { CreatePluginType } from 'embla-carousel';
declare module 'embla-carousel' {
interface EmblaPluginsType {
autoScroll: AutoScrollType;
}
interface EmblaEventListType {
autoScrollPlay: 'autoScroll:play';
autoScrollStop: 'autoScroll:stop';
}
}
export type AutoScrollType = CreatePluginType<{
play: (delay?: number) => void;
stop: () => void;
reset: () => void;
isPlaying: () => boolean;
}, OptionsType>;
export type AutoScrollOptionsType = AutoScrollType['options'];
declare function AutoScroll(userOptions?: AutoScrollOptionsType): AutoScrollType;
declare namespace AutoScroll {
let globalOptions: AutoScrollOptionsType | undefined;
}
export default AutoScroll;