@gem-sdk/swiper 0.0.7

package/types/modules/scrollbar.d.ts

@@ -0,0 +1,140 @@
+import type { CSSSelector } from '../shared.d.ts';
+import type Swiper from '../swiper-class.d.ts';
+
+export interface ScrollbarMethods {
+  /**
+   * HTMLElement of Scrollbar container element
+   */
+  el: HTMLElement;
+
+  /**
+   * HTMLElement of Scrollbar draggable handler element
+   */
+  dragEl: HTMLElement;
+
+  /**
+   * Updates scrollbar track and handler sizes
+   */
+  updateSize(): void;
+
+  /**
+   * Updates scrollbar translate
+   */
+  setTranslate(): void;
+
+  /**
+   * Initialize scrollbar
+   */
+  init(): void;
+
+  /**
+   * Destroy scrollbar
+   */
+  destroy(): void;
+}
+
+export interface ScrollbarEvents {
+  /**
+   * Event will be fired on draggable scrollbar drag start
+   */
+  scrollbarDragStart: (swiper: Swiper, event: MouseEvent | TouchEvent | PointerEvent) => void;
+
+  /**
+   * Event will be fired on draggable scrollbar drag move
+   */
+  scrollbarDragMove: (swiper: Swiper, event: MouseEvent | TouchEvent | PointerEvent) => void;
+
+  /**
+   * Event will be fired on draggable scrollbar drag end
+   */
+  scrollbarDragEnd: (swiper: Swiper, event: MouseEvent | TouchEvent | PointerEvent) => void;
+}
+
+/**
+ * Object with scrollbar parameters.
+ *
+ * @example
+ * ```js
+ * const swiper = new Swiper('.swiper', {
+ *   scrollbar: {
+ *     el: '.swiper-scrollbar',
+ *     draggable: true,
+ *   },
+ * });
+ * ```
+ */
+export interface ScrollbarOptions {
+  /**
+   * Boolean property to use with breakpoints to enable/disable scrollbar on certain breakpoints
+   */
+  enabled?: boolean;
+  /**
+   * String with CSS selector or HTML element of the container with scrollbar.
+   *
+   * @default null
+   */
+  el?: CSSSelector | HTMLElement | null;
+
+  /**
+   * Hide scrollbar automatically after user interaction
+   *
+   * @default true
+   */
+  hide?: boolean;
+
+  /**
+   * Set to `true` to enable make scrollbar draggable that allows you to control slider position
+   *
+   * @default false
+   */
+  draggable?: boolean;
+
+  /**
+   * Set to `true` to snap slider position to slides when you release scrollbar
+   *
+   * @default false
+   */
+  snapOnRelease?: boolean;
+
+  /**
+   * Size of scrollbar draggable element in px
+   *
+   * @default 'auto'
+   */
+  dragSize?: 'auto' | number;
+
+  /**
+   * Scrollbar element additional CSS class when it is disabled
+   *
+   * @default 'swiper-scrollbar-lock'
+   */
+  lockClass?: string;
+
+  /**
+   * Scrollbar draggable element CSS class
+   *
+   * @default 'swiper-scrollbar-drag'
+   */
+  dragClass?: string;
+
+  /**
+   * CSS class name added on swiper container and scrollbar element when scrollbar is disabled by breakpoint
+   *
+   * @default 'swiper-scrollbar-disabled'
+   */
+  scrollbarDisabledClass?: string;
+
+  /**
+   * CSS class name set to scrollbar in horizontal Swiper
+   *
+   * @default 'swiper-scrollbar-horizontal'
+   */
+  horizontalClass?: string;
+
+  /**
+   * CSS class name set to scrollbar in vertical Swiper
+   *
+   * @default 'swiper-scrollbar-vertical'
+   */
+  verticalClass?: string;
+}

package/types/modules/thumbs.d.ts

