@gem-sdk/swiper 0.0.7

package/types/modules/manipulation.d.ts

@@ -0,0 +1,70 @@
+export interface ManipulationMethods {
+  /**
+   * Add new slides to the end. slides could be
+   * HTMLElement or HTML string with new slide or
+   * array with such slides, for example:
+   *
+   * @example
+   * ```js
+   * appendSlide('<div class="swiper-slide">Slide 10"</div>')
+   *
+   * appendSlide([
+   *  '<div class="swiper-slide">Slide 10"</div>',
+   *  '<div class="swiper-slide">Slide 11"</div>'
+   * ]);
+   * ```
+   */
+  appendSlide(slides: HTMLElement | string | string[] | HTMLElement[]): void;
+
+  /**
+   * Add new slides to the beginning. slides could be
+   * HTMLElement or HTML string with new slide or array with such slides, for example:
+   *
+   * @example
+   * ```js
+   * prependSlide('<div class="swiper-slide">Slide 0"</div>')
+   *
+   * prependSlide([
+   *  '<div class="swiper-slide">Slide 1"</div>',
+   *  '<div class="swiper-slide">Slide 2"</div>'
+   * ]);
+   * ```
+   */
+  prependSlide(slides: HTMLElement | string | string[] | HTMLElement[]): void;
+
+  /**
+   * Add new slides to the required index. slides could be HTMLElement or HTML string with new slide or array with such slides, for example:
+   *
+   * @example
+   * ```js
+   * addSlide(1, '<div class="swiper-slide">Slide 10"</div>')
+   *
+   * addSlide(1, [
+   *  '<div class="swiper-slide">Slide 10"</div>',
+   *  '<div class="swiper-slide">Slide 11"</div>'
+   * ]);
+   * ```
+   */
+  addSlide(index: number, slides: HTMLElement | string | string[] | HTMLElement[]): void;
+
+  /**
+   * Remove selected slides. slideIndex could be a number with slide index to remove or array with indexes.
+   *
+   * @example
+   * ```js
+   * removeSlide(0); // remove first slide
+   * removeSlide([0, 1]); // remove first and second slides
+   * removeAllSlides();    // Remove all slides
+   * ```
+   */
+  removeSlide(slideIndex: number | number[]): void;
+
+  /**
+   * Remove all slides
+   */
+  removeAllSlides(): void;
+}
+
+export interface ManipulationEvents {}
+
+export interface ManipulationOptions {}

package/types/modules/mousewheel.d.ts

@@ -0,0 +1,86 @@
+import type Swiper from '../swiper-class.d.ts';
+import type { CSSSelector } from '../shared.d.ts';
+
+export interface MousewheelMethods {
+  /**
+   * Whether the mousewheel control is enabled
+   */
+  enabled: boolean;
+
+  /**
+   * Enable mousewheel control
+   */
+  enable(): void;
+
+  /**
+   * Disable mousewheel control
+   */
+  disable(): void;
+}
+
+export interface MousewheelEvents {
+  /**
+   * Event will be fired on mousewheel scroll
+   */
+  scroll: (swiper: Swiper, event: WheelEvent) => void;
+}
+
+export interface MousewheelOptions {
+  /**
+   * Set to `true` to enable mousewheel control
+   *
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * Set to `true` to force mousewheel swipes to axis. So in horizontal mode mousewheel will work only with horizontal mousewheel scrolling, and only with vertical scrolling in vertical mode.
+   *
+   * @default false
+   */
+  forceToAxis?: boolean;
+  /**
+   * Set to `true` and swiper will release mousewheel event and allow page scrolling when swiper is on edge positions (in the beginning or in the end)
+   *
+   * @default false
+   */
+  releaseOnEdges?: boolean;
+  /**
+   * Set to `true` to invert sliding direction
+   *
+   * @default false
+   */
+  invert?: boolean;
+  /**
+   * Multiplier of mousewheel data, allows to tweak mouse wheel sensitivity
+   *
+   * @default 1
+   */
+  sensitivity?: number;
+  /**
+   * String with CSS selector or HTML element of the container accepting mousewheel events. By default it is swiper
+   *
+   * @default 'container'
+   */
+  eventsTarget?: 'container' | 'wrapper' | CSSSelector | HTMLElement;
+
+  /**
+   * Minimum mousewheel scroll delta to trigger swiper slide change
+   *
+   * @default null
+   */
+  thresholdDelta?: number | null;
+
+  /**
+   * Minimum mousewheel scroll time delta (in ms) to trigger swiper slide change
+   *
+   * @default null
+   */
+  thresholdTime?: number | null;
+
+  /**
+   * Scrolling on elements with this class will be ignored
+   *
+   * @default 'swiper-no-mousewheel'
+   */
+  noMousewheelClass?: string;
+}

