index.d.ts 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765
  1. /**
  2. * The interface for the Media component.
  3. *
  4. * @since 4.0.0
  5. */
  6. interface BreakpointsComponent extends BaseComponent {
  7. /** @internal */
  8. reduce(reduced: boolean): void;
  9. set(options: Options, base?: boolean, notify?: boolean): void;
  10. }
  11. /**
  12. * The interface for the Direction component.
  13. *
  14. * @since 3.0.0
  15. */
  16. interface DirectionComponent extends BaseComponent {
  17. resolve<K extends keyof typeof ORIENTATION_MAP>(prop: K, axisOnly?: boolean, direction?: Options['direction']): typeof ORIENTATION_MAP[K][number] | K;
  18. resolve<R extends string>(prop: R, axisOnly?: boolean, direction?: Options['direction']): R;
  19. orient(value: number): number;
  20. left(): string;
  21. right(): string;
  22. width(): string;
  23. }
  24. /**
  25. * The translation map for directions.
  26. *
  27. * @since 3.0.0
  28. */
  29. declare const ORIENTATION_MAP: {
  30. readonly width: readonly ["height"];
  31. readonly left: readonly ["top", "right"];
  32. readonly right: readonly ["bottom", "left"];
  33. readonly x: readonly ["y"];
  34. readonly X: readonly ["Y"];
  35. readonly Y: readonly ["X"];
  36. readonly ArrowLeft: readonly [string, string];
  37. readonly ArrowRight: readonly [string, string];
  38. };
  39. /**
  40. * The interface for elements which the slider consists of.
  41. *
  42. * @since 3.0.0
  43. */
  44. interface ElementCollection {
  45. root: HTMLElement;
  46. track: HTMLElement;
  47. list: HTMLElement;
  48. slides: HTMLElement[];
  49. arrows?: HTMLElement;
  50. pagination?: HTMLUListElement;
  51. prev?: HTMLButtonElement;
  52. next?: HTMLButtonElement;
  53. bar?: HTMLElement;
  54. toggle?: HTMLElement;
  55. }
  56. /**
  57. * The interface for the Elements component.
  58. *
  59. * @since 3.0.0
  60. */
  61. interface ElementsComponent extends BaseComponent, Readonly<ElementCollection> {
  62. }
  63. /**
  64. * The type that matches any function.
  65. */
  66. declare type AnyFunction$1 = (...args: any[]) => any;
  67. /**
  68. * The union for CSS properties.
  69. *
  70. * @since 0.0.1
  71. */
  72. declare type CSSProperties = Exclude<keyof CSSStyleDeclaration, number | 'length' | 'parentRule' | 'getPropertyPriority' | 'getPropertyValue' | 'item' | 'removeProperty' | 'setProperty'>;
  73. /**
  74. * The type for an array with remover functions.
  75. *
  76. * @since 0.0.1
  77. */
  78. declare type Removers = Set<[() => void, object?]>;
  79. /**
  80. * The interface for the EventBinder instance.
  81. *
  82. * @since 0.0.1
  83. */
  84. interface EventBinder {
  85. bind(target: EventTarget, events: string | string[], callback: AnyFunction$1, options?: AddEventListenerOptions): void;
  86. lock(): EventBinder;
  87. destroy(hard?: boolean): void;
  88. }
  89. /**
  90. * The constructor function to provide methods to subscribe native events.
  91. *
  92. * @since 0.0.1
  93. * @constructor
  94. *
  95. * @return An EventBinder instance.
  96. */
  97. declare function EventBinder(removersRef?: Removers): EventBinder;
  98. /**
  99. * The type for an array with a listener entry as `[ callback, key ]`.
  100. *
  101. * @since 0.0.1
  102. */
  103. declare type Listener = [AnyFunction$1, object?];
  104. /**
  105. * The collection of listeners.
  106. *
  107. * @since 0.0.1
  108. */
  109. declare type Listeners = Record<string, Listener[]>;
  110. /**
  111. * The interface for the EventBus instance.
  112. *
  113. * @since 0.0.1
  114. */
  115. interface EventBus<M extends Record<string, AnyFunction$1> = Record<string, AnyFunction$1>> {
  116. on<K extends keyof M & string>(event: K, callback: M[K]): void;
  117. on(events: string | string[], callback: AnyFunction$1): void;
  118. off<K extends keyof M & string>(event: K, callback?: M[K]): void;
  119. off(events: string | string[], callback?: AnyFunction$1): void;
  120. emit<K extends keyof M & string>(event: K, ...args: Parameters<M[K]>): void;
  121. emit(event: string, ...args: any[]): void;
  122. lock(): EventBus<M>;
  123. destroy(hard?: boolean): void;
  124. }
  125. /**
  126. * Provides the simple event system.
  127. * Note that `M` - type for an event map - must have index signature,
  128. * but that makes all callback function `AnyFunction`.
  129. * To avoid this:
  130. * - Use a type alias instead of interface.
  131. * - Or do like `EventBus<EventMap & Record<string, AnyFunction>, keyof EventMap>`.
  132. *
  133. * @see https://github.com/microsoft/TypeScript/issues/15300
  134. *
  135. * @since 0.0.1
  136. * @constructor
  137. *
  138. * @param listenersRef
  139. *
  140. * @return An EventBus instance.
  141. */
  142. declare function EventBus<M extends Record<string, AnyFunction$1>, K extends keyof M & string>(listenersRef?: Listeners): EventBus<M>;
  143. /**
  144. * The interface for the EventInterface object.
  145. *
  146. * @since 0.0.1
  147. */
  148. interface EventInterface$1<M extends Record<string, AnyFunction$1> = Record<string, AnyFunction$1>> extends Omit<EventBinder, 'lock'>, Omit<EventBus<M>, 'lock'> {
  149. lock(): EventInterface$1<M>;
  150. destroy(hard?: boolean): void;
  151. }
  152. /**
  153. * The constructor function that provides interface for both internal and native events.
  154. * Only the root `EventInterface` instance can destroy all locked instances.
  155. *
  156. * @since 0.0.1
  157. * @constructor
  158. * @internal
  159. *
  160. * @param binder - An `EventBinder` instance. Internal use only.
  161. * @param bus - An `EventBus` instance. Internal use only.
  162. *
  163. * @return A collection of interface functions.
  164. */
  165. declare function EventInterface$1<M extends Record<string, AnyFunction$1> = Record<string, AnyFunction$1>>(binder?: EventBinder, bus?: EventBus<Record<string, AnyFunction$1>>): EventInterface$1<M>;
  166. /**
  167. * The interface for the State object.
  168. *
  169. * @since 0.0.1
  170. */
  171. interface State {
  172. set(state: number): void;
  173. is(states: number | number[]): boolean;
  174. }
  175. /**
  176. * The function providing a super simple state system.
  177. *
  178. * @param initialState - Specifies the initial state.
  179. */
  180. declare function State(initialState: number): State;
  181. /**
  182. * The interface for the Slide sub component.
  183. *
  184. * @since 3.0.0
  185. */
  186. interface SlideComponent extends BaseComponent {
  187. readonly index: number;
  188. readonly slideIndex: number;
  189. readonly slide: HTMLElement;
  190. readonly container: HTMLElement;
  191. readonly isClone: boolean;
  192. update(): void;
  193. style(prop: CSSProperties, value: string | number, useContainer?: boolean): void;
  194. isWithin(from: number, distance: number): boolean;
  195. isVisible(partial?: boolean): boolean;
  196. }
  197. /**
  198. * The interface for the Layout component.
  199. *
  200. * @since 3.0.0
  201. */
  202. interface LayoutComponent extends BaseComponent {
  203. trackSize(): number;
  204. listSize(full?: boolean): number;
  205. slideSize(index: number, withoutGap?: boolean): number;
  206. sliderSize(withoutGap?: boolean): number;
  207. totalSize(index?: number, withoutGap?: boolean): number;
  208. getPadding(right: boolean): number;
  209. isOverflow(): boolean;
  210. /** @internal */
  211. resize(force?: boolean): void;
  212. }
  213. /**
  214. * The interface for the Clone component.
  215. *
  216. * @since 3.0.0
  217. */
  218. interface ClonesComponent extends BaseComponent {
  219. }
  220. /**
  221. * The interface for the Move component.
  222. *
  223. * @since 3.0.0
  224. */
  225. interface MoveComponent extends BaseComponent {
  226. move(dest: number, index: number, prev: number, forwards: boolean, callback?: AnyFunction): void;
  227. jump(index: number): void;
  228. translate(position: number, preventLoop?: boolean): void;
  229. shift(position: number, backwards: boolean): number;
  230. cancel(): void;
  231. toIndex(position: number): number;
  232. toPosition(index: number): number;
  233. getPosition(): number;
  234. getRate(index?: number): number;
  235. getLimit(max: boolean): number;
  236. exceededLimit(max?: boolean | undefined, position?: number): boolean;
  237. /** @internal */
  238. reposition(): void;
  239. canShift(backwards: boolean): boolean;
  240. }
  241. /**
  242. * The interface for the Controller component.
  243. *
  244. * @since 3.0.0
  245. */
  246. interface ControllerComponent extends BaseComponent {
  247. go(control: number | string, callback?: AnyFunction): void;
  248. jump(control: number | string): void;
  249. scroll(destination: number, duration?: number, snap?: boolean, callback?: AnyFunction): void;
  250. getNext(destination?: boolean): number;
  251. getPrev(destination?: boolean): number;
  252. getEnd(): number;
  253. setIndex(index: number): void;
  254. getIndex(prev?: boolean): number;
  255. toIndex(page: number): number;
  256. toPage(index: number): number;
  257. toDest(position: number): number;
  258. hasFocus(): boolean;
  259. isBusy(): boolean;
  260. /** @internal */
  261. getAdjacent(prev: boolean, destination?: boolean): number;
  262. }
  263. /**
  264. * The interface for the Arrows component.
  265. *
  266. * @since 3.0.0
  267. */
  268. interface ArrowsComponent extends BaseComponent {
  269. readonly arrows: {
  270. readonly prev?: HTMLButtonElement;
  271. readonly next?: HTMLButtonElement;
  272. };
  273. /** @internal */
  274. update(): void;
  275. }
  276. /**
  277. * The interface for the Autoplay component.
  278. *
  279. * @since 3.0.0
  280. */
  281. interface AutoplayComponent extends BaseComponent {
  282. play(): void;
  283. pause(): void;
  284. isPaused(): boolean;
  285. }
  286. /**
  287. * The interface for the Scroll component.
  288. *
  289. * @since 3.0.0
  290. */
  291. interface ScrollComponent extends BaseComponent {
  292. scroll(position: number, duration?: number, snap?: boolean, callback?: AnyFunction): void;
  293. cancel(): void;
  294. }
  295. /**
  296. * The interface for the Drag component.
  297. *
  298. * @since 3.0.0
  299. */
  300. interface DragComponent extends BaseComponent {
  301. disable(disabled: boolean): void;
  302. isDragging(): boolean;
  303. }
  304. /**
  305. * The interface for the Keyboard component.
  306. *
  307. * @since 3.0.0
  308. */
  309. interface KeyboardComponent extends BaseComponent {
  310. disable(disabled: boolean): void;
  311. }
  312. /**
  313. * The interface for the LazyLoad component.
  314. *
  315. * @since 3.0.0
  316. */
  317. interface LazyLoadComponent extends BaseComponent {
  318. /** @internal */
  319. check(): void;
  320. }
  321. /**
  322. * The interface for the Pagination component.
  323. *
  324. * @since 3.0.0
  325. */
  326. interface PaginationComponent extends BaseComponent {
  327. readonly items: PaginationItem[];
  328. getAt(index: number): PaginationItem;
  329. update(): void;
  330. }
  331. /**
  332. * The interface for data of the pagination.
  333. *
  334. * @since 3.0.0
  335. */
  336. interface PaginationData {
  337. readonly list: HTMLUListElement;
  338. readonly items: PaginationItem[];
  339. }
  340. /**
  341. * The interface for each pagination item.
  342. *
  343. * @since 3.0.0
  344. */
  345. interface PaginationItem {
  346. readonly li: HTMLLIElement;
  347. readonly button: HTMLButtonElement;
  348. readonly page: number;
  349. }
  350. /**
  351. * The interface for the Sync component.
  352. *
  353. * @since 3.0.0
  354. */
  355. interface SyncComponent extends BaseComponent {
  356. remount(): void;
  357. }
  358. /**
  359. * The interface for the Wheel component.
  360. *
  361. * @since 3.0.0
  362. */
  363. interface WheelComponent extends BaseComponent {
  364. }
  365. /**
  366. * The interface for the Live component.
  367. *
  368. * @since 4.0.0
  369. */
  370. interface LiveComponent extends BaseComponent {
  371. disable(disabled: boolean): void;
  372. }
  373. /**
  374. * The collection of i18n strings.
  375. *
  376. * @since 3.0.0
  377. */
  378. declare const I18N: {
  379. prev: string;
  380. next: string;
  381. first: string;
  382. last: string;
  383. slideX: string;
  384. pageX: string;
  385. play: string;
  386. pause: string;
  387. carousel: string;
  388. slide: string;
  389. select: string;
  390. slideLabel: string;
  391. };
  392. /**
  393. * The interface for options.
  394. *
  395. * @since 3.0.0
  396. */
  397. interface Options extends ResponsiveOptions {
  398. /**
  399. * The type of the slider.
  400. * - 'slide': A slider with the slide transition
  401. * - 'loop' : A carousel slider
  402. * - 'fade' : A slider with the fade transition. This does not support the perPage option.
  403. */
  404. type?: string;
  405. /**
  406. * The `role` attribute for the root element.
  407. * If the tag is `<section>`, this value will not be used. The default value is `'region'`.
  408. */
  409. role?: string;
  410. /**
  411. * Determines whether to disable any actions while the slider is transitioning.
  412. * Even if `false`, the slider forcibly waits for transition on the loop points.
  413. */
  414. waitForTransition?: boolean;
  415. /**
  416. * If `true`, the width of slides are determined by their width.
  417. * The `perPage` and `perMove` options should be `1`.
  418. */
  419. autoWidth?: boolean;
  420. /**
  421. * If `true`, the height of slides are determined by their height.
  422. * The `perPage` and `perMove` options should be `1`.
  423. */
  424. autoHeight?: boolean;
  425. /**
  426. * The start index.
  427. */
  428. start?: number;
  429. /**
  430. * Changes the arrow SVG path, like 'm7.61 0.807-2.12...'.
  431. */
  432. arrowPath?: string;
  433. /**
  434. * Determines whether to activate autoplay or not.
  435. * If `paused`, it will not begin when the slider becomes active.
  436. * You need to provided play/pause buttons or manually start it by `Autoplay#play()`.
  437. */
  438. autoplay?: boolean | 'pause';
  439. /**
  440. * The autoplay interval in milliseconds.
  441. */
  442. interval?: number;
  443. /**
  444. * Determines whether to pause autoplay on mouseover.
  445. */
  446. pauseOnHover?: boolean;
  447. /**
  448. * Determines whether to pause autoplay when the slider contains the active element (focused element).
  449. * This should be `true` for accessibility.
  450. */
  451. pauseOnFocus?: boolean;
  452. /**
  453. * Determines whether to reset the autoplay progress when it is requested to start again.
  454. */
  455. resetProgress?: boolean;
  456. /**
  457. * Enables lazy loading.
  458. * Provide the `src` by the `data-splide-lazy` or the `srcset` by the `data-splide-lazy-srcset`.
  459. * You may also provide `src` for the placeholder, but the value must be different with the data.
  460. *
  461. * - `false`: Disables lazy loading
  462. * - `'nearby'`: Starts loading only images around the active slide (page)
  463. * - `'sequential'`: Loads images sequentially
  464. */
  465. lazyLoad?: boolean | 'nearby' | 'sequential';
  466. /**
  467. * Determine how many pages (not slides) around the active slide should be loaded beforehand.
  468. * This only works when the `lazyLoad` option is `'nearby'`.
  469. */
  470. preloadPages?: number;
  471. /**
  472. * Enables keyboard shortcuts for the slider control.
  473. * - `true` or `'global'`: Listens to the `keydown` event of the document.
  474. * - 'focused': Listens to the `keydown` event of the slider root element with adding `tabindex="0"` to it.
  475. * - `false`: Disables keyboard shortcuts (default).
  476. */
  477. keyboard?: boolean | 'global' | 'focused';
  478. /**
  479. * Determines whether to release the touch event when the carousel reaches the first or last slide.
  480. * If `true`, the bounce effect will not play.
  481. * Note that this does not affect mouse drag events.
  482. */
  483. releaseTouch?: boolean;
  484. /**
  485. * The direction of the slider.
  486. * - 'ltr': Left to right
  487. * - 'rtl': Right to left
  488. * - 'ttb': Top to bottom
  489. */
  490. direction?: 'ltr' | 'rtl' | 'ttb';
  491. /**
  492. * Determines whether to add `tabindex="0"` to visible slides or not.
  493. */
  494. slideFocus?: boolean;
  495. /**
  496. * If `true`, the slider makes slides clickable to navigate another slider.
  497. * Use `Splide#sync()` to sync multiple sliders.
  498. */
  499. isNavigation?: boolean;
  500. /**
  501. * Determines whether to trim spaces before/after the slider if the `focus` option is available.
  502. * - `true`: Trims spaces. The slider may stay on the same location even when requested to move.
  503. * - `'move'`: Trims spaces and forces to move the slider when requested.
  504. */
  505. trimSpace?: boolean | 'move';
  506. /**
  507. * If `true` and the `focus` option is available:
  508. * - Disables the next arrow when a carousel reaches the last page even if the active slide is not the last slide.
  509. * - Omits redundant pagination dots which just change the active slide and do not move a carousel.
  510. */
  511. omitEnd?: boolean;
  512. /**
  513. * Updates the `is-active` status of slides just before moving the slider.
  514. */
  515. updateOnMove?: boolean;
  516. /**
  517. * If `min`, the media query for breakpoints will be `min-width`, or otherwise, `max-width`.
  518. */
  519. mediaQuery?: 'min' | 'max';
  520. /**
  521. * The selector to find focusable elements
  522. * where `tabindex="-1"` will be assigned when their ascendant slide is hidden.
  523. */
  524. focusableNodes?: string;
  525. /**
  526. * The selector for nodes that cannot be dragged.
  527. */
  528. noDrag?: string;
  529. /**
  530. * Enables the live region by `aria-live`.
  531. * If `true`, screen readers will read a content of each slide whenever slide changes.
  532. */
  533. live?: boolean;
  534. /**
  535. * Determines whether to use the Transition component or not.
  536. */
  537. useScroll?: boolean;
  538. /**
  539. * Options for specific breakpoints.
  540. *
  541. * @example
  542. * ```ts
  543. * {
  544. * 1000: {
  545. * perPage: 3,
  546. * gap : 20
  547. * },
  548. * 600: {
  549. * perPage: 1,
  550. * gap : 5,
  551. * },
  552. * }
  553. * ```
  554. */
  555. breakpoints?: Record<string | number, ResponsiveOptions>;
  556. /**
  557. * Options used when the `(prefers-reduced-motion: reduce)` is detected.
  558. */
  559. reducedMotion?: Options;
  560. /**
  561. * The collection of class names.
  562. */
  563. classes?: Record<string, string>;
  564. /**
  565. * The collection of i18n strings.
  566. */
  567. i18n?: Record<keyof typeof I18N | string, string>;
  568. }
  569. /**
  570. * The interface for options that can correspond with breakpoints.
  571. *
  572. * @since 3.0.0
  573. */
  574. interface ResponsiveOptions {
  575. /**
  576. * Accepts arbitrary properties for extensions, although it's not ideal typing.
  577. */
  578. [key: string]: any;
  579. /**
  580. * The label for the root element.
  581. * Use `labelledby` instead if there is a visible label.
  582. */
  583. label?: string;
  584. /**
  585. * The ID for the element that used as the label of the carousel.
  586. */
  587. labelledby?: string;
  588. /**
  589. * The transition speed in milliseconds.
  590. */
  591. speed?: number;
  592. /**
  593. * Determines whether to rewind the carousel or not.
  594. * This is ignored when the `type` option is `'loop'`.
  595. */
  596. rewind?: boolean;
  597. /**
  598. * The transition speed on rewind in milliseconds.
  599. */
  600. rewindSpeed?: number;
  601. /**
  602. * Allows to rewind a carousel by drag if the `rewind` option is enabled.
  603. */
  604. rewindByDrag?: boolean;
  605. /**
  606. * Defines the slider max width, accepting the CSS format such as 10em, 80vw.
  607. */
  608. width?: number | string;
  609. /**
  610. * Defines the slider height, accepting the CSS format.
  611. */
  612. height?: number | string;
  613. /**
  614. * Fixes width of slides, accepting the CSS format.
  615. * The slider will ignore the `perPage` option if you provide this value.
  616. */
  617. fixedWidth?: number | string;
  618. /**
  619. * Fixes height of slides, accepting the CSS format.
  620. * The slider will ignore the `heightRatio` option if you provide this value.
  621. */
  622. fixedHeight?: number | string;
  623. /**
  624. * Determines height of slides by the ratio to the slider width.
  625. * For example, when the slider width is `1000` and the ratio is `0.5`, the height will be `500`.
  626. */
  627. heightRatio?: number;
  628. /**
  629. * Determines the number of slides to display in a page.
  630. */
  631. perPage?: number;
  632. /**
  633. * Determines the number of slides to move at once.
  634. */
  635. perMove?: number;
  636. /**
  637. * Determine the number of clones on each side of the slider.
  638. * In most cases, you don't need to provide this value.
  639. */
  640. clones?: number;
  641. /**
  642. * Determines whether to clone status classes for clones or not.
  643. */
  644. cloneStatus?: boolean;
  645. /**
  646. * Determines which slide should be active if there are multiple slides in a page.
  647. * Numbers and `'center'` are acceptable.
  648. */
  649. focus?: number | 'center';
  650. /**
  651. * The gap between slides. The CSS format is acceptable, such as `1em`.
  652. */
  653. gap?: number | string;
  654. /**
  655. * Sets padding left/right or top/bottom of the slider.
  656. * The CSS format is acceptable, such as `1em`.
  657. *
  658. * @example
  659. * ```ts
  660. * // By number
  661. * padding: 10,
  662. *
  663. * // By the CSS format
  664. * padding: '1rem',
  665. *
  666. * // Specifies each value for a horizontal slider
  667. * padding: { left: 10, right: 20 },
  668. * padding: { left: '1rem', right: '2rem' },
  669. *
  670. * // Specified each value for a vertical slider
  671. * padding: { top: 10, bottom: 20 },
  672. * ```
  673. */
  674. padding?: number | string | {
  675. left?: number | string;
  676. right?: number | string;
  677. } | {
  678. top?: number | string;
  679. bottom?: number | string;
  680. };
  681. /**
  682. * Determines whether to create/find arrows or not.
  683. */
  684. arrows?: boolean;
  685. /**
  686. * Determines whether to create pagination (indicator dots) or not.
  687. */
  688. pagination?: boolean;
  689. /**
  690. * Determines whether to enable keyboard shortcuts for pagination when it contains focus.
  691. * The default value is `true`.
  692. */
  693. paginationKeyboard?: boolean;
  694. /**
  695. * Explicitly sets the pagination direction that does not only affect appearance but also shortcuts and ARIA attributes.
  696. * The default value is same with the carousel direction.
  697. */
  698. paginationDirection?: Options['direction'];
  699. /**
  700. * The timing function for the CSS transition. For example, `linear`, ease or `cubic-bezier()`.
  701. */
  702. easing?: string;
  703. /**
  704. * The easing function for the drag free mode.
  705. * The default function is the `easeOutQuart` interpolation.
  706. */
  707. easingFunc?: (t: number) => number;
  708. /**
  709. * Allows to drag the slider by a mouse or swipe.
  710. * If `free`, the slider does not snap to a slide after drag.
  711. */
  712. drag?: boolean | 'free';
  713. /**
  714. * Snaps the closest slide in the drag-free mode.
  715. */
  716. snap?: boolean;
  717. /**
  718. * The required distance to start moving the slider by the touch action.
  719. * If you want to define the threshold for the mouse, provide an object.
  720. */
  721. dragMinThreshold?: number | {
  722. mouse: number;
  723. touch: number;
  724. };
  725. /**
  726. * Determine the power of "flick". The larger number this is, the farther the slider runs.
  727. * Around 500 is recommended.
  728. */
  729. flickPower?: number;
  730. /**
  731. * Limits the number of pages to move by "flick".
  732. */
  733. flickMaxPages?: number;
  734. /**
  735. * If `drag` is `'free'`, determines whether to activate the closest slide after drag or not.
  736. * The default value is `true`.
  737. */
  738. updateOnDragged?: boolean;
  739. /**
  740. * Enables navigation by the mouse wheel.
  741. * You'll need to set `waitForTransition` to `ture` or provide the `wheelSleep` duration to avoid quick change.
  742. */
  743. wheel?: boolean;
  744. /**
  745. * Determines the wheel axis. The default value is 'y'.
  746. */
  747. wheelAxis?: 'x' | 'y' | 'xy';
  748. /**
  749. * The threshold to cut off the small delta produced by inertia scroll.
  750. */
  751. wheelMinThreshold?: number;
  752. /**
  753. * The sleep time in milliseconds until accepting next wheel.
  754. * The timer starts when the transition begins.
  755. */
  756. wheelSleep?: number;
  757. /**
  758. * Determines whether to release the wheel event when the carousel reaches the first or last slide.
  759. */
  760. releaseWheel?: boolean;
  761. /**
  762. * Destroys the slider.
  763. */
  764. destroy?: boolean | 'completely';
  765. }
  766. declare const EVENT_MOUNTED = "mounted";
  767. declare const EVENT_READY = "ready";
  768. declare const EVENT_MOVE = "move";
  769. declare const EVENT_MOVED = "moved";
  770. declare const EVENT_CLICK = "click";
  771. declare const EVENT_ACTIVE = "active";
  772. declare const EVENT_INACTIVE = "inactive";
  773. declare const EVENT_VISIBLE = "visible";
  774. declare const EVENT_HIDDEN = "hidden";
  775. declare const EVENT_REFRESH = "refresh";
  776. declare const EVENT_UPDATED = "updated";
  777. declare const EVENT_RESIZE = "resize";
  778. declare const EVENT_RESIZED = "resized";
  779. declare const EVENT_DRAG = "drag";
  780. declare const EVENT_DRAGGING = "dragging";
  781. declare const EVENT_DRAGGED = "dragged";
  782. declare const EVENT_SCROLL = "scroll";
  783. declare const EVENT_SCROLLING = "scrolling";
  784. declare const EVENT_SCROLLED = "scrolled";
  785. declare const EVENT_OVERFLOW = "overflow";
  786. declare const EVENT_DESTROY = "destroy";
  787. declare const EVENT_ARROWS_MOUNTED = "arrows:mounted";
  788. declare const EVENT_ARROWS_UPDATED = "arrows:updated";
  789. declare const EVENT_PAGINATION_MOUNTED = "pagination:mounted";
  790. declare const EVENT_PAGINATION_UPDATED = "pagination:updated";
  791. declare const EVENT_NAVIGATION_MOUNTED = "navigation:mounted";
  792. declare const EVENT_AUTOPLAY_PLAY = "autoplay:play";
  793. declare const EVENT_AUTOPLAY_PLAYING = "autoplay:playing";
  794. declare const EVENT_AUTOPLAY_PAUSE = "autoplay:pause";
  795. declare const EVENT_LAZYLOAD_LOADED = "lazyload:loaded";
  796. declare const EVENT_LAZYLOAD_ERROR = "lazyload:error";
  797. /** @internal */
  798. declare const EVENT_SLIDE_KEYDOWN = "_sk";
  799. declare const EVENT_SHIFTED = "_sh";
  800. declare const EVENT_END_INDEX_CHANGED = "_ei";
  801. /**
  802. * The interface for all internal E.
  803. *
  804. * @since 3.0.0
  805. */
  806. interface EventMap {
  807. [EVENT_MOUNTED]: () => void;
  808. [EVENT_READY]: () => void;
  809. [EVENT_CLICK]: (Slide: SlideComponent, e: MouseEvent) => void;
  810. [EVENT_MOVE]: (index: number, prev: number, dest: number) => void;
  811. [EVENT_MOVED]: (index: number, prev: number, dest: number) => void;
  812. [EVENT_ACTIVE]: (Slide: SlideComponent) => void;
  813. [EVENT_INACTIVE]: (Slide: SlideComponent) => void;
  814. [EVENT_VISIBLE]: (Slide: SlideComponent) => void;
  815. [EVENT_HIDDEN]: (Slide: SlideComponent) => void;
  816. [EVENT_REFRESH]: () => void;
  817. [EVENT_UPDATED]: (options: Options) => void;
  818. [EVENT_RESIZE]: () => void;
  819. [EVENT_RESIZED]: () => void;
  820. [EVENT_DRAG]: () => void;
  821. [EVENT_DRAGGING]: () => void;
  822. [EVENT_DRAGGED]: () => void;
  823. [EVENT_SCROLL]: () => void;
  824. [EVENT_SCROLLING]: () => void;
  825. [EVENT_SCROLLED]: () => void;
  826. [EVENT_OVERFLOW]: (overflow: boolean) => void;
  827. [EVENT_DESTROY]: () => void;
  828. [EVENT_ARROWS_MOUNTED]: (prev: HTMLButtonElement, next: HTMLButtonElement) => void;
  829. [EVENT_ARROWS_UPDATED]: (prev: HTMLButtonElement, next: HTMLButtonElement, prevIndex: number, nextIndex: number) => void;
  830. [EVENT_PAGINATION_MOUNTED]: (data: PaginationData, item: PaginationItem) => void;
  831. [EVENT_PAGINATION_UPDATED]: (data: PaginationData, prev: PaginationItem, curr: PaginationItem) => void;
  832. [EVENT_NAVIGATION_MOUNTED]: (splides: Splide[]) => void;
  833. [EVENT_AUTOPLAY_PLAY]: () => void;
  834. [EVENT_AUTOPLAY_PLAYING]: (rate: number) => void;
  835. [EVENT_AUTOPLAY_PAUSE]: () => void;
  836. [EVENT_LAZYLOAD_LOADED]: (img: HTMLImageElement, Slide: SlideComponent) => void;
  837. [EVENT_LAZYLOAD_ERROR]: (img: HTMLImageElement, Slide: SlideComponent) => void;
  838. /** @internal */
  839. [EVENT_SLIDE_KEYDOWN]: (Slide: SlideComponent, e: KeyboardEvent) => void;
  840. [EVENT_SHIFTED]: () => void;
  841. [EVENT_END_INDEX_CHANGED]: () => void;
  842. }
  843. /**
  844. * The EventInterface type with Splide `EventMap`.
  845. *
  846. * @since 5.0.0
  847. */
  848. declare type EventInterface = EventInterface$1<EventMap & Record<string, AnyFunction>>;
  849. /**
  850. * The type for any function.
  851. *
  852. * @since 3.0.0
  853. */
  854. declare type AnyFunction = (...args: any[]) => any;
  855. /**
  856. * The type for a component.
  857. *
  858. * @since 3.0.0
  859. */
  860. declare type ComponentConstructor<R extends BaseComponent = BaseComponent> = (Splide: Splide, Components: Components, options: Options, event: EventInterface) => R;
  861. /**
  862. * The interface for any component.
  863. *
  864. * @since 3.0.0
  865. */
  866. interface BaseComponent {
  867. setup?(): void;
  868. mount?(): void;
  869. destroy?(completely?: boolean): void;
  870. }
  871. /**
  872. * The interface for the Transition component.
  873. *
  874. * @since 3.0.0
  875. */
  876. interface TransitionComponent extends BaseComponent {
  877. start(index: number, done: () => void): void;
  878. cancel(): void;
  879. }
  880. /**
  881. * The interface for info of a splide instance to sync with.
  882. *
  883. * @since 3.2.8
  884. */
  885. interface SyncTarget {
  886. splide: Splide;
  887. isParent?: boolean;
  888. }
  889. /**
  890. * The interface for all components.
  891. *
  892. * @since 3.0.0
  893. */
  894. interface Components {
  895. [key: string]: BaseComponent | undefined;
  896. Breakpoints: BreakpointsComponent;
  897. Direction: DirectionComponent;
  898. Elements: ElementsComponent;
  899. Slides: SlidesComponent;
  900. Layout: LayoutComponent;
  901. Clones: ClonesComponent;
  902. Move: MoveComponent;
  903. Controller: ControllerComponent;
  904. Arrows: ArrowsComponent;
  905. Autoplay: AutoplayComponent;
  906. Scroll: ScrollComponent;
  907. Drag: DragComponent;
  908. Keyboard: KeyboardComponent;
  909. LazyLoad: LazyLoadComponent;
  910. Pagination: PaginationComponent;
  911. Sync: SyncComponent;
  912. Wheel: WheelComponent;
  913. Live: LiveComponent;
  914. Transition: TransitionComponent;
  915. }
  916. /**
  917. * Casts T to U.
  918. *
  919. * @internal
  920. */
  921. declare type Cast<T, U> = T extends U ? T : U;
  922. /**
  923. * Makes the T easy to read.
  924. */
  925. declare type Resolve<T> = {
  926. [K in keyof T]: T[K];
  927. } & unknown;
  928. /**
  929. * Pushes U to tuple T.
  930. *
  931. * @internal
  932. */
  933. declare type Push<T extends any[], U = any> = [...T, U];
  934. /**
  935. * Returns the first type of the tuple.
  936. *
  937. * @internal
  938. */
  939. declare type Head<T extends any[]> = ((...args: T) => any) extends (arg: infer A, ...args: any[]) => any ? A : never;
  940. /**
  941. * Removes the first type from the tuple T.
  942. *
  943. * @internal
  944. */
  945. declare type Shift<T extends any[]> = ((...args: T) => any) extends (arg: any, ...args: infer A) => any ? A : never;
  946. /**
  947. * Removes the N types from the tuple T.
  948. *
  949. * @internal
  950. */
  951. declare type ShiftN<T extends any[], N extends number, C extends any[] = []> = {
  952. 0: T;
  953. 1: ShiftN<Shift<T>, N, Push<C>>;
  954. }[C['length'] extends N ? 0 : 1] extends infer A ? Cast<A, any[]> : never;
  955. /**
  956. * The interface for the Slides component.
  957. *
  958. * @since 3.0.0
  959. */
  960. interface SlidesComponent extends BaseComponent {
  961. update(): void;
  962. register(slide: HTMLElement, index: number, slideIndex: number): void;
  963. get(excludeClones?: boolean): SlideComponent[];
  964. getIn(page: number): SlideComponent[];
  965. getAt(index: number): SlideComponent | undefined;
  966. add(slide: string | Element | Array<string | Element>, index?: number): void;
  967. remove(selector: SlideMatcher): void;
  968. forEach(iteratee: SlidesIteratee, excludeClones?: boolean): void;
  969. filter(matcher: SlideMatcher): SlideComponent[];
  970. style(prop: string, value: string | number, useContainer?: boolean): void;
  971. getLength(excludeClones?: boolean): number;
  972. isEnough(): boolean;
  973. }
  974. /**
  975. * The iteratee function for Slides.
  976. *
  977. * @since 3.0.0
  978. */
  979. declare type SlidesIteratee = (Slide: SlideComponent, index: number, Slides: SlideComponent[]) => void;
  980. /**
  981. * The predicate function for Slides.
  982. *
  983. * @since 3.0.0
  984. */
  985. declare type SlidesPredicate = (Slide: SlideComponent, index: number, Slides: SlideComponent[]) => any;
  986. /**
  987. * The type for filtering SlideComponent objects.
  988. *
  989. * @since 3.0.0
  990. */
  991. declare type SlideMatcher = number | number[] | string | SlidesPredicate;
  992. /**
  993. * The frontend class for the Splide slider.
  994. *
  995. * @since 3.0.0
  996. */
  997. declare class Splide {
  998. /**
  999. * Changes the default options for all Splide instances.
  1000. */
  1001. static defaults: Options;
  1002. /**
  1003. * The collection of state numbers.
  1004. */
  1005. static readonly STATES: {
  1006. CREATED: number;
  1007. MOUNTED: number;
  1008. IDLE: number;
  1009. MOVING: number;
  1010. SCROLLING: number;
  1011. DRAGGING: number;
  1012. DESTROYED: number;
  1013. };
  1014. /**
  1015. * The root element where the Splide is applied.
  1016. */
  1017. readonly root: HTMLElement;
  1018. /**
  1019. * The EventInterface object.
  1020. */
  1021. readonly event: EventInterface$1<EventMap & Record<string, AnyFunction>>;
  1022. /**
  1023. * The collection of all component objects.
  1024. */
  1025. readonly Components: Components;
  1026. /**
  1027. * The StateObject object.
  1028. */
  1029. readonly state: State;
  1030. /**
  1031. * An array with SyncTarget objects for splide instances to sync with.
  1032. */
  1033. readonly splides: SyncTarget[];
  1034. /**
  1035. * The current options.
  1036. */
  1037. private readonly _o;
  1038. /**
  1039. * The collection of all components.
  1040. */
  1041. private _C;
  1042. /**
  1043. * The collection of extensions.
  1044. */
  1045. private _E;
  1046. /**
  1047. * The Transition component.
  1048. */
  1049. private _T;
  1050. /**
  1051. * The Splide constructor.
  1052. *
  1053. * @param target - The selector for the target element, or the element itself.
  1054. * @param options - Optional. An object with options.
  1055. */
  1056. constructor(target: string | HTMLElement, options?: Options);
  1057. /**
  1058. * Initializes the instance.
  1059. *
  1060. * @param Extensions - Optional. An object with extensions.
  1061. * @param Transition - Optional. A Transition component.
  1062. *
  1063. * @return `this`
  1064. */
  1065. mount(Extensions?: Record<string, ComponentConstructor>, Transition?: ComponentConstructor): this;
  1066. /**
  1067. * Syncs the slider with the provided one.
  1068. * This method must be called before the `mount()`.
  1069. *
  1070. * @example
  1071. * ```ts
  1072. * const primary = new Splide();
  1073. * const secondary = new Splide();
  1074. *
  1075. * primary.sync( secondary );
  1076. * primary.mount();
  1077. * secondary.mount();
  1078. * ```
  1079. *
  1080. * @param splide - A Splide instance to sync with.
  1081. *
  1082. * @return `this`
  1083. */
  1084. sync(splide: Splide): this;
  1085. /**
  1086. * Moves the carousel with the following control pattern.
  1087. *
  1088. * | Pattern | Description |
  1089. * |---|---|
  1090. * | `i` | Goes to the slide `i` |
  1091. * | `'+${i}'` | Increments the slide index by `i` |
  1092. * | `'-${i}'` | Decrements the slide index by `i` |
  1093. * | `'>'` | Goes to the next page |
  1094. * | `'<'` | Goes to the previous page |
  1095. * | `>${i}` | Goes to the page `i` |
  1096. * | `>>` | Goes to the first page |
  1097. * | `<<` | Goes to the last page |
  1098. *
  1099. * In most cases, `'>'` and `'<'` notations are enough to control the slider
  1100. * because they respect `perPage` and `perMove` options.
  1101. *
  1102. * @example
  1103. * ```ts
  1104. * const splide = new Splide();
  1105. *
  1106. * // Goes to the slide 1:
  1107. * splide.go( 1 );
  1108. *
  1109. * // Increments the index:
  1110. * splide.go( '+2' );
  1111. *
  1112. * // Goes to the next page:
  1113. * splide.go( '>' );
  1114. *
  1115. * // Goes to the page 2:
  1116. * splide.go( '>2' );
  1117. * ```
  1118. *
  1119. * @param control - A control pattern.
  1120. *
  1121. * @return `this`
  1122. */
  1123. go(control: number | string): this;
  1124. /**
  1125. * Moves the carousel without transition.
  1126. *
  1127. * @param control - A control pattern. See `move()` for more details.
  1128. *
  1129. * @return `this`
  1130. */
  1131. jump(control: number | string): this;
  1132. /**
  1133. * Registers an event handler.
  1134. *
  1135. * @example
  1136. * ```ts
  1137. * const splide = new Splide();
  1138. *
  1139. * // Listens to a single event:
  1140. * splide.on( 'move', function() {} );
  1141. *
  1142. * // Listens to multiple events:
  1143. * splide.on( 'move resize', function() {} );
  1144. *
  1145. * // Appends a namespace:
  1146. * splide.on( 'move.myNamespace resize.myNamespace', function() {} );
  1147. * ```
  1148. *
  1149. * @param events - An event name or names separated by spaces. Use a dot(.) to append a namespace.
  1150. * @param callback - A callback function.
  1151. *
  1152. * @return `this`
  1153. */
  1154. on<K extends keyof EventMap>(events: K, callback: EventMap[K]): this;
  1155. on(events: string | string[], callback: AnyFunction): this;
  1156. /**
  1157. * Removes the registered all handlers for the specified event or events.
  1158. * If you want to only remove a particular handler, use namespace to identify it.
  1159. *
  1160. * @example
  1161. * ```ts
  1162. * const splide = new Splide();
  1163. *
  1164. * // Removes all handlers assigned to "move":
  1165. * splide.off( 'move' );
  1166. *
  1167. * // Only removes handlers that belong to the specified namespace:
  1168. * splide.off( 'move.myNamespace' );
  1169. * ```
  1170. *
  1171. * @param events - An event name or names separated by spaces. Use a dot(.) to append a namespace.
  1172. * @param callback - A callback function to remove.
  1173. *
  1174. * @return `this`
  1175. */
  1176. off<K extends keyof EventMap>(events: K | K[] | string | string[], callback: AnyFunction): this;
  1177. /**
  1178. * Emits an event and triggers registered handlers.
  1179. *
  1180. * @param event - An event name to emit.
  1181. * @param args - Optional. Any number of arguments to pass to handlers.
  1182. *
  1183. * @return `this`
  1184. */
  1185. emit<K extends keyof EventMap>(event: K, ...args: Parameters<EventMap[K]>): this;
  1186. emit(event: string, ...args: any[]): this;
  1187. /**
  1188. * Inserts a slide at the specified position.
  1189. *
  1190. * @example
  1191. * ```ts
  1192. * const splide = new Splide();
  1193. * splide.mount();
  1194. *
  1195. * // Adds the slide by the HTML:
  1196. * splide.add( '<li></li> );
  1197. *
  1198. * // or adds the element:
  1199. * splide.add( document.createElement( 'li' ) );
  1200. * ```
  1201. *
  1202. * @param slides - A slide element, an HTML string that represents a slide, or an array with them.
  1203. * @param index - Optional. An index to insert a slide at.
  1204. *
  1205. * @return `this`
  1206. */
  1207. add(slides: string | HTMLElement | Array<string | HTMLElement>, index?: number): this;
  1208. /**
  1209. * Removes slides that match the matcher
  1210. * that can be an index, an array with indices, a selector, or an iteratee function.
  1211. *
  1212. * @param matcher - An index, an array with indices, a selector string, or an iteratee function.
  1213. */
  1214. remove(matcher: SlideMatcher): this;
  1215. /**
  1216. * Checks the slider type.
  1217. *
  1218. * @param type - A type to test.
  1219. *
  1220. * @return `true` if the type matches the current one, or otherwise `false`.
  1221. */
  1222. is(type: string): boolean;
  1223. /**
  1224. * Refreshes the slider.
  1225. *
  1226. * @return `this`
  1227. */
  1228. refresh(): this;
  1229. /**
  1230. * Destroys the slider.
  1231. *
  1232. * @param completely - Optional. If `true`, Splide will not remount the slider by breakpoints.
  1233. *
  1234. * @return `this`
  1235. */
  1236. destroy(completely?: boolean): this;
  1237. /**
  1238. * Returns options.
  1239. *
  1240. * @return An object with the latest options.
  1241. */
  1242. get options(): Options;
  1243. /**
  1244. * Merges options to the current options and emits `updated` event.
  1245. *
  1246. * @param options - An object with new options.
  1247. */
  1248. set options(options: Options);
  1249. /**
  1250. * Returns the number of slides without clones.
  1251. *
  1252. * @return The number of slides.
  1253. */
  1254. get length(): number;
  1255. /**
  1256. * Returns the active slide index.
  1257. *
  1258. * @return The active slide index.
  1259. */
  1260. get index(): number;
  1261. }
  1262. /**
  1263. * The interface for the content of each slide.
  1264. *
  1265. * @since 3.0.0
  1266. */
  1267. interface SlideContent {
  1268. /**
  1269. * The HTML or text for each slide.
  1270. */
  1271. html?: string;
  1272. /**
  1273. * The collection of styles. They will remain after Splide is applied.
  1274. */
  1275. styles?: Record<string, string | number>;
  1276. /**
  1277. * The collection of attributes. They will remain after Splide is applied.
  1278. */
  1279. attrs?: Record<string, string | number | boolean>;
  1280. }
  1281. /**
  1282. * The interface for the config of the renderer.
  1283. *
  1284. * @since 3.0.0
  1285. */
  1286. interface RendererConfig {
  1287. /**
  1288. * The slider ID.
  1289. */
  1290. id?: string;
  1291. /**
  1292. * The additional class for the root element.
  1293. */
  1294. rootClass?: string;
  1295. /**
  1296. * The tag used for the list element.
  1297. */
  1298. listTag?: string;
  1299. /**
  1300. * The tag used for each slide.
  1301. */
  1302. slideTag?: string;
  1303. /**
  1304. * Determines whether to render arrows or not.
  1305. */
  1306. arrows?: boolean;
  1307. /**
  1308. * Keeps the slider hidden.
  1309. */
  1310. hidden?: boolean;
  1311. /**
  1312. * Determines whether to wrap the track by the slider element or not.
  1313. */
  1314. slider?: boolean;
  1315. /**
  1316. * The additional HTML rendered before the slider element.
  1317. */
  1318. beforeSlider?: string;
  1319. /**
  1320. * The additional HTML rendered after the slider element.
  1321. */
  1322. afterSlider?: string;
  1323. /**
  1324. * The additional HTML rendered before the track element.
  1325. */
  1326. beforeTrack?: string;
  1327. /**
  1328. * The additional HTML rendered after the track element.
  1329. */
  1330. afterTrack?: string;
  1331. }
  1332. /**
  1333. * The class to generate static HTML of the slider for the first view.
  1334. *
  1335. * @since 3.0.0
  1336. */
  1337. declare class SplideRenderer {
  1338. /**
  1339. * Removes a style element and clones.
  1340. *
  1341. * @param splide - A Splide instance.
  1342. */
  1343. static clean(splide: Splide): void;
  1344. /**
  1345. * Holds slide contents.
  1346. */
  1347. private readonly contents;
  1348. /**
  1349. * Stores data of slides.
  1350. */
  1351. private readonly slides;
  1352. /**
  1353. * The Direction component.
  1354. */
  1355. private readonly Direction;
  1356. /**
  1357. * Holds the Style instance.
  1358. */
  1359. private readonly Style;
  1360. /**
  1361. * Holds options.
  1362. */
  1363. private readonly options;
  1364. /**
  1365. * Holds options for this instance.
  1366. */
  1367. private readonly config;
  1368. /**
  1369. * The slider ID.
  1370. */
  1371. private readonly id;
  1372. /**
  1373. * An array with options for each breakpoint.
  1374. */
  1375. private readonly breakpoints;
  1376. /**
  1377. * The SplideRenderer constructor.
  1378. *
  1379. * @param contents - An array with slide contents. Each item must be an HTML or a plain text.
  1380. * @param options - Optional. Slider options.
  1381. * @param config - Static default options.
  1382. * @param defaults - Default options for the slider. Pass `Splide.defaults` if you are using it.
  1383. */
  1384. constructor(contents: string[] | SlideContent[], options?: Options, config?: RendererConfig, defaults?: Options);
  1385. /**
  1386. * Initializes the instance.
  1387. */
  1388. private init;
  1389. /**
  1390. * Initializes slides.
  1391. */
  1392. private initSlides;
  1393. /**
  1394. * Registers styles for the root element.
  1395. */
  1396. private registerRootStyles;
  1397. /**
  1398. * Registers styles for the track element.
  1399. */
  1400. private registerTrackStyles;
  1401. /**
  1402. * Registers styles for the list element.
  1403. */
  1404. private registerListStyles;
  1405. /**
  1406. * Registers styles for slides and clones.
  1407. */
  1408. private registerSlideStyles;
  1409. /**
  1410. * Builds multiple `translateX` for the list element.
  1411. *
  1412. * @param options - Options for each breakpoint.
  1413. *
  1414. * @return A string with multiple translate functions.
  1415. */
  1416. private buildTranslate;
  1417. /**
  1418. * Returns offset for the list element.
  1419. * This does not include gaps because it can not be converted into percent.
  1420. *
  1421. * @param options - Options for each breakpoint.
  1422. *
  1423. * @return The offset.
  1424. */
  1425. private cssOffsetClones;
  1426. /**
  1427. * Returns offset for centering the active slide.
  1428. *
  1429. * Note:
  1430. * ( 100% + gap ) / perPage - gap
  1431. * 100% / perPage + gap / perPage - gap;
  1432. * 50% / perPage + ( gap / perPage - gap ) / 2;
  1433. *
  1434. * @param options - Options for each breakpoint.
  1435. *
  1436. * @return The offset.
  1437. */
  1438. private cssOffsetCenter;
  1439. /**
  1440. * Returns offset for gaps.
  1441. *
  1442. * @param options - Options for each breakpoint.
  1443. *
  1444. * @return The offset as `calc()`.
  1445. */
  1446. private cssOffsetGaps;
  1447. /**
  1448. * Resolves the prop for the current direction and converts it into the Kebab case.
  1449. *
  1450. * @param prop - A property name to resolve.
  1451. *
  1452. * @return A resolved property name in the Kebab case.
  1453. */
  1454. private resolve;
  1455. /**
  1456. * Returns padding in the CSS format.
  1457. *
  1458. * @param options - Options.
  1459. * @param right - Determines whether to get padding right or left.
  1460. *
  1461. * @return Padding in the CSS format.
  1462. */
  1463. private cssPadding;
  1464. /**
  1465. * Returns height of the track element in the CSS format.
  1466. *
  1467. * @param options - Options.
  1468. *
  1469. * @return Height in the CSS format.
  1470. */
  1471. private cssTrackHeight;
  1472. /**
  1473. * Returns height provided though options in the CSS format.
  1474. *
  1475. * @param options - Options.
  1476. *
  1477. * @return Height in the CSS format.
  1478. */
  1479. private cssHeight;
  1480. /**
  1481. * Returns width of each slide in the CSS format.
  1482. *
  1483. * @param options - Options.
  1484. *
  1485. * @return Width in the CSS format.
  1486. */
  1487. private cssSlideWidth;
  1488. /**
  1489. * Returns height of each slide in the CSS format.
  1490. *
  1491. * @param options - Options.
  1492. *
  1493. * @return Height in the CSS format.
  1494. */
  1495. private cssSlideHeight;
  1496. /**
  1497. * Returns width or height of each slide in the CSS format, considering the current direction.
  1498. *
  1499. * @param options - Options.
  1500. *
  1501. * @return Width or height in the CSS format.
  1502. */
  1503. private cssSlideSize;
  1504. /**
  1505. * Returns the aspectRatio value to simulate the `heightRatio` option.
  1506. *
  1507. * @param options - Options.
  1508. *
  1509. * @return aspectRatio in the CSS format.
  1510. */
  1511. private cssAspectRatio;
  1512. /**
  1513. * Builds the css value by the provided value and unit.
  1514. *
  1515. * @param value - A value.
  1516. * @param unit - A CSS unit.
  1517. *
  1518. * @return A built value for a CSS value.
  1519. */
  1520. private buildCssValue;
  1521. /**
  1522. * Parses the CSS value into number and unit.
  1523. *
  1524. * @param value - A value to parse.
  1525. *
  1526. * @return An object with value and unit.
  1527. */
  1528. private parseCssValue;
  1529. /**
  1530. * Parses breakpoints and generate options for each breakpoint.
  1531. */
  1532. private parseBreakpoints;
  1533. /**
  1534. * Checks if the slide width is fixed or not.
  1535. *
  1536. * @return `true` if the slide width is fixed, or otherwise `false`.
  1537. */
  1538. private isFixedWidth;
  1539. /**
  1540. * Checks if the slider type is loop or not.
  1541. *
  1542. * @return `true` if the slider type is loop, or otherwise `false`.
  1543. */
  1544. private isLoop;
  1545. /**
  1546. * Checks if the active slide should be centered or not.
  1547. *
  1548. * @return `true` if the slide should be centered, or otherwise `false`.
  1549. */
  1550. private isCenter;
  1551. /**
  1552. * Checks if the direction is TTB or not.
  1553. *
  1554. * @return `true` if the direction is TTB, or otherwise `false`.
  1555. */
  1556. private isVertical;
  1557. /**
  1558. * Builds classes of the root element.
  1559. *
  1560. * @return Classes for the root element as a single string.
  1561. */
  1562. private buildClasses;
  1563. /**
  1564. * Converts provided attributes into a single string.
  1565. *
  1566. * @param attrs - An object with attributes.
  1567. *
  1568. * @return A built string.
  1569. */
  1570. private buildAttrs;
  1571. /**
  1572. * Converts provided styles into a single string.
  1573. *
  1574. * @param styles - An object with styles.
  1575. *
  1576. * @return A built string.
  1577. */
  1578. private buildStyles;
  1579. /**
  1580. * Generates HTML of slides with inserting provided contents.
  1581. *
  1582. * @return The HTML for all slides and clones.
  1583. */
  1584. private renderSlides;
  1585. /**
  1586. * Add the `background` style for the cover mode.
  1587. *
  1588. * @param content - A slide content.
  1589. */
  1590. private cover;
  1591. /**
  1592. * Generates clones.
  1593. *
  1594. * @param contents - An array with SlideContent objects.
  1595. */
  1596. private generateClones;
  1597. /**
  1598. * Returns the number of clones to generate.
  1599. *
  1600. * @return A number of clones.
  1601. */
  1602. private getCloneCount;
  1603. /**
  1604. * Generates arrows and the wrapper element.
  1605. *
  1606. * @return The HTML for arrows.
  1607. */
  1608. private renderArrows;
  1609. /**
  1610. * Generates an arrow HTML.
  1611. * Some attributes are temporary, and Splide changes them after mount.
  1612. *
  1613. * @param prev - Options for each breakpoint.
  1614. *
  1615. * @return The HTML for the prev or next arrow.
  1616. */
  1617. private renderArrow;
  1618. /**
  1619. * Returns the HTML of the slider.
  1620. *
  1621. * @return The generated HTML.
  1622. */
  1623. html(): string;
  1624. }
  1625. /**
  1626. * The prefix for classes.
  1627. *
  1628. * @since 4.1.0
  1629. */
  1630. declare const CLASS_PREFIX: string;
  1631. /**
  1632. * The prefix for status classes.
  1633. *
  1634. * @since 4.1.0
  1635. */
  1636. declare const STATUS_CLASS_PREFIX = "is-";
  1637. /**
  1638. * All classes as constants.
  1639. */
  1640. declare const CLASS_ROOT = "splide";
  1641. declare const CLASS_TRACK: string;
  1642. declare const CLASS_LIST: string;
  1643. declare const CLASS_SLIDE: string;
  1644. declare const CLASS_CLONE: string;
  1645. declare const CLASS_CONTAINER: string;
  1646. declare const CLASS_ARROWS: string;
  1647. declare const CLASS_ARROW: string;
  1648. declare const CLASS_ARROW_PREV: string;
  1649. declare const CLASS_ARROW_NEXT: string;
  1650. declare const CLASS_PAGINATION: string;
  1651. declare const CLASS_PAGINATION_PAGE: string;
  1652. declare const CLASS_PROGRESS: string;
  1653. declare const CLASS_PROGRESS_BAR: string;
  1654. declare const CLASS_TOGGLE: string;
  1655. declare const CLASS_TOGGLE_PLAY: string;
  1656. declare const CLASS_TOGGLE_PAUSE: string;
  1657. declare const CLASS_SPINNER: string;
  1658. declare const CLASS_SR: string;
  1659. declare const CLASS_INITIALIZED: string;
  1660. declare const CLASS_ACTIVE: string;
  1661. declare const CLASS_PREV: string;
  1662. declare const CLASS_NEXT: string;
  1663. declare const CLASS_VISIBLE: string;
  1664. declare const CLASS_LOADING: string;
  1665. declare const CLASS_FOCUS_IN: string;
  1666. declare const CLASS_OVERFLOW: string;
  1667. /**
  1668. * The array with all status classes except for `is-initialized`.
  1669. *
  1670. * @since 3.0.0
  1671. */
  1672. declare const STATUS_CLASSES: string[];
  1673. /**
  1674. * The collection of classes for elements that Splide dynamically creates.
  1675. *
  1676. * @since 3.0.0
  1677. */
  1678. declare const CLASSES: {
  1679. slide: string;
  1680. clone: string;
  1681. arrows: string;
  1682. arrow: string;
  1683. prev: string;
  1684. next: string;
  1685. pagination: string;
  1686. page: string;
  1687. spinner: string;
  1688. };
  1689. /**
  1690. * The collection of default options.
  1691. * Note that this collection does not contain all options.
  1692. *
  1693. * @since 3.0.0
  1694. */
  1695. declare const DEFAULTS: Options;
  1696. /**
  1697. * Enumerates slides from left to right.
  1698. */
  1699. declare const LTR = "ltr";
  1700. /**
  1701. * Enumerates slides from right to left.
  1702. */
  1703. declare const RTL = "rtl";
  1704. /**
  1705. * Enumerates slides in a col.
  1706. */
  1707. declare const TTB = "ttb";
  1708. /**
  1709. * The type for the regular slider.
  1710. *
  1711. * @since 3.0.0
  1712. */
  1713. declare const SLIDE = "slide";
  1714. /**
  1715. * The type for the carousel slider.
  1716. *
  1717. * @since 3.0.0
  1718. */
  1719. declare const LOOP = "loop";
  1720. /**
  1721. * The type for the fade slider that can not have multiple slides in a page.
  1722. *
  1723. * @since 3.0.0
  1724. */
  1725. declare const FADE = "fade";
  1726. export { AnyFunction, ArrowsComponent, AutoplayComponent, BaseComponent, BreakpointsComponent, CLASSES, CLASS_ACTIVE, CLASS_ARROW, CLASS_ARROWS, CLASS_ARROW_NEXT, CLASS_ARROW_PREV, CLASS_CLONE, CLASS_CONTAINER, CLASS_FOCUS_IN, CLASS_INITIALIZED, CLASS_LIST, CLASS_LOADING, CLASS_NEXT, CLASS_OVERFLOW, CLASS_PAGINATION, CLASS_PAGINATION_PAGE, CLASS_PREFIX, CLASS_PREV, CLASS_PROGRESS, CLASS_PROGRESS_BAR, CLASS_ROOT, CLASS_SLIDE, CLASS_SPINNER, CLASS_SR, CLASS_TOGGLE, CLASS_TOGGLE_PAUSE, CLASS_TOGGLE_PLAY, CLASS_TRACK, CLASS_VISIBLE, Cast, ClonesComponent, ComponentConstructor, Components, ControllerComponent, DEFAULTS, DirectionComponent, DragComponent, EVENT_ACTIVE, EVENT_ARROWS_MOUNTED, EVENT_ARROWS_UPDATED, EVENT_AUTOPLAY_PAUSE, EVENT_AUTOPLAY_PLAY, EVENT_AUTOPLAY_PLAYING, EVENT_CLICK, EVENT_DESTROY, EVENT_DRAG, EVENT_DRAGGED, EVENT_DRAGGING, EVENT_END_INDEX_CHANGED, EVENT_HIDDEN, EVENT_INACTIVE, EVENT_LAZYLOAD_ERROR, EVENT_LAZYLOAD_LOADED, EVENT_MOUNTED, EVENT_MOVE, EVENT_MOVED, EVENT_NAVIGATION_MOUNTED, EVENT_OVERFLOW, EVENT_PAGINATION_MOUNTED, EVENT_PAGINATION_UPDATED, EVENT_READY, EVENT_REFRESH, EVENT_RESIZE, EVENT_RESIZED, EVENT_SCROLL, EVENT_SCROLLED, EVENT_SCROLLING, EVENT_SHIFTED, EVENT_SLIDE_KEYDOWN, EVENT_UPDATED, EVENT_VISIBLE, ElementsComponent, EventInterface, EventMap, FADE, Head, KeyboardComponent, LOOP, LTR, LayoutComponent, LazyLoadComponent, LiveComponent, MoveComponent, Options, PaginationComponent, PaginationData, PaginationItem, Push, RTL, Resolve, ResponsiveOptions, SLIDE, STATUS_CLASSES, STATUS_CLASS_PREFIX, ScrollComponent, Shift, ShiftN, SlideComponent, SlidesComponent, Splide, SplideRenderer, SyncComponent, SyncTarget, TTB, TransitionComponent, WheelComponent, Splide as default };