Add splide.d.ts for typescript. Update version number.

dist/js/splide.esm.js

@@ -1,6 +1,6 @@
 /*!
  * Splide.js
- * Version  : 2.3.8
+ * Version  : 2.3.9
  * License  : MIT
  * Copyright: 2020 Naotoshi Fujita
  */
@@ -5810,12 +5810,13 @@ var COMPLETE = {
 };
 var LIGHT = {
   Options: components_options,
-  Elements: components_elements,
   Controller: controller,
+  Elements: components_elements,
   Track: components_track,
   Clones: components_clones,
   Layout: layout,
   Drag: drag,
+  Click: click,
   Arrows: components_arrows,
   Pagination: components_pagination,
   A11y: a11y

dist/js/splide.js

@@ -1,6 +1,6 @@
 /*!
  * Splide.js
- * Version  : 2.3.8
+ * Version  : 2.3.9
  * License  : MIT
  * Copyright: 2020 Naotoshi Fujita
  */
@@ -5800,12 +5800,13 @@ var COMPLETE = {
 };
 var LIGHT = {
   Options: components_options,
-  Elements: components_elements,
   Controller: controller,
+  Elements: components_elements,
   Track: components_track,
   Clones: components_clones,
   Layout: layout,
   Drag: drag,
+  Click: click,
   Arrows: components_arrows,
   Pagination: components_pagination,
   A11y: a11y

package.json

@@ -1,11 +1,12 @@
 {
   "name": "@splidejs/splide",
-  "version": "2.3.8",
+  "version": "2.3.9",
   "description": "Splide is a lightweight and powerful slider without any dependencies.",
   "author": "Naotoshi Fujita",
   "license": "MIT",
   "main": "dist/js/splide.js",
   "module": "dist/js/splide.esm.js",
+  "types": "src/js/splide.d.ts",
   "keywords": [
     "splide",
     "slider",

src/js/splide.d.ts

@@ -0,0 +1,667 @@
+/**
+ * Type definitions.
+ *
+ * @author    Naotoshi Fujita
+ * @copyright Naotoshi Fujita. All rights reserved.
+ */
+
+/**
+ * Type for a splide slider type.
+ */
+export type SplideType = 'slide' | 'loop' | 'fade';
+
+/**
+ * Type for a splide slider direction.
+ */
+export type SplideDirection = 'ltr' | 'rtl' | 'ttb';
+
+/**
+ * Type for a lazy load.
+ */
+export type LazyLoadType = 'nearby' | 'sequential';
+
+/**
+ * Type for an event name.
+ */
+export type SplideEvent = 'mounted' | 'updated' | 'move' | 'moved' | 'drag' | 'dragged' | 'visible' | 'hidden'
+	| 'active' | 'inactive' | 'arrows:mounted' | 'arrows:updated' | 'pagination:mounted' | 'pagination:updated'
+	| 'navigation:mounted' | 'autoplay:play' | 'autoplay:pause' | 'autoplay:playing' | 'lazyload:loaded';
+
+/**
+ * Options for each breakpoint.
+ */
+export interface BreakpointOptions {
+	/**
+	 * @default false
+	 */
+	rewind?: boolean;
+
+	/**
+	 * @default 400
+	 */
+	speed?: number;
+
+	/**
+	 * @default 0
+	 */
+	width?: number;
+
+	/**
+	 * @default 0
+	 */
+	height?: number;
+
+	/**
+	 * @default 0
+	 */
+	fixedWidth?: number | string;
+
+	/**
+	 * @default 0
+	 */
+	fixedHeight?: number | string;
+
+	/**
+	 * @default 0
+	 */
+	heightRatio?: number;
+
+	/**
+	 * @default 0
+	 */
+	perPage?: number;
+
+	/**
+	 * @default 0
+	 */
+	perMove?: number;
+
+	/**
+	 * @default 0
+	 */
+	clones?: number;
+
+	/**
+	 * @default false
+	 */
+	focus?: boolean | number | 'center';
+
+	/**
+	 * @default 0
+	 */
+	gap?: number | string;
+
+	/**
+	 * @default 0
+	 */
+	padding?: number
+		| string
+		| { left: number | string, right: number | string }
+		| { top: number | string, bottom: number | string };
+
+	/**
+	 * @default true
+	 */
+	pagination?: boolean;
+
+	/**
+	 * @default 'cubic-bezier(.42,.65,.27,.99)'
+	 */
+	easing?: string;
+
+	/**
+	 * @default true
+	 */
+	drag?: boolean;
+
+	/**
+	 * @default false
+	 */
+	destroy?: boolean;
+}
+
+/**
+ * All options.
+ */
+export interface SplideOptions extends BreakpointOptions {
+	/**
+	 * @default 'slide'
+	 */
+	type?: SplideType;
+
+	/**
+	 * @default 0
+	 */
+	rewindSpeed?: number;
+
+	/**
+	 * @default false
+	 */
+	autoWidth?: boolean,
+
+	/**
+	 * @default 0
+	 */
+	start?: number;
+
+	/**
+	 * @default true
+	 */
+	arrows?: boolean;
+
+	/**
+	 * @default ''
+	 */
+	arrowPath?: string,
+
+	/**
+	 * @default false
+	 */
+	autoplay?: boolean;
+
+	/**
+	 * @default 5000
+	 */
+	interval?: number;
+
+	/**
+	 * @default true
+	 */
+	pauseOnHover?: boolean;
+
+	/**
+	 * @default true
+	 */
+	pauseOnFocus?: boolean;
+
+	/**
+	 * @default true
+	 */
+	resetProgress?: boolean;
+
+	/**
+	 * @default false
+	 */
+	lazyLoad?: false | LazyLoadType;
+
+	/**
+	 * @default 1
+	 */
+	preloadPages?: number;
+
+	/**
+	 * @default true
+	 */
+	keyboard?: boolean;
+
+	/**
+	 * @default 30
+	 */
+	dragAngleThreshold?: number;
+
+	/**
+	 * @default 150
+	 */
+	swipeDistanceThreshold?: number;
+
+	/**
+	 * @default 0.6
+	 */
+	flickVelocityThreshold?: number;
+
+	/**
+	 * @default 600
+	 */
+	flickPower?: number;
+
+	/**
+	 * @default {number}
+	 */
+	flickMaxPages?: number;
+
+	/**
+	 * @default {string}
+	 */
+	direction?: SplideDirection;
+
+	/**
+	 * @default false
+	 */
+	cover?: boolean;
+
+	/**
+	 * @default true
+	 */
+	accessibility?: boolean;
+
+	/**
+	 * @default false
+	 */
+	isNavigation?: boolean;
+
+	/**
+	 * @default true
+	 */
+	trimSpace?: boolean | 'move';
+
+	/**
+	 * @default false
+	 */
+	updateOnMove?: boolean;
+
+	/**
+	 * @default 100
+	 */
+	throttle?: number;
+
+	/**
+	 * @default false
+	 */
+	breakpoints?: boolean | { [ breakpoint: number ]: BreakpointOptions };
+
+	classes?: { [ key: string ]: string };
+
+	i18n?: { [ key: string ]: string };
+}
+
+/**
+ * Interface for an event object.
+ * It is created by Event constructor.
+ */
+export interface EventObject {
+	on( events: SplideEvent, handler: ( ...args: any ) => any ): void;
+	on( events: string, handler: ( ...args: any ) => any ): void;
+	on<K extends keyof ElementEventMap>(
+		events: K,
+		handler: ( e: ElementEventMap[K] ) => any,
+		elm?: HTMLElement | Window | Document,
+		options?: boolean | AddEventListenerOptions
+	): void;
+	on(
+		events: string,
+		handler: ( e: Event ) => any,
+		elm?: HTMLElement | Window | Document,
+		options?: boolean | AddEventListenerOptions
+	): void;
+
+	off( SplideEvent: string ): void;
+	off( events: string ): void;
+	off( events: string, elm?: Element | Window | Document ): void;
+
+	emit( events: string, ...args: any ): void;
+
+	destroy();
+}
+
+/**
+ * Collection of Splide states.
+ */
+export type StateMap = {
+	CREATED  : 1;
+	MOUNTED  : 2;
+	IDLE     : 3;
+	MOVING   : 4;
+	DESTROYED: 5;
+};
+
+/**
+ * Type for a Splide state.
+ */
+export type SplideState = StateMap[ keyof StateMap ];
+
+/**
+ * Interface for a State object.
+ * It is created by the State constructor.
+ */
+export interface StateObject {
+	set( state: SplideState ): void;
+	set( state: string | number ): void;
+
+	is( state: SplideState ): boolean;
+	is( state: string | number ): boolean;
+}
+
+/**
+ * Interface for a general component.
+ */
+export interface Component {
+	required?: boolean;
+
+	mount?(): void;
+	mounted?(): void;
+	destroy?( completely?: boolean ): void;
+}
+
+/**
+ * Collection of built-in components including Transition.
+ */
+export interface EssentialComponentCollection {
+	Options?: Options;
+	Breakpoints?: Breakpoints;
+	Controller?: Controller;
+	Elements?: Elements;
+	Track?: Track;
+	Clones?: Clones;
+	Layout?: Layout;
+	Drag?: Drag;
+	Click?: Click;
+	Autoplay?: Autoplay;
+	Cover?: Cover;
+	Arrows?: Arrows;
+	Pagination?: Pagination;
+	LazyLoad?: LazyLoad;
+	Keyboard?: Keyboard;
+	Sync?: Sync;
+	A11y?: A11y;
+	Transition?: Transition;
+}
+
+/**
+ * Interface for collection of all components including extensions.
+ */
+export interface ComponentCollection extends EssentialComponentCollection {
+	[ name: string ]: Component;
+}
+
+/**
+ * Type for a component constructor.
+ */
+export type ComponentConstructor = ( Splide: Splide, Components: ComponentCollection, name?: string ) => Component;
+
+/**
+ * Collection for component constructors(constructor functions).
+ */
+export interface ComponentConstructorCollection {
+	[ name: string ]: ComponentConstructor;
+}
+
+/**
+ * Interface for a transition component.
+ */
+export interface Transition extends Component {
+	start(
+		destIndex: number,
+		newIndex: number,
+		prevIndex: number,
+		coord: Coordinates,
+		done: () => void
+	):  void;
+}
+
+/**
+ * Type for a transition component constructor.
+ */
+export type TransitionConstructor = ( Splide: Splide, Components: ComponentCollection, name?: string ) => Transition;
+
+/**
+ * Type for coordinates
+ */
+export type Coordinates = { x: number, y: number };
+
+/**
+ * A11y component.
+ */
+export interface A11y extends Component {}
+
+/**
+ * Arrows component.
+ */
+export interface Arrows extends Component {
+	arrows: { prev: HTMLElement | undefined, next: HTMLElement | undefined };
+}
+
+/**
+ * Autoplay component.
+ */
+export interface Autoplay extends Component {
+	play( flag?: number ): void;
+	pause( flag?: number ): void;
+}
+
+/**
+ * Breakpoints component.
+ */
+export interface Breakpoints extends Component {
+	play( flag?: number ): void;
+	pause( flag?: number ): void;
+}
+
+/**
+ * Breakpoints component.
+ */
+export interface Click extends Component {}
+
+/**
+ * Clones component.
+ */
+export interface Clones extends Component {
+	readonly clones: HTMLElement[];
+	readonly length: number;
+}
+
+/**
+ * Controller component.
+ */
+export interface Controller extends Component {
+	readonly pageLength: number;
+	readonly edgeIndex: number;
+	readonly prevIndex: number;
+	readonly nextIndex: number;
+
+	go( control: string | number, silently: boolean ): void;
+	parse( control: string | number ): number;
+	toIndex( page: number ): number;
+	toPage( page: number ): number;
+	trim( index: number ): number;
+	rewind( index: number ): number;
+	isRtl(): boolean;
+}
+
+/**
+ * Cover component.
+ */
+export interface Cover extends Component {}
+
+/**
+ * Drag component.
+ */
+export interface Drag extends Component {
+	disabled: boolean;
+}
+
+/**
+ * Slide sub component.
+ */
+export interface Slide extends Component {
+	slide: HTMLElement,
+	index: number,
+	realIndex: number,
+	container: HTMLElement | null,
+	isClone: boolean,
+
+	update(): void;
+	isActive(): boolean;
+	isVisible(): boolean;
+	isWithin( from: number, within: number ): boolean;
+}
+
+/**
+ * Elements component.
+ */
+export interface Elements extends Component {
+	slider: HTMLElement | undefined;
+	track: HTMLElement;
+	list: HTMLElement;
+	slides: HTMLElement[];
+	arrows: { prev: HTMLElement | undefined, next: HTMLElement | undefined };
+	bar: HTMLElement | undefined;
+	play: HTMLElement | undefined;
+	pause: HTMLElement | undefined;
+
+	readonly length: number;
+	readonly total: number;
+
+	init(): void;
+	register( slide: HTMLElement, index: number, realIndex: number ): void;
+	getSlide( index: number ): Slide | undefined;
+	getSlides( includeClones: boolean ): Slide[];
+	getSlidesByPage( page: number ): Slide[];
+	add( slide: HTMLElement, index: number, callback: ( Slide: Slide ) => void ): void;
+	remove( index: number ): void;
+	each( callback: ( Slide: Slide ) => void ): void;
+}
+
+/**
+ * Keyboard component.
+ */
+export interface Keyboard extends Component {}
+
+/**
+ * Layout component.
+ */
+export interface Layout extends Component {
+	margin: string;
+	height: number;
+	listHeight: number;
+
+	readonly width: number;
+	readonly listWidth: number;
+
+	init(): void;
+	totalWidth( index: number | undefined ): number;
+	slideWidth( index: number ): number;
+	slideHeight( index: number ): number;
+}
+
+/**
+ * LazyLoad component.
+ */
+export interface LazyLoad extends Component {}
+
+/**
+ * Options component.
+ */
+export interface Options extends Component {}
+
+/**
+ * Interface for a pagination item.
+ */
+export interface PaginationItem {
+	li: HTMLLIElement;
+	button: HTMLButtonElement;
+	page: number;
+	Slides: Slide[],
+}
+
+/**
+ * Interface for pagination data.
+ */
+export interface PaginationData {
+	list: HTMLUListElement;
+	items: PaginationItem[];
+}
+
+/**
+ * Pagination component.
+ */
+export interface Pagination extends Component {
+	readonly data: PaginationData;
+
+	getItem( index: number ): PaginationItem | undefined;
+}
+
+/**
+ * Sync component.
+ */
+export interface Sync extends Component {}
+
+/**
+ * Track component.
+ */
+export interface Track extends Component {
+	axis: 'X' | 'Y';
+	sign: 1 | -1;
+
+	readonly position: number;
+
+	init(): void;
+
+	go( destIndex: number, newIndex: number, silently: boolean ): void;
+	jump( index: number ): void;
+	translate( position: number ): void;
+	trim( position: number ): number;
+	toCoord( position: number ): Coordinates;
+	toPosition( index: number ): Coordinates;
+	toIndex( index: number ): number;
+	offset(): number;
+}
+
+/**
+ * Main Splide class declaration.
+ */
+export class Splide {
+	root: HTMLElement;
+	Components: ComponentCollection | null;
+	Event: EventObject;
+	State: StateObject;
+	STATES: StateMap;
+
+	options: SplideOptions;
+	index: number;
+
+	private _o: SplideOptions;
+	private _i: number;
+	private _c: ComponentConstructorCollection;
+	private _e: ComponentConstructorCollection;
+	private _t: TransitionConstructor | null;
+
+	readonly length: number;
+	readonly classes: { [ key: string ]: string };
+	readonly i18n: { [ key: string ]: string };
+
+	constructor( selector: string | HTMLElement, options?: SplideOptions );
+
+	mount(
+		Extensions?: ComponentConstructorCollection,
+		Transition?: TransitionConstructor | null
+	): this;
+
+	sync( splide: Splide ): this;
+
+	on( events: SplideEvent, handler: ( ...args: any[] ) => any ): this;
+	on( events: string, handler: ( ...args: any[] ) => any ): this;
+	on<K extends keyof ElementEventMap>(
+		events: K,
+		handler: ( e: ElementEventMap[K] ) => any,
+		elm?: HTMLElement | Window | Document,
+		options?: boolean | AddEventListenerOptions
+	): this;
+	on(
+		events: string,
+		handler: ( e: Event ) => any,
+		elm?: HTMLElement | Window | Document,
+		options?: boolean | AddEventListenerOptions
+	): this;
+
+	off( events: SplideEvent ): this;
+	off( events: string ): this;
+	off( events: keyof ElementEventMap, elm?: Element | Window | Document ): this;
+	off( events: string, elm?: Element | Window | Document ): this;
+
+	emit( events: string, ...args: any[] ): this;
+
+	go( control: string | number, wait?: boolean ): this;
+
+	is( type: SplideType ): this;
+
+	add( slide: HTMLElement | string, index?: number ): this;
+
+	remove( index: number ): this;
+
+	refresh(): this;
+
+	destroy( completely: boolean ): this;
+}
+
+// Export the main class as default.
+export default Splide;