package/types/modules/navigation.d.ts

@@ -0,0 +1,105 @@
+import type { CSSSelector } from '../shared.d.ts';
+import type Swiper from '../swiper-class.d.ts';
+
+export interface NavigationMethods {
+  /**
+   * HTMLElement of "next" navigation button
+   */
+  nextEl: HTMLElement;
+
+  /**
+   * HTMLElement of "previous" navigation button
+   */
+  prevEl: HTMLElement;
+
+  /**
+   * Update navigation buttons state (enabled/disabled)
+   */
+  update(): void;
+
+  /**
+   * Initialize navigation
+   */
+  init(): void;
+
+  /**
+   * Destroy navigation
+   */
+  destroy(): void;
+}
+
+export interface NavigationEvents {
+  /**
+   * Event will be fired on navigation hide
+   */
+  navigationHide: (swiper: Swiper) => void;
+  /**
+   * Event will be fired on navigation show
+   */
+  navigationShow: (swiper: Swiper) => void;
+  /**
+   * Event will be fired on navigation prev button click
+   */
+  navigationPrev: (swiper: Swiper) => void;
+  /**
+   * Event will be fired on navigation next button click
+   */
+  navigationNext: (swiper: Swiper) => void;
+}
+
+export interface NavigationOptions {
+  /**
+   * Boolean property to use with breakpoints to enable/disable navigation on certain breakpoints
+   */
+  enabled?: boolean;
+  /**
+   * String with CSS selector or HTML element of the element that will work
+   * like "next" button after click on it
+   *
+   * @default null
+   */
+  nextEl?: CSSSelector | HTMLElement | null;
+
+  /**
+   * String with CSS selector or HTML element of the element that will work
+   * like "prev" button after click on it
+   *
+   * @default null
+   */
+  prevEl?: CSSSelector | HTMLElement | null;
+
+  /**
+   * Toggle navigation buttons visibility after click on Slider's container
+   *
+   * @default false
+   */
+  hideOnClick?: boolean;
+
+  /**
+   * CSS class name added to navigation button when it becomes disabled
+   *
+   * @default 'swiper-button-disabled'
+   */
+  disabledClass?: string;
+
+  /**
+   * CSS class name added to navigation button when it becomes hidden
+   *
+   * @default 'swiper-button-hidden'
+   */
+  hiddenClass?: string;
+
+  /**
+   * CSS class name added to navigation button when it is disabled
+   *
+   * @default 'swiper-button-lock'
+   */
+  lockClass?: string;
+
+  /**
+   * CSS class name added on swiper container when navigation is disabled by breakpoint
+   *
+   * @default 'swiper-navigation-disabled'
+   */
+  navigationDisabledClass?: string;
+}

package/types/modules/pagination.d.ts

