swiper-vue.d.ts 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889
  1. import {
  2. A11yOptions,
  3. AutoplayOptions,
  4. ControllerOptions,
  5. CoverflowEffectOptions,
  6. CubeEffectOptions,
  7. FadeEffectOptions,
  8. FlipEffectOptions,
  9. CreativeEffectOptions,
  10. CardsEffectOptions,
  11. HashNavigationOptions,
  12. HistoryOptions,
  13. KeyboardOptions,
  14. LazyOptions,
  15. MousewheelOptions,
  16. NavigationOptions,
  17. PaginationOptions,
  18. ParallaxOptions,
  19. ScrollbarOptions,
  20. ThumbsOptions,
  21. VirtualOptions,
  22. ZoomOptions,
  23. FreeModeOptions,
  24. GridOptions,
  25. } from '../types';
  26. import { ComponentOptionsMixin, DefineComponent, PropType, Ref } from 'vue';
  27. import { SwiperOptions, Swiper as SwiperClass } from '../types';
  28. declare const Swiper: DefineComponent<
  29. {
  30. tag: {
  31. type: StringConstructor;
  32. default: string;
  33. };
  34. wrapperTag: {
  35. type: StringConstructor;
  36. default: string;
  37. };
  38. modules: {
  39. type: ArrayConstructor;
  40. default: undefined;
  41. };
  42. init: {
  43. type: BooleanConstructor;
  44. default: undefined;
  45. };
  46. direction: {
  47. type: PropType<SwiperOptions['direction']>;
  48. default: SwiperOptions['direction'];
  49. };
  50. touchEventsTarget: {
  51. type: PropType<SwiperOptions['touchEventsTarget']>;
  52. default: undefined;
  53. };
  54. initialSlide: {
  55. type: NumberConstructor;
  56. default: undefined;
  57. };
  58. speed: { type: NumberConstructor; default: undefined };
  59. cssMode: { type: BooleanConstructor; default: undefined };
  60. updateOnWindowResize: {
  61. type: BooleanConstructor;
  62. default: undefined;
  63. };
  64. resizeObserver: {
  65. type: BooleanConstructor;
  66. default: undefined;
  67. };
  68. nested: { type: BooleanConstructor; default: undefined };
  69. focusableElements: {
  70. type: StringConstructor;
  71. default: undefined;
  72. };
  73. width: { type: NumberConstructor; default: undefined };
  74. height: { type: NumberConstructor; default: undefined };
  75. preventInteractionOnTransition: {
  76. type: BooleanConstructor;
  77. default: undefined;
  78. };
  79. userAgent: { type: StringConstructor; default: undefined };
  80. url: { type: StringConstructor; default: undefined };
  81. edgeSwipeDetection: {
  82. type: BooleanConstructor | StringConstructor;
  83. default: undefined;
  84. };
  85. edgeSwipeThreshold: {
  86. type: NumberConstructor;
  87. default: undefined;
  88. };
  89. autoHeight: {
  90. type: BooleanConstructor;
  91. default: undefined;
  92. };
  93. setWrapperSize: {
  94. type: BooleanConstructor;
  95. default: undefined;
  96. };
  97. virtualTranslate: {
  98. type: BooleanConstructor;
  99. default: undefined;
  100. };
  101. effect: {
  102. type: PropType<SwiperOptions['effect']>;
  103. default: undefined;
  104. };
  105. breakpoints: {
  106. type: PropType<SwiperOptions['breakpoints']>;
  107. default: undefined;
  108. };
  109. spaceBetween: {
  110. type: NumberConstructor;
  111. default: undefined;
  112. };
  113. slidesPerView: {
  114. type: PropType<SwiperOptions['slidesPerView']>;
  115. default: undefined;
  116. };
  117. maxBackfaceHiddenSlides: {
  118. type: NumberConstructor;
  119. default: undefined;
  120. };
  121. slidesPerGroup: {
  122. type: NumberConstructor;
  123. default: undefined;
  124. };
  125. slidesPerGroupSkip: {
  126. type: NumberConstructor;
  127. default: undefined;
  128. };
  129. slidesPerGroupAuto: {
  130. type: BooleanConstructor;
  131. default: undefined;
  132. };
  133. centeredSlides: {
  134. type: BooleanConstructor;
  135. default: undefined;
  136. };
  137. centeredSlidesBounds: {
  138. type: BooleanConstructor;
  139. default: undefined;
  140. };
  141. slidesOffsetBefore: {
  142. type: NumberConstructor;
  143. default: undefined;
  144. };
  145. slidesOffsetAfter: {
  146. type: NumberConstructor;
  147. default: undefined;
  148. };
  149. normalizeSlideIndex: {
  150. type: BooleanConstructor;
  151. default: undefined;
  152. };
  153. centerInsufficientSlides: {
  154. type: BooleanConstructor;
  155. default: undefined;
  156. };
  157. watchOverflow: {
  158. type: BooleanConstructor;
  159. default: undefined;
  160. };
  161. roundLengths: {
  162. type: BooleanConstructor;
  163. default: undefined;
  164. };
  165. touchRatio: {
  166. type: NumberConstructor;
  167. default: undefined;
  168. };
  169. touchAngle: {
  170. type: NumberConstructor;
  171. default: undefined;
  172. };
  173. simulateTouch: {
  174. type: BooleanConstructor;
  175. default: undefined;
  176. };
  177. shortSwipes: {
  178. type: BooleanConstructor;
  179. default: undefined;
  180. };
  181. longSwipes: {
  182. type: BooleanConstructor;
  183. default: undefined;
  184. };
  185. longSwipesRatio: {
  186. type: NumberConstructor;
  187. default: undefined;
  188. };
  189. longSwipesMs: {
  190. type: NumberConstructor;
  191. default: undefined;
  192. };
  193. followFinger: {
  194. type: BooleanConstructor;
  195. default: undefined;
  196. };
  197. allowTouchMove: {
  198. type: BooleanConstructor;
  199. default: undefined;
  200. };
  201. threshold: { type: NumberConstructor; default: undefined };
  202. touchMoveStopPropagation: {
  203. type: BooleanConstructor;
  204. default: undefined;
  205. };
  206. touchStartPreventDefault: {
  207. type: BooleanConstructor;
  208. default: undefined;
  209. };
  210. touchStartForcePreventDefault: {
  211. type: BooleanConstructor;
  212. default: undefined;
  213. };
  214. touchReleaseOnEdges: {
  215. type: BooleanConstructor;
  216. default: undefined;
  217. };
  218. uniqueNavElements: {
  219. type: BooleanConstructor;
  220. default: undefined;
  221. };
  222. resistance: {
  223. type: BooleanConstructor;
  224. default: undefined;
  225. };
  226. resistanceRatio: {
  227. type: NumberConstructor;
  228. default: undefined;
  229. };
  230. watchSlidesProgress: {
  231. type: BooleanConstructor;
  232. default: undefined;
  233. };
  234. grabCursor: {
  235. type: BooleanConstructor;
  236. default: undefined;
  237. };
  238. preventClicks: {
  239. type: BooleanConstructor;
  240. default: undefined;
  241. };
  242. preventClicksPropagation: {
  243. type: BooleanConstructor;
  244. default: undefined;
  245. };
  246. slideToClickedSlide: {
  247. type: BooleanConstructor;
  248. default: undefined;
  249. };
  250. preloadImages: {
  251. type: BooleanConstructor;
  252. default: undefined;
  253. };
  254. updateOnImagesReady: {
  255. type: BooleanConstructor;
  256. default: undefined;
  257. };
  258. loop: { type: BooleanConstructor; default: undefined };
  259. loopAdditionalSlides: {
  260. type: NumberConstructor;
  261. default: undefined;
  262. };
  263. loopedSlides: {
  264. type: NumberConstructor;
  265. default: undefined;
  266. };
  267. loopFillGroupWithBlank: {
  268. type: BooleanConstructor;
  269. default: undefined;
  270. };
  271. loopPreventsSlide: {
  272. type: BooleanConstructor;
  273. default: undefined;
  274. };
  275. rewind: { type: BooleanConstructor; default: undefined };
  276. allowSlidePrev: {
  277. type: BooleanConstructor;
  278. default: undefined;
  279. };
  280. allowSlideNext: {
  281. type: BooleanConstructor;
  282. default: undefined;
  283. };
  284. swipeHandler: {
  285. type: BooleanConstructor;
  286. default: undefined;
  287. };
  288. noSwiping: {
  289. type: BooleanConstructor;
  290. default: undefined;
  291. };
  292. noSwipingClass: {
  293. type: StringConstructor;
  294. default: undefined;
  295. };
  296. noSwipingSelector: {
  297. type: StringConstructor;
  298. default: undefined;
  299. };
  300. passiveListeners: {
  301. type: BooleanConstructor;
  302. default: undefined;
  303. };
  304. containerModifierClass: {
  305. type: StringConstructor;
  306. default: undefined;
  307. };
  308. slideClass: {
  309. type: StringConstructor;
  310. default: undefined;
  311. };
  312. slideBlankClass: {
  313. type: StringConstructor;
  314. default: undefined;
  315. };
  316. slideActiveClass: {
  317. type: StringConstructor;
  318. default: undefined;
  319. };
  320. slideDuplicateActiveClass: {
  321. type: StringConstructor;
  322. default: undefined;
  323. };
  324. slideVisibleClass: {
  325. type: StringConstructor;
  326. default: undefined;
  327. };
  328. slideDuplicateClass: {
  329. type: StringConstructor;
  330. default: undefined;
  331. };
  332. slideNextClass: {
  333. type: StringConstructor;
  334. default: undefined;
  335. };
  336. slideDuplicateNextClass: {
  337. type: StringConstructor;
  338. default: undefined;
  339. };
  340. slidePrevClass: {
  341. type: StringConstructor;
  342. default: undefined;
  343. };
  344. slideDuplicatePrevClass: {
  345. type: StringConstructor;
  346. default: undefined;
  347. };
  348. wrapperClass: {
  349. type: StringConstructor;
  350. default: undefined;
  351. };
  352. runCallbacksOnInit: {
  353. type: BooleanConstructor;
  354. default: undefined;
  355. };
  356. observer: { type: BooleanConstructor; default: undefined };
  357. observeParents: {
  358. type: BooleanConstructor;
  359. default: undefined;
  360. };
  361. observeSlideChildren: {
  362. type: BooleanConstructor;
  363. default: undefined;
  364. };
  365. a11y: {
  366. type: PropType<A11yOptions | boolean>;
  367. default: undefined;
  368. };
  369. autoplay: {
  370. type: PropType<AutoplayOptions | boolean>;
  371. default: undefined;
  372. };
  373. controller: {
  374. type: PropType<ControllerOptions>;
  375. default: undefined;
  376. };
  377. coverflowEffect: {
  378. type: PropType<CoverflowEffectOptions>;
  379. default: undefined;
  380. };
  381. cubeEffect: {
  382. type: PropType<CubeEffectOptions>;
  383. default: undefined;
  384. };
  385. fadeEffect: {
  386. type: PropType<FadeEffectOptions>;
  387. default: undefined;
  388. };
  389. flipEffect: {
  390. type: PropType<FlipEffectOptions>;
  391. default: undefined;
  392. };
  393. creativeEffect: {
  394. type: PropType<CreativeEffectOptions>;
  395. default: undefined;
  396. };
  397. cardsEffect: {
  398. type: PropType<CardsEffectOptions>;
  399. default: undefined;
  400. };
  401. hashNavigation: {
  402. type: PropType<HashNavigationOptions | boolean>;
  403. default: undefined;
  404. };
  405. history: {
  406. type: PropType<HistoryOptions | boolean>;
  407. default: undefined;
  408. };
  409. keyboard: {
  410. type: PropType<KeyboardOptions | boolean>;
  411. default: undefined;
  412. };
  413. lazy: {
  414. type: PropType<LazyOptions | boolean>;
  415. default: undefined;
  416. };
  417. mousewheel: {
  418. type: PropType<MousewheelOptions | boolean>;
  419. default: undefined;
  420. };
  421. navigation: {
  422. type: PropType<NavigationOptions | boolean>;
  423. default: undefined;
  424. };
  425. pagination: {
  426. type: PropType<PaginationOptions | boolean>;
  427. default: undefined;
  428. };
  429. parallax: {
  430. type: PropType<ParallaxOptions | boolean>;
  431. default: undefined;
  432. };
  433. scrollbar: {
  434. type: PropType<ScrollbarOptions | boolean>;
  435. default: undefined;
  436. };
  437. thumbs: { type: PropType<ThumbsOptions>; default: undefined };
  438. virtual: {
  439. type: PropType<VirtualOptions | boolean>;
  440. default: undefined;
  441. };
  442. zoom: {
  443. type: PropType<ZoomOptions | boolean>;
  444. default: undefined;
  445. };
  446. freeMode: {
  447. type: PropType<FreeModeOptions | boolean>;
  448. default: undefined;
  449. };
  450. grid: {
  451. type: PropType<GridOptions>;
  452. default: undefined;
  453. };
  454. },
  455. () => JSX.Element,
  456. unknown,
  457. {},
  458. {},
  459. ComponentOptionsMixin,
  460. ComponentOptionsMixin,
  461. {
  462. swiper: (swiper: SwiperClass) => void;
  463. /**
  464. * Event will be fired in when autoplay started
  465. */
  466. autoplayStart: (swiper: SwiperClass) => void;
  467. /**
  468. * Event will be fired when autoplay stopped
  469. */
  470. autoplayStop: (swiper: SwiperClass) => void;
  471. /**
  472. * Event will be fired on autoplay pause (on mouse/pointer enter), when `pauseOnMouseEnter` enabled
  473. */
  474. autoplayPause: (swiper: SwiperClass) => void;
  475. /**
  476. * Event will be fired on autoplay resume (on mouse/pointer leave), when `pauseOnMouseEnter` enabled
  477. */
  478. autoplayResume: (swiper: SwiperClass) => void;
  479. /**
  480. * Event will be fired when slide changed with autoplay
  481. */
  482. autoplay: (swiper: SwiperClass) => void;/**
  483. * Event will be fired on window hash change
  484. */
  485. hashChange: (swiper: SwiperClass) => void;
  486. /**
  487. * Event will be fired when swiper updates the hash
  488. */
  489. hashSet: (swiper: SwiperClass) => void;/**
  490. * Event will be fired in the beginning of lazy loading of image
  491. */
  492. lazyImageLoad: (swiper: SwiperClass, slideEl: HTMLElement, imageEl: HTMLElement) => void;
  493. /**
  494. * Event will be fired when lazy loading image will be loaded
  495. */
  496. lazyImageReady: (swiper: SwiperClass, slideEl: HTMLElement, imageEl: HTMLElement) => void;/**
  497. * Event will be fired on key press
  498. */
  499. keyPress: (swiper: SwiperClass, keyCode: string) => void;/**
  500. * Event will be fired on navigation hide
  501. */
  502. navigationHide: (swiper: SwiperClass) => void;
  503. /**
  504. * Event will be fired on navigation show
  505. */
  506. navigationShow: (swiper: SwiperClass) => void;
  507. /**
  508. * Event will be fired on navigation prev button click
  509. */
  510. navigationPrev: (swiper: SwiperClass) => void;
  511. /**
  512. * Event will be fired on navigation next button click
  513. */
  514. navigationNext: (swiper: SwiperClass) => void;/**
  515. * Event will be fired after pagination rendered
  516. */
  517. paginationRender: (swiper: SwiperClass, paginationEl: HTMLElement) => void;
  518. /**
  519. * Event will be fired when pagination updated
  520. */
  521. paginationUpdate: (swiper: SwiperClass, paginationEl: HTMLElement) => void;
  522. /**
  523. * Event will be fired on pagination hide
  524. */
  525. paginationHide: (swiper: SwiperClass) => void;
  526. /**
  527. * Event will be fired on pagination show
  528. */
  529. paginationShow: (swiper: SwiperClass) => void;/**
  530. * Event will be fired on mousewheel scroll
  531. */
  532. scroll: (swiper: SwiperClass, event: WheelEvent) => void;/**
  533. * Event will be fired on draggable scrollbar drag start
  534. */
  535. scrollbarDragStart: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  536. /**
  537. * Event will be fired on draggable scrollbar drag move
  538. */
  539. scrollbarDragMove: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  540. /**
  541. * Event will be fired on draggable scrollbar drag end
  542. */
  543. scrollbarDragEnd: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;/**
  544. * Event will be fired on zoom change
  545. */
  546. zoomChange: (swiper: SwiperClass, scale: number, imageEl: HTMLElement, slideEl: HTMLElement) => void;
  547. /**
  548. * Fired right after Swiper initialization.
  549. * @note Note that with `swiper.on('init')` syntax it will
  550. * work only in case you set `init: false` parameter.
  551. *
  552. * @example
  553. * ```js
  554. * const swiper = new Swiper('.swiper', {
  555. * init: false,
  556. * // other parameters
  557. * });
  558. * swiper.on('init', function() {
  559. * // do something
  560. * });
  561. * // init Swiper
  562. * swiper.init();
  563. * ```
  564. *
  565. * @example
  566. * ```js
  567. * // Otherwise use it as the parameter:
  568. * const swiper = new Swiper('.swiper', {
  569. * // other parameters
  570. * on: {
  571. * init: function () {
  572. * // do something
  573. * },
  574. * }
  575. * });
  576. * ```
  577. */
  578. init: (swiper: SwiperClass) => any;
  579. /**
  580. * Event will be fired right before Swiper destroyed
  581. */
  582. beforeDestroy: (swiper: SwiperClass) => void;
  583. /**
  584. * Event will be fired when currently active slide is changed
  585. */
  586. slideChange: (swiper: SwiperClass) => void;
  587. /**
  588. * Event will be fired in the beginning of animation to other slide (next or previous).
  589. */
  590. slideChangeTransitionStart: (swiper: SwiperClass) => void;
  591. /**
  592. * Event will be fired after animation to other slide (next or previous).
  593. */
  594. slideChangeTransitionEnd: (swiper: SwiperClass) => void;
  595. /**
  596. * Same as "slideChangeTransitionStart" but for "forward" direction only
  597. */
  598. slideNextTransitionStart: (swiper: SwiperClass) => void;
  599. /**
  600. * Same as "slideChangeTransitionEnd" but for "forward" direction only
  601. */
  602. slideNextTransitionEnd: (swiper: SwiperClass) => void;
  603. /**
  604. * Same as "slideChangeTransitionStart" but for "backward" direction only
  605. */
  606. slidePrevTransitionStart: (swiper: SwiperClass) => void;
  607. /**
  608. * Same as "slideChangeTransitionEnd" but for "backward" direction only
  609. */
  610. slidePrevTransitionEnd: (swiper: SwiperClass) => void;
  611. /**
  612. * Event will be fired in the beginning of transition.
  613. */
  614. transitionStart: (swiper: SwiperClass) => void;
  615. /**
  616. * Event will be fired after transition.
  617. */
  618. transitionEnd: (swiper: SwiperClass) => void;
  619. /**
  620. * Event will be fired when user touch Swiper. Receives `touchstart` event as an arguments.
  621. */
  622. touchStart: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  623. /**
  624. * Event will be fired when user touch and move finger over Swiper. Receives `touchmove` event as an arguments.
  625. */
  626. touchMove: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  627. /**
  628. * Event will be fired when user touch and move finger over Swiper in direction opposite to direction parameter. Receives `touchmove` event as an arguments.
  629. */
  630. touchMoveOpposite: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  631. /**
  632. * Event will be fired when user touch and move finger over Swiper and move it. Receives `touchmove` event as an arguments.
  633. */
  634. sliderMove: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  635. /**
  636. * Event will be fired when user release Swiper. Receives `touchend` event as an arguments.
  637. */
  638. touchEnd: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  639. /**
  640. * Event will be fired when user click/tap on Swiper. Receives `touchend` event as an arguments.
  641. */
  642. click: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  643. /**
  644. * Event will be fired when user click/tap on Swiper. Receives `touchend` event as an arguments.
  645. */
  646. tap: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  647. /**
  648. * Event will be fired when user double tap on Swiper's container. Receives `touchend` event as an arguments
  649. */
  650. doubleTap: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  651. /**
  652. * Event will be fired right after all inner images are loaded. updateOnImagesReady should be also enabled
  653. */
  654. imagesReady: (swiper: SwiperClass) => void;
  655. /**
  656. * Event will be fired when Swiper progress is changed, as an arguments it receives progress that is always from 0 to 1
  657. */
  658. progress: (swiper: SwiperClass, progress: number) => void;
  659. /**
  660. * Event will be fired when Swiper reach its beginning (initial position)
  661. */
  662. reachBeginning: (swiper: SwiperClass) => void;
  663. /**
  664. * Event will be fired when Swiper reach last slide
  665. */
  666. reachEnd: (swiper: SwiperClass) => void;
  667. /**
  668. * Event will be fired when Swiper goes to beginning or end position
  669. */
  670. toEdge: (swiper: SwiperClass) => void;
  671. /**
  672. * Event will be fired when Swiper goes from beginning or end position
  673. */
  674. fromEdge: (swiper: SwiperClass) => void;
  675. /**
  676. * Event will be fired when swiper's wrapper change its position. Receives current translate value as an arguments
  677. */
  678. setTranslate: (swiper: SwiperClass, translate: number) => void;
  679. /**
  680. * Event will be fired everytime when swiper starts animation. Receives current transition duration (in ms) as an arguments
  681. */
  682. setTransition: (swiper: SwiperClass, transition: number) => void;
  683. /**
  684. * Event will be fired on window resize right before swiper's onresize manipulation
  685. */
  686. resize: (swiper: SwiperClass) => void;
  687. /**
  688. * Event will be fired if observer is enabled and it detects DOM mutations
  689. */
  690. observerUpdate: (swiper: SwiperClass) => void;
  691. /**
  692. * Event will be fired right before "loop fix"
  693. */
  694. beforeLoopFix: (swiper: SwiperClass) => void;
  695. /**
  696. * Event will be fired after "loop fix"
  697. */
  698. loopFix: (swiper: SwiperClass) => void;
  699. /**
  700. * Event will be fired on breakpoint change
  701. */
  702. breakpoint: (swiper: SwiperClass, breakpointParams: SwiperOptions) => void;
  703. /**
  704. * !INTERNAL: Event will fired right before breakpoint change
  705. */
  706. _beforeBreakpoint: (swiper: SwiperClass, breakpointParams: SwiperOptions) => void;
  707. /**
  708. * !INTERNAL: Event will fired after setting CSS classes on swiper container element
  709. */
  710. _containerClasses: (swiper: SwiperClass, classNames: string) => void;
  711. /**
  712. * !INTERNAL: Event will fired after setting CSS classes on swiper slide element
  713. */
  714. _slideClass: (swiper: SwiperClass, slideEl: HTMLElement, classNames: string) => void;
  715. /**
  716. * !INTERNAL: Event will fired after setting CSS classes on all swiper slides
  717. */
  718. _slideClasses: (
  719. swiper: SwiperClass,
  720. slides: { slideEl: HTMLElement; classNames: string; index: number }[],
  721. ) => void;
  722. /**
  723. * !INTERNAL: Event will fired as soon as swiper instance available (before init)
  724. */
  725. _swiper: (swiper: SwiperClass) => void;
  726. /**
  727. * !INTERNAL: Event will be fired on free mode touch end (release) and there will no be momentum
  728. */
  729. _freeModeNoMomentumRelease: (swiper: SwiperClass) => void;
  730. /**
  731. * Event will fired on active index change
  732. */
  733. activeIndexChange: (swiper: SwiperClass) => void;
  734. /**
  735. * Event will fired on snap index change
  736. */
  737. snapIndexChange: (swiper: SwiperClass) => void;
  738. /**
  739. * Event will fired on real index change
  740. */
  741. realIndexChange: (swiper: SwiperClass) => void;
  742. /**
  743. * Event will fired right after initialization
  744. */
  745. afterInit: (swiper: SwiperClass) => void;
  746. /**
  747. * Event will fired right before initialization
  748. */
  749. beforeInit: (swiper: SwiperClass) => void;
  750. /**
  751. * Event will fired before resize handler
  752. */
  753. beforeResize: (swiper: SwiperClass) => void;
  754. /**
  755. * Event will fired before slide change transition start
  756. */
  757. beforeSlideChangeStart: (swiper: SwiperClass) => void;
  758. /**
  759. * Event will fired before transition start
  760. */
  761. beforeTransitionStart: (swiper: SwiperClass, speed: number, internal: any) => void; // what is internal?
  762. /**
  763. * Event will fired on direction change
  764. */
  765. changeDirection: (swiper: SwiperClass) => void;
  766. /**
  767. * Event will be fired when user double click/tap on Swiper
  768. */
  769. doubleClick: (swiper: SwiperClass, event: MouseEvent | TouchEvent | PointerEvent) => void;
  770. /**
  771. * Event will be fired on swiper destroy
  772. */
  773. destroy: (swiper: SwiperClass) => void;
  774. /**
  775. * Event will be fired on momentum bounce
  776. */
  777. momentumBounce: (swiper: SwiperClass) => void;
  778. /**
  779. * Event will be fired on orientation change (e.g. landscape -> portrait)
  780. */
  781. orientationchange: (swiper: SwiperClass) => void;
  782. /**
  783. * Event will be fired in the beginning of animation of resetting slide to current one
  784. */
  785. slideResetTransitionStart: (swiper: SwiperClass) => void;
  786. /**
  787. * Event will be fired in the end of animation of resetting slide to current one
  788. */
  789. slideResetTransitionEnd: (swiper: SwiperClass) => void;
  790. /**
  791. * Event will be fired with first touch/drag move
  792. */
  793. sliderFirstMove: (swiper: SwiperClass, event: TouchEvent) => void;
  794. /**
  795. * Event will be fired when number of slides has changed
  796. */
  797. slidesLengthChange: (swiper: SwiperClass) => void;
  798. /**
  799. * Event will be fired when slides grid has changed
  800. */
  801. slidesGridLengthChange: (swiper: SwiperClass) => void;
  802. /**
  803. * Event will be fired when snap grid has changed
  804. */
  805. snapGridLengthChange: (swiper: SwiperClass) => void;
  806. /**
  807. * Event will be fired after swiper.update() call
  808. */
  809. update: (swiper: SwiperClass) => void;
  810. /**
  811. * Event will be fired when swiper is locked (when `watchOverflow` enabled)
  812. */
  813. lock: (swiper: SwiperClass) => void;
  814. /**
  815. * Event will be fired when swiper is unlocked (when `watchOverflow` enabled)
  816. */
  817. unlock: (swiper: SwiperClass) => void;
  818. }
  819. >;
  820. declare const SwiperSlide: DefineComponent<{
  821. tag: {
  822. type: StringConstructor;
  823. default: string;
  824. };
  825. swiperRef: { type: PropType<SwiperClass>; required: false };
  826. zoom: { type: BooleanConstructor; default: undefined };
  827. virtualIndex: {
  828. type: StringConstructor | NumberConstructor;
  829. default: undefined;
  830. };
  831. }>;
  832. declare const useSwiper: () => Ref<SwiperClass>;
  833. declare const useSwiperSlide: () => Ref<{
  834. isActive: boolean;
  835. isVisible: boolean;
  836. isDuplicate: boolean;
  837. isPrev: boolean;
  838. isNext: boolean;
  839. }>;
  840. export { Swiper, SwiperSlide, useSwiper, useSwiperSlide };