swiper-svelte.d.ts 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431
  1. import { SvelteComponentTyped } from 'svelte';
  2. import { SwiperOptions, Swiper as SwiperClass } from '../types/';
  3. // @ts-ignore
  4. interface SwiperProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap['div']> {}
  5. interface SwiperProps extends SwiperOptions {}
  6. // @ts-ignore
  7. interface SwiperSlideProps extends svelte.JSX.HTMLAttributes<HTMLElementTagNameMap['div']> {
  8. /**
  9. * Enables additional wrapper required for zoom mode
  10. *
  11. * @default false
  12. */
  13. zoom?: boolean;
  14. /**
  15. * Slide's index in slides array/collection
  16. *
  17. * @default false
  18. */
  19. virtualIndex?: number;
  20. }
  21. declare class Swiper extends SvelteComponentTyped<
  22. SwiperProps,
  23. {
  24. swiper: CustomEvent<void>;
  25. /**
  26. * Event will be fired in when autoplay started
  27. */
  28. autoplayStart: CustomEvent<[swiper: SwiperClass]>;
  29. /**
  30. * Event will be fired when autoplay stopped
  31. */
  32. autoplayStop: CustomEvent<[swiper: SwiperClass]>;
  33. /**
  34. * Event will be fired when slide changed with autoplay
  35. */
  36. autoplay: CustomEvent<[swiper: SwiperClass]>;/**
  37. * Event will be fired on window hash change
  38. */
  39. hashChange: CustomEvent<[swiper: SwiperClass]>;
  40. /**
  41. * Event will be fired when swiper updates the hash
  42. */
  43. hashSet: CustomEvent<[swiper: SwiperClass]>;/**
  44. * Event will be fired on mousewheel scroll
  45. */
  46. scroll: CustomEvent<[swiper: SwiperClass, event: WheelEvent]>;/**
  47. * Event will be fired in the beginning of lazy loading of image
  48. */
  49. lazyImageLoad: CustomEvent<[swiper: SwiperClass, slideEl: HTMLElement, imageEl: HTMLElement]>;
  50. /**
  51. * Event will be fired when lazy loading image will be loaded
  52. */
  53. lazyImageReady: CustomEvent<[swiper: SwiperClass, slideEl: HTMLElement, imageEl: HTMLElement]>;/**
  54. * Event will be fired on key press
  55. */
  56. keyPress: CustomEvent<[swiper: SwiperClass, keyCode: string]>;/**
  57. * Event will be fired on navigation hide
  58. */
  59. navigationHide: CustomEvent<[swiper: SwiperClass]>;
  60. /**
  61. * Event will be fired on navigation show
  62. */
  63. navigationShow: CustomEvent<[swiper: SwiperClass]>;/**
  64. * Event will be fired on draggable scrollbar drag start
  65. */
  66. scrollbarDragStart: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  67. /**
  68. * Event will be fired on draggable scrollbar drag move
  69. */
  70. scrollbarDragMove: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  71. /**
  72. * Event will be fired on draggable scrollbar drag end
  73. */
  74. scrollbarDragEnd: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;/**
  75. * Event will be fired after pagination rendered
  76. */
  77. paginationRender: CustomEvent<[swiper: SwiperClass, paginationEl: HTMLElement]>;
  78. /**
  79. * Event will be fired when pagination updated
  80. */
  81. paginationUpdate: CustomEvent<[swiper: SwiperClass, paginationEl: HTMLElement]>;
  82. /**
  83. * Event will be fired on pagination hide
  84. */
  85. paginationHide: CustomEvent<[swiper: SwiperClass]>;
  86. /**
  87. * Event will be fired on pagination show
  88. */
  89. paginationShow: CustomEvent<[swiper: SwiperClass]>;/**
  90. * Event will be fired on zoom change
  91. */
  92. zoomChange: CustomEvent<[swiper: SwiperClass, scale: number, imageEl: HTMLElement, slideEl: HTMLElement]>;
  93. /**
  94. * Fired right after Swiper initialization.
  95. * @note Note that with `swiper.on('init')` syntax it will
  96. * work only in case you set `init: false` parameter.
  97. *
  98. * @example
  99. * ```js
  100. * const swiper = new Swiper('.swiper', {
  101. * init: false,
  102. * // other parameters
  103. * });
  104. * swiper.on('init', function() {
  105. * // do something
  106. * });
  107. * // init Swiper
  108. * swiper.init();
  109. * ```
  110. *
  111. * @example
  112. * ```js
  113. * // Otherwise use it as the parameter:
  114. * const swiper = new Swiper('.swiper', {
  115. * // other parameters
  116. * on: {
  117. * init: function () {
  118. * // do something
  119. * },
  120. * }
  121. * });
  122. * ```
  123. */
  124. init: CustomEvent<[swiper: SwiperClass]>;
  125. /**
  126. * Event will be fired right before Swiper destroyed
  127. */
  128. beforeDestroy: CustomEvent<[swiper: SwiperClass]>;
  129. /**
  130. * Event will be fired when currently active slide is changed
  131. */
  132. slideChange: CustomEvent<[swiper: SwiperClass]>;
  133. /**
  134. * Event will be fired in the beginning of animation to other slide (next or previous).
  135. */
  136. slideChangeTransitionStart: CustomEvent<[swiper: SwiperClass]>;
  137. /**
  138. * Event will be fired after animation to other slide (next or previous).
  139. */
  140. slideChangeTransitionEnd: CustomEvent<[swiper: SwiperClass]>;
  141. /**
  142. * Same as "slideChangeTransitionStart" but for "forward" direction only
  143. */
  144. slideNextTransitionStart: CustomEvent<[swiper: SwiperClass]>;
  145. /**
  146. * Same as "slideChangeTransitionEnd" but for "forward" direction only
  147. */
  148. slideNextTransitionEnd: CustomEvent<[swiper: SwiperClass]>;
  149. /**
  150. * Same as "slideChangeTransitionStart" but for "backward" direction only
  151. */
  152. slidePrevTransitionStart: CustomEvent<[swiper: SwiperClass]>;
  153. /**
  154. * Same as "slideChangeTransitionEnd" but for "backward" direction only
  155. */
  156. slidePrevTransitionEnd: CustomEvent<[swiper: SwiperClass]>;
  157. /**
  158. * Event will be fired in the beginning of transition.
  159. */
  160. transitionStart: CustomEvent<[swiper: SwiperClass]>;
  161. /**
  162. * Event will be fired after transition.
  163. */
  164. transitionEnd: CustomEvent<[swiper: SwiperClass]>;
  165. /**
  166. * Event will be fired when user touch Swiper. Receives `touchstart` event as an arguments.
  167. */
  168. touchStart: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  169. /**
  170. * Event will be fired when user touch and move finger over Swiper. Receives `touchmove` event as an arguments.
  171. */
  172. touchMove: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  173. /**
  174. * Event will be fired when user touch and move finger over Swiper in direction opposite to direction parameter. Receives `touchmove` event as an arguments.
  175. */
  176. touchMoveOpposite: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  177. /**
  178. * Event will be fired when user touch and move finger over Swiper and move it. Receives `touchmove` event as an arguments.
  179. */
  180. sliderMove: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  181. /**
  182. * Event will be fired when user release Swiper. Receives `touchend` event as an arguments.
  183. */
  184. touchEnd: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  185. /**
  186. * Event will be fired when user click/tap on Swiper. Receives `touchend` event as an arguments.
  187. */
  188. click: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  189. /**
  190. * Event will be fired when user click/tap on Swiper. Receives `touchend` event as an arguments.
  191. */
  192. tap: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  193. /**
  194. * Event will be fired when user double tap on Swiper's container. Receives `touchend` event as an arguments
  195. */
  196. doubleTap: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  197. /**
  198. * Event will be fired right after all inner images are loaded. updateOnImagesReady should be also enabled
  199. */
  200. imagesReady: CustomEvent<[swiper: SwiperClass]>;
  201. /**
  202. * Event will be fired when Swiper progress is changed, as an arguments it receives progress that is always from 0 to 1
  203. */
  204. progress: CustomEvent<[swiper: SwiperClass, progress: number]>;
  205. /**
  206. * Event will be fired when Swiper reach its beginning (initial position)
  207. */
  208. reachBeginning: CustomEvent<[swiper: SwiperClass]>;
  209. /**
  210. * Event will be fired when Swiper reach last slide
  211. */
  212. reachEnd: CustomEvent<[swiper: SwiperClass]>;
  213. /**
  214. * Event will be fired when Swiper goes to beginning or end position
  215. */
  216. toEdge: CustomEvent<[swiper: SwiperClass]>;
  217. /**
  218. * Event will be fired when Swiper goes from beginning or end position
  219. */
  220. fromEdge: CustomEvent<[swiper: SwiperClass]>;
  221. /**
  222. * Event will be fired when swiper's wrapper change its position. Receives current translate value as an arguments
  223. */
  224. setTranslate: CustomEvent<[swiper: SwiperClass, translate: number]>;
  225. /**
  226. * Event will be fired everytime when swiper starts animation. Receives current transition duration (in ms) as an arguments
  227. */
  228. setTransition: CustomEvent<[swiper: SwiperClass, transition: number]>;
  229. /**
  230. * Event will be fired on window resize right before swiper's onresize manipulation
  231. */
  232. resize: CustomEvent<[swiper: SwiperClass]>;
  233. /**
  234. * Event will be fired if observer is enabled and it detects DOM mutations
  235. */
  236. observerUpdate: CustomEvent<[swiper: SwiperClass]>;
  237. /**
  238. * Event will be fired right before "loop fix"
  239. */
  240. beforeLoopFix: CustomEvent<[swiper: SwiperClass]>;
  241. /**
  242. * Event will be fired after "loop fix"
  243. */
  244. loopFix: CustomEvent<[swiper: SwiperClass]>;
  245. /**
  246. * Event will be fired on breakpoint change
  247. */
  248. breakpoint: CustomEvent<[swiper: SwiperClass, breakpointParams: SwiperOptions]>;
  249. /**
  250. * !INTERNAL: Event will fired right before breakpoint change
  251. */
  252. _beforeBreakpoint: CustomEvent<[swiper: SwiperClass, breakpointParams: SwiperOptions]>;
  253. /**
  254. * !INTERNAL: Event will fired after setting CSS classes on swiper container element
  255. */
  256. _containerClasses: CustomEvent<[swiper: SwiperClass, classNames: string]>;
  257. /**
  258. * !INTERNAL: Event will fired after setting CSS classes on swiper slide element
  259. */
  260. _slideClass: CustomEvent<[swiper: SwiperClass, slideEl: HTMLElement, classNames: string]>;
  261. /**
  262. * !INTERNAL: Event will fired after setting CSS classes on all swiper slides
  263. */
  264. _slideClasses: CustomEvent<[
  265. swiper: SwiperClass,
  266. slides: { slideEl: HTMLElement; classNames: string; index: number }[],
  267. ]>;
  268. /**
  269. * !INTERNAL: Event will fired as soon as swiper instance available (before init)
  270. */
  271. _swiper: CustomEvent<[swiper: SwiperClass]>;
  272. /**
  273. * !INTERNAL: Event will be fired on free mode touch end (release) and there will no be momentum
  274. */
  275. _freeModeNoMomentumRelease: CustomEvent<[swiper: SwiperClass]>;
  276. /**
  277. * Event will fired on active index change
  278. */
  279. activeIndexChange: CustomEvent<[swiper: SwiperClass]>;
  280. /**
  281. * Event will fired on snap index change
  282. */
  283. snapIndexChange: CustomEvent<[swiper: SwiperClass]>;
  284. /**
  285. * Event will fired on real index change
  286. */
  287. realIndexChange: CustomEvent<[swiper: SwiperClass]>;
  288. /**
  289. * Event will fired right after initialization
  290. */
  291. afterInit: CustomEvent<[swiper: SwiperClass]>;
  292. /**
  293. * Event will fired right before initialization
  294. */
  295. beforeInit: CustomEvent<[swiper: SwiperClass]>;
  296. /**
  297. * Event will fired before resize handler
  298. */
  299. beforeResize: CustomEvent<[swiper: SwiperClass]>;
  300. /**
  301. * Event will fired before slide change transition start
  302. */
  303. beforeSlideChangeStart: CustomEvent<[swiper: SwiperClass]>;
  304. /**
  305. * Event will fired before transition start
  306. */
  307. beforeTransitionStart: CustomEvent<[swiper: SwiperClass, speed: number, internal: any]>; // what is internal?
  308. /**
  309. * Event will fired on direction change
  310. */
  311. changeDirection: CustomEvent<[swiper: SwiperClass]>;
  312. /**
  313. * Event will be fired when user double click/tap on Swiper
  314. */
  315. doubleClick: CustomEvent<[swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent]>;
  316. /**
  317. * Event will be fired on swiper destroy
  318. */
  319. destroy: CustomEvent<[swiper: SwiperClass]>;
  320. /**
  321. * Event will be fired on momentum bounce
  322. */
  323. momentumBounce: CustomEvent<[swiper: SwiperClass]>;
  324. /**
  325. * Event will be fired on orientation change (e.g. landscape -> portrait)
  326. */
  327. orientationchange: CustomEvent<[swiper: SwiperClass]>;
  328. /**
  329. * Event will be fired in the beginning of animation of resetting slide to current one
  330. */
  331. slideResetTransitionStart: CustomEvent<[swiper: SwiperClass]>;
  332. /**
  333. * Event will be fired in the end of animation of resetting slide to current one
  334. */
  335. slideResetTransitionEnd: CustomEvent<[swiper: SwiperClass]>;
  336. /**
  337. * Event will be fired with first touch/drag move
  338. */
  339. sliderFirstMove: CustomEvent<[swiper: SwiperClass, event: TouchEvent]>;
  340. /**
  341. * Event will be fired when number of slides has changed
  342. */
  343. slidesLengthChange: CustomEvent<[swiper: SwiperClass]>;
  344. /**
  345. * Event will be fired when slides grid has changed
  346. */
  347. slidesGridLengthChange: CustomEvent<[swiper: SwiperClass]>;
  348. /**
  349. * Event will be fired when snap grid has changed
  350. */
  351. snapGridLengthChange: CustomEvent<[swiper: SwiperClass]>;
  352. /**
  353. * Event will be fired after swiper.update() call
  354. */
  355. update: CustomEvent<[swiper: SwiperClass]>;
  356. /**
  357. * Event will be fired when swiper is locked (when `watchOverflow` enabled)
  358. */
  359. lock: CustomEvent<[swiper: SwiperClass]>;
  360. /**
  361. * Event will be fired when swiper is unlocked (when `watchOverflow` enabled)
  362. */
  363. unlock: CustomEvent<[swiper: SwiperClass]>;
  364. },
  365. {
  366. default: {};
  367. 'container-start': {};
  368. 'wrapper-start': {};
  369. 'wrapper-end': {};
  370. 'container-end': {};
  371. }
  372. > {}
  373. declare class SwiperSlide extends SvelteComponentTyped<
  374. SwiperSlideProps,
  375. {},
  376. {
  377. default: {};
  378. }
  379. > {}
  380. export { Swiper, SwiperSlide };