@@ -0,0 +1,307 @@
+import type { CSSSelector } from '../shared.d.ts';
+import type Swiper from '../swiper-class.d.ts';
+
+export interface PaginationMethods {
+  /**
+   * HTMLElement of pagination container element
+   */
+  el: HTMLElement;
+
+  /**
+   * Array of pagination bullets
+   * HTML elements. To get specific slide HTMLElement
+   * use `swiper.pagination.bullets[1]`.
+   */
+  bullets: HTMLElement[];
+
+  /**
+   * Render pagination layout
+   */
+  render(): void;
+
+  /**
+   * Update pagination state (enabled/disabled/active)
+   */
+  update(): void;
+
+  /**
+   * Initialize pagination
+   */
+  init(): void;
+
+  /**
+   * Destroy pagination
+   */
+  destroy(): void;
+}
+
+export interface PaginationEvents {
+  /**
+   * Event will be fired after pagination rendered
+   */
+  paginationRender: (swiper: Swiper, paginationEl: HTMLElement) => void;
+
+  /**
+   * Event will be fired when pagination updated
+   */
+  paginationUpdate: (swiper: Swiper, paginationEl: HTMLElement) => void;
+
+  /**
+   * Event will be fired on pagination hide
+   */
+  paginationHide: (swiper: Swiper) => void;
+
+  /**
+   * Event will be fired on pagination show
+   */
+  paginationShow: (swiper: Swiper) => void;
+}
+
+export interface PaginationOptions {
+  /**
+   * Boolean property to use with breakpoints to enable/disable pagination on certain breakpoints
+   */
+  enabled?: boolean;
+  /**
+   * String with CSS selector or HTML element of the container with pagination
+   *
+   * @default null
+   */
+  el?: CSSSelector | HTMLElement | null;
+
+  /**
+   * String with type of pagination. Can be `'bullets'`, `'fraction'`, `'progressbar'` or `'custom'`
+   *
+   * @default 'bullets'
+   */
+  type?: 'bullets' | 'fraction' | 'progressbar' | 'custom';
+
+  /**
+   * Defines which HTML tag will be used to represent single pagination bullet. Only for `'bullets'` pagination type.
+   *
+   * @default 'span'
+   */
+  bulletElement?: string;
+
+  /**
+   * Good to enable if you use bullets pagination with a lot of slides. So it will keep only few bullets visible at the same time.
+   *
+   * @default false
+   */
+  dynamicBullets?: boolean;
+
+  /**
+   * The number of main bullets visible when `dynamicBullets` enabled.
+   *
+   * @default 1
+   */
+  dynamicMainBullets?: number;
+
+  /**
+   * Toggle (hide/show) pagination container visibility after click on Slider's container
+   *
+   * @default true
+   */
+  hideOnClick?: boolean;
+
+  /**
+   * If `true` then clicking on pagination button will cause transition to appropriate slide. Only for bullets pagination type
+   *
+   * @default false
+   */
+  clickable?: boolean;
+
+  /**
+   * Makes pagination progressbar opposite to Swiper's `direction` parameter, means vertical progressbar for horizontal swiper
+   * direction and horizontal progressbar for vertical swiper direction
+   *
+   * @default false
+   */
+  progressbarOpposite?: boolean;
+
+  /**
+   * format fraction pagination current number. Function receives current number,
+   * and you need to return formatted value
+   */
+  formatFractionCurrent?: (number: number) => number | string;
+
+  /**
+   * format fraction pagination total number. Function receives total number, and you
+   * need to return formatted value
+   */
+  formatFractionTotal?: (number: number) => number | string;
+
+  /**
+   * This parameter allows totally customize pagination bullets, you need to pass here a function that accepts `index` number of
+   * pagination bullet and required element class name (`className`). Only for `'bullets'` pagination type
+   *
+   * @default null
+   *
+   * @example
+   * ```js
+   * const swiper = new Swiper('.swiper', {
+   *   //...
+   *   pagination: {
+   *     //...
+   *     renderBullet: function (index, className) {
+   *       return '<span class="' + className + '">' + (index + 1) + '</span>';
+   *     },
+   *   },
+   * });
+   * ```
+   */
+  renderBullet?: (index: number, className: string) => string;
+
+  /**
+   * This parameter allows to customize "fraction" pagination html. Only for `'fraction'` pagination type
+   *
+   * @default null
+   *
+   * @example
+   * ```js
+   * const swiper = new Swiper('.swiper', {
+   *   //...
+   *   pagination: {
+   *     //...
+   *     renderFraction: function (currentClass, totalClass) {
+   *       return '<span class="' + currentClass + '"></span>' +
+   *               ' of ' +
+   *               '<span class="' + totalClass + '"></span>';
+   *     },
+   *   },
+   * });
+   * ```
+   */
+  renderFraction?: (currentClass: string, totalClass: string) => string;
+
+  /**
+   * This parameter allows to customize "progress" pagination. Only for `'progress'` pagination type
+   *
+   * @default null
+   *
+   * @example
+   * ```js
+   * const swiper = new Swiper('.swiper', {
+   *   //...
+   *   pagination: {
+   *     //...
+   *     renderProgressbar: function (progressbarFillClass) {
+   *       return '<span class="' + progressbarFillClass + '"></span>';
+   *     },
+   *   },
+   * });
+   * ```
+   */
+  renderProgressbar?: (progressbarFillClass: string) => string;
+
+  /**
+   * This parameter is required for `'custom'` pagination type where you have to specify
+   * how it should be rendered.
+   *
+   * @default null
+   *
+   * @example
+   * ```js
+   * const swiper = new Swiper('.swiper', {
+   *   //...
+   *   pagination: {
+   *     //...
+   *     renderCustom: function (swiper, current, total) {
+   *       return current + ' of ' + total;
+   *     },
+   *   },
+   * });
+   * ```
+   */
+  renderCustom?: (swiper: Swiper, current: number, total: number) => string;
+
+  /**
+   * CSS class name of single pagination bullet
+   *
+   * @default 'swiper-pagination-bullet'
+   */
+  bulletClass?: string;
+
+  /**
+   * CSS class name of currently active pagination bullet
+   *
+   * @default 'swiper-pagination-bullet-active'
+   */
+  bulletActiveClass?: string;
+
+  /**
+   * The beginning of the modifier CSS class name that will be added to pagination depending on parameters
+   *
+   * @default 'swiper-pagination-'
+   */
+  modifierClass?: string;
+
+  /**
+   * CSS class name of the element with currently active index in "fraction" pagination
+   *
+   * @default 'swiper-pagination-current'
+   */
+  currentClass?: string;
+
+  /**
+   * CSS class name of the element with total number of "snaps" in "fraction" pagination
+   *
+   * @default 'swiper-pagination-total'
+   */
+  totalClass?: string;
+
+  /**
+   * CSS class name of pagination when it becomes inactive
+   *
+   * @default 'swiper-pagination-hidden'
+   */
+  hiddenClass?: string;
+
+  /**
+   * CSS class name of pagination progressbar fill element
+   *
+   * @default 'swiper-pagination-progressbar-fill'
+   */
+  progressbarFillClass?: string;
+
+  /**
+   * CSS class name of pagination progressbar opposite
+   *
+   * @default 'swiper-pagination-progressbar-opposite'
+   */
+  progressbarOppositeClass?: string;
+  /**
+   * CSS class name set to pagination when it is clickable
+   *
+   * @default 'swiper-pagination-clickable'
+   */
+  clickableClass?: string;
+
+  /**
+   * CSS class name set to pagination when it is disabled
+   *
+   * @default 'swiper-pagination-lock'
+   */
+  lockClass?: string;
+
+  /**
+   * CSS class name set to pagination in horizontal Swiper
+   *
+   * @default 'swiper-pagination-horizontal'
+   */
+  horizontalClass?: string;
+
+  /**
+   * CSS class name set to pagination in vertical Swiper
+   *
+   * @default 'swiper-pagination-vertical'
+   */
+  verticalClass?: string;
+
+  /**
+   * CSS class name added on swiper container and pagination element when pagination is disabled by breakpoint
+   *
+   * @default 'swiper-pagination-disabled'
+   */
+  paginationDisabledClass?: string;
+}