@@ -0,0 +1,54 @@
+import type Swiper from '../swiper-class.d.ts';
+
+export interface ThumbsMethods {
+  /**
+   * Swiper instance of thumbs swiper
+   */
+  swiper: Swiper;
+
+  /**
+   * Update thumbs
+   */
+  update(initial: boolean): void;
+
+  /**
+   * Initialize thumbs
+   */
+  init(): boolean;
+}
+
+export interface ThumbsEvents {}
+
+export interface ThumbsOptions {
+  /**
+   * Swiper instance of swiper used as thumbs or object with Swiper parameters to initialize thumbs swiper
+   *
+   * @default null
+   */
+  swiper?: Swiper | string | null;
+  /**
+   * Additional class that will be added to activated thumbs swiper slide
+   *
+   * @default 'swiper-slide-thumb-active'
+   */
+  slideThumbActiveClass?: string;
+  /**
+   * Additional class that will be added to thumbs swiper
+   *
+   * @default 'swiper-thumbs'
+   */
+  thumbsContainerClass?: string;
+  /**
+   * When enabled multiple thumbnail slides may get activated
+   *
+   * @default true
+   */
+  multipleActiveThumbs?: boolean;
+  /**
+   * Allows to set on which thumbs active slide from edge it should automatically move scroll thumbs. For example, if set to 1 and last visible thumb will be activated (1 from edge) it will auto scroll thumbs
+
+   *
+   * @default 0
+   */
+  autoScrollOffset?: number;
+}

package/types/modules/virtual.d.ts

@@ -0,0 +1,135 @@
+export interface VirtualMethods<T = any> {
+  /**
+   * Object with cached slides HTML elements
+   */
+  cache: object;
+
+  /**
+   * Index of first rendered slide
+   */
+  from: number;
+
+  /**
+   * Index of last rendered slide
+   */
+  to: number;
+
+  /**
+   * Array with slide items passed by `virtual.slides` parameter
+   */
+  slides: T[];
+
+  /*
+   * Methods
+   */
+
+  /**
+   * Append slide. `slides` can be a single slide item or array with such slides.
+   *
+   * @note Only for Core version (in React & Vue it should be done by modifying slides array/data/source)
+   */
+  appendSlide(slide: HTMLElement | string | HTMLElement[] | string[]): void;
+
+  /**
+   * Prepend slide. `slides` can be a single slide item or array with such slides.
+   *
+   * @note Only for Core version (in React & Vue it should be done by modifying slides array/data/source)
+   */
+  prependSlide(slide: HTMLElement | string | HTMLElement[] | string[]): void;
+
+  /**
+   * Remove specific slide or slides. `slideIndexes` can be a number with slide index to remove or array with indexes.
+   *
+   * @note Only for Core version (in React & Vue it should be done by modifying slides array/data/source)
+   */
+  removeSlide(slideIndexes: number[]): void;
+
+  /**
+   * Remove all slides
+   *
+   * @note Only for Core version (in React & Vue it should be done by modifying slides array/data/source)
+   */
+  removeAllSlides(): void;
+
+  /**
+   * Update virtual slides state
+   */
+  update(force: boolean): void;
+}
+
+export interface VirtualEvents {}
+
+export interface VirtualData<T> {
+  /**
+   * slides left/top offset in px
+   */
+  offset: number;
+  /**
+   * index of first slide required to be rendered
+   */
+  from: number;
+  /**
+   * index of last slide required to be rendered
+   */
+  to: number;
+  /**
+   * array with slide items to be rendered
+   */
+  slides: T[];
+}
+
+export interface VirtualOptions<T = any> {
+  /**
+   * Whether the virtual slides are enabled
+   *
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * Array with slides
+   *
+   * @default []
+   */
+  slides?: T[];
+  /**
+   * Enables DOM cache of rendering slides html elements. Once they are rendered they will be saved to cache and reused from it.
+   *
+   * @default true
+   */
+  cache?: boolean;
+  /**
+   * Increases amount of pre-rendered slides before active slide
+   *
+   * @default 0
+   */
+  addSlidesBefore?: number;
+  /**
+   * Increases amount of pre-rendered slides after active slide
+   *
+   * @default 0
+   */
+  addSlidesAfter?: number;
+  /**
+   * Function to render slide. As an argument it accepts current slide item for `slides` array and index number of the current slide. Function must return an outer HTML of the swiper slide or slide HTML element.
+   *
+   * @default null
+   */
+  renderSlide?: (slide: T, index: any) => any | null;
+  /**
+   * Function for external rendering (e.g. using some other library to handle DOM manipulations and state like React.js or Vue.js). As an argument it accepts `data` object with the following properties:
+   *
+   * - `offset` - slides left/top offset in px
+   * - `from` - index of first slide required to be rendered
+   * - `to` - index of last slide required to be rendered
+   * - `slides` - array with slide items to be rendered
+   *
+   * @default null
+   */
+  renderExternal?: (data: VirtualData<T>) => any | null;
+  /**
+   * When enabled (by default) it will update Swiper layout right after renderExternal called. Useful to disable and update swiper manually when used with render libraries that renders asynchronously
+   *
+   * @default true
+   */
+  renderExternalUpdate?: boolean;
+}