package/types/modules/parallax.d.ts

@@ -0,0 +1,12 @@
+export interface ParallaxMethods {}
+
+export interface ParallaxEvents {}
+
+export interface ParallaxOptions {
+  /**
+   * Enable, if you want to use "parallaxed" elements inside of slider
+   *
+   * @default false
+   */
+  enabled?: boolean;
+}

package/types/modules/public-api.d.ts

@@ -0,0 +1,23 @@
+export type * from './a11y.d.ts';
+export type * from './autoplay.d.ts';
+export type * from './controller.d.ts';
+export type * from './effect-coverflow.d.ts';
+export type * from './effect-cube.d.ts';
+export type * from './effect-fade.d.ts';
+export type * from './effect-flip.d.ts';
+export type * from './effect-creative.d.ts';
+export type * from './effect-cards.d.ts';
+export type * from './hash-navigation.d.ts';
+export type * from './history.d.ts';
+export type * from './keyboard.d.ts';
+export type * from './mousewheel.d.ts';
+export type * from './navigation.d.ts';
+export type * from './pagination.d.ts';
+export type * from './parallax.d.ts';
+export type * from './scrollbar.d.ts';
+export type * from './thumbs.d.ts';
+export type * from './virtual.d.ts';
+export type * from './zoom.d.ts';
+export type * from './free-mode.d.ts';
+export type * from './grid.d.ts';
+export type * from './manipulation.d.ts';