package/types/modules/zoom.d.ts

@@ -0,0 +1,91 @@
+import type Swiper from '../swiper-class.d.ts';
+
+export interface ZoomMethods {
+  /**
+   * Whether the zoom module is enabled
+   */
+  enabled: boolean;
+
+  /**
+   * Current image scale ratio
+   */
+  scale: number;
+
+  /**
+   * Enable zoom module
+   */
+  enable(): void;
+
+  /**
+   * Disable zoom module
+   */
+  disable(): void;
+
+  /**
+   * Zoom in image of the currently active slide. Optionally accepts custom zoom ratio
+   */
+  in(ratio?: number): void;
+
+  /**
+   * Zoom out image of the currently active slide
+   */
+  out(): void;
+
+  /**
+   * Toggle image zoom of the currently active slide
+   */
+  toggle(event?: MouseEvent | TouchEvent | PointerEvent): void;
+}
+
+export interface ZoomEvents {
+  /**
+   * Event will be fired on zoom change
+   */
+  zoomChange: (swiper: Swiper, scale: number, imageEl: HTMLElement, slideEl: HTMLElement) => void;
+}
+
+export interface ZoomOptions {
+  /**
+   * When set to true, the image will not be scaled past 100% of its original size
+   *
+   * @default false
+   */
+  limitToOriginalSize?: boolean;
+  /**
+   * Maximum image zoom multiplier
+   *
+   * @default 3
+   */
+  maxRatio?: number;
+  /**
+   * Minimal image zoom multiplier
+   *
+   * @default 1
+   */
+  minRatio?: number;
+  /**
+   * When set to true, a zoomed in image will automatically pan while moving the mouse over the image
+   *
+   * @default false
+   */
+  panOnMouseMove?: boolean;
+  /**
+   * Enable/disable zoom-in by slide's double tap
+   *
+   * @default true
+   */
+  toggle?: boolean;
+  /**
+   * CSS class name of zoom container
+   *
+   * @default 'swiper-zoom-container'
+   */
+  containerClass?: string;
+  /**
+   * CSS class name of zoomed in container
+   *
+   * @default 'swiper-slide-zoomed'
+
+   */
+  zoomedSlideClass?: string;
+}

package/types/shared.d.ts

@@ -0,0 +1,13 @@
+import type { Swiper } from './index.d.ts';
+
+export interface CSSSelector extends String {}
+
+export type SwiperModule = (options: {
+  params: Swiper['params'];
+  swiper: Swiper;
+  extendParams: (obj: { [name: string]: any }) => void;
+  on: Swiper['on'];
+  once: Swiper['once'];
+  off: Swiper['off'];
+  emit: Swiper['emit'];
+}) => void;