@gem-sdk/swiper 0.0.7

package/types/modules/autoplay.d.ts

@@ -0,0 +1,133 @@
+import type Swiper from '../swiper-class.d.ts';
+
+export interface AutoplayMethods {
+  /**
+   * Whether autoplay enabled and running
+   */
+  running: boolean;
+
+  /**
+   * Whether autoplay is paused
+   */
+  paused: boolean;
+
+  /**
+   * If autoplay is paused, it contains time left (in ms) before transition to next slide
+   */
+  timeLeft: number;
+
+  /**
+   * Pause autoplay
+   */
+  pause(): void;
+
+  /**
+   * Resume autoplay
+   */
+  resume(): void;
+
+  /**
+   * Start autoplay
+   */
+  start(): boolean;
+
+  /**
+   * Stop autoplay
+   */
+  stop(): boolean;
+}
+
+export interface AutoplayEvents {
+  /**
+   * Event will be fired in when autoplay started
+   */
+  autoplayStart: (swiper: Swiper) => void;
+  /**
+   * Event will be fired when autoplay stopped
+   */
+  autoplayStop: (swiper: Swiper) => void;
+  /**
+   * Event will be fired on autoplay pause
+   */
+  autoplayPause: (swiper: Swiper) => void;
+  /**
+   * Event will be fired on autoplay resume
+   */
+  autoplayResume: (swiper: Swiper) => void;
+  /**
+   * Event triggers continuously while autoplay is enabled. It contains time left (in ms) before transition to next slide and percentage of that time related to autoplay delay
+   */
+  autoplayTimeLeft: (swiper: Swiper, timeLeft: number, percentage: number) => void;
+  /**
+   * Event will be fired when slide changed with autoplay
+   */
+  autoplay: (swiper: Swiper) => void;
+}
+
+/**
+ * Object with autoplay parameters or boolean `true` to enable with default settings.
+ *
+ * @example
+ * ```js
+ * const swiper = new Swiper('.swiper', {
+ *   autoplay: {
+ *     delay: 5000,
+ *   },
+ * });
+ * ```
+ */
+export interface AutoplayOptions {
+  /**
+   * Delay between transitions (in ms). If this parameter is not specified, auto play will be disabled
+   *
+   * If you need to specify different delay for specific slides you can do it by using
+   * `data-swiper-autoplay` (in ms) attribute on slide.
+   *
+   * @example
+   * ```html
+   * <!-- hold this slide for 2 seconds -->
+   * <div class="swiper-slide" data-swiper-autoplay="2000">
+   * ```
+   *
+   * @default 3000
+   */
+  delay?: number;
+
+  /**
+   * Enable this parameter and autoplay will be stopped when it reaches last slide (has no effect in loop mode)
+   *
+   * @default false
+   */
+  stopOnLastSlide?: boolean;
+
+  /**
+   * Set to `false` and autoplay will not be disabled after user interactions (swipes),
+   * it will be restarted every time after interaction
+   *
+   * @default true
+   */
+  disableOnInteraction?: boolean;
+
+  /**
+   * Enables autoplay in reverse direction
+   *
+   * @default false
+   */
+  reverseDirection?: boolean;
+
+  /**
+   * When enabled autoplay will wait for wrapper transition to continue.
+   * Can be disabled in case of using Virtual Translate when your
+   * slider may not have transition
+   *
+   * @default true
+   */
+  waitForTransition?: boolean;
+
+  /**
+   * When enabled autoplay will be paused on pointer (mouse) enter over Swiper container.
+   *
+   * @default false
+   */
+  pauseOnMouseEnter?: boolean;
+}

package/types/modules/controller.d.ts

@@ -0,0 +1,35 @@
+import type Swiper from '../swiper-class.d.ts';
+
+export interface ControllerMethods {
+  /**
+   * Pass here another Swiper instance or array with Swiper instances that should be controlled
+   * by this Swiper
+   */
+  control?: Swiper | Swiper[];
+}
+
+export interface ControllerEvents {}
+
+export interface ControllerOptions {
+  /**
+   * Pass here another Swiper instance or array with Swiper instances that should be controlled
+   * by this Swiper. Also accepts string with CSS selector of Swiper element, or HTMLElement of Swiper element
+   */
+  control?: Swiper | Swiper[] | string | HTMLElement | null;
+
+  /**
+   * Set to `true` and controlling will be in inverse direction
+   *
+   * @default false
+   */
+  inverse?: boolean;
+
+  /**
+   * Defines a way how to control another slider: slide by slide
+   * (with respect to other slider's grid) or depending on all slides/container
+   * (depending on total slider percentage).
+   *
+   * @default 'slide'
+   */
+  by?: 'slide' | 'container';
+}

package/types/modules/effect-cards.d.ts

@@ -0,0 +1,33 @@
+export interface CardsEffectMethods {}
+
+export interface CardsEffectEvents {}
+
+export interface CardsEffectOptions {
+  /**
+   * Enables slides shadows
+   *
+   * @default true
+   */
+  slideShadows?: boolean;
+
+  /**
+   * Enables cards rotation
+   *
+   * @default true
+   */
+  rotate?: boolean;
+
+  /**
+   * Rotate angle per slide (in degrees)
+   *
+   * @default 2
+   */
+  perSlideRotate?: number;
+
+  /**
+   * Offset distance per slide (in px)
+   *
+   * @default 8
+   */
+  perSlideOffset?: number;
+}

package/types/modules/effect-coverflow.d.ts

@@ -0,0 +1,45 @@
+export interface CoverflowEffectMethods {}
+
+export interface CoverflowEffectEvents {}
+
+export interface CoverflowEffectOptions {
+  /**
+   * Enables slides shadows
+   *
+   * @default true
+   */
+  slideShadows?: boolean;
+  /**
+   * Slide rotate in degrees
+   *
+   * @default 50
+   */
+  rotate?: number;
+  /**
+   * Stretch space between slides
+   *
+   * - a number is interpreted as pixels (e.g., `20` for 20px).
+   * - a string with a percentage (e.g., `"50%"`).
+   *
+   * @default 0
+   */
+  stretch?: number | `${number}%`;
+  /**
+   * Depth offset in px (slides translate in Z axis)
+   *
+   * @default 100
+   */
+  depth?: number;
+  /**
+   * Slide scale effect
+   *
+   * @default 1
+   */
+  scale?: number;
+  /**
+   * Effect multiplier
+   *
+   * @default 1
+   */
+  modifier?: number;
+}

package/types/modules/effect-creative.d.ts

@@ -0,0 +1,86 @@
+interface CreativeEffectTransform {
+  translate?: (string | number)[];
+  rotate?: number[];
+  opacity?: number;
+  scale?: number;
+  shadow?: boolean;
+  origin?: string;
+}
+
+export interface CreativeEffectMethods {}
+
+export interface CreativeEffectEvents {}
+
+export interface CreativeEffectOptions {
+  /**
+   * Previous slide transformations. Accepts object of the following type:
+   *
+   * @example
+   * ```js
+   * {
+   *   // Array with translate X, Y and Z values
+   *   translate: (string | number)[];
+   *   // Array with rotate X, Y and Z values (in deg)
+   *   rotate?: number[];
+   *   // Slide opacity
+   *   opacity?: number;
+   *   // Slide scale
+   *   scale?: number;
+   *   // Enables slide shadow
+   *   shadow?: boolean;
+   *   // Transform origin, e.g. `left bottom`
+   *   origin?: string;
+   * }
+   * ```
+   *
+   */
+  prev?: CreativeEffectTransform;
+  /**
+   * Next slide transformations.
+   *
+   * @example
+   * ```js
+   * {
+   *   // Array with translate X, Y and Z values
+   *   translate: (string | number)[];
+   *   // Array with rotate X, Y and Z values (in deg)
+   *   rotate?: number[];
+   *   // Slide opacity
+   *   opacity?: number;
+   *   // Slide scale
+   *   scale?: number;
+   *   // Enables slide shadow
+   *   shadow?: boolean;
+   *   // Transform origin, e.g. `left bottom`
+   *   origin?: string;
+   * }
+   * ```
+   *
+   */
+  next?: CreativeEffectTransform;
+
+  /**
+   * Limit progress/offset to amount of side slides. If `1`, then slides all slides after prev/next will have same state. If `2`, then all slides after 2nd before/after active will have same state, etc.
+   *
+   * @default 1
+   */
+  limitProgress?: number;
+  /**
+   * Splits shadow "opacity" per slide based on `limitProgress` (only if transformation shadows enabled). E.g. setting `limitProgress: 2` and enabling `shadowPerProgress`, will set shadow opacity to `0.5` and `1` on two slides next to active. With this parameter disabled, all slides beside active will have shadow with `1` opacity
+   *
+   * @default false
+   */
+  shadowPerProgress?: boolean;
+  /**
+   * Allows to multiply slides transformations and opacity.
+   *
+   * @default 1
+   */
+  progressMultiplier?: number;
+  /**
+   * Enable this parameter if your custom transforms require 3D transformations (`translateZ`, `rotateX`, `rotateY` )
+   *
+   * @default true
+   */
+  perspective?: boolean;
+}

package/types/modules/effect-cube.d.ts

@@ -0,0 +1,30 @@
+export interface CubeEffectMethods {}
+
+export interface CubeEffectEvents {}
+
+export interface CubeEffectOptions {
+  /**
+   * Enables slides shadows
+   *
+   * @default true
+   */
+  slideShadows?: boolean;
+  /**
+   * Enables main slider shadow
+   *
+   * @default true
+   */
+  shadow?: boolean;
+  /**
+   * Main shadow offset in px
+   *
+   * @default 20
+   */
+  shadowOffset?: number;
+  /**
+   * Main shadow scale ratio
+   *
+   * @default 0.94
+   */
+  shadowScale?: number;
+}

package/types/modules/effect-fade.d.ts

@@ -0,0 +1,12 @@
+export interface FadeEffectMethods {}
+
+export interface FadeEffectEvents {}
+
+export interface FadeEffectOptions {
+  /**
+   * Enables slides cross fade
+   *
+   * @default false
+   */
+  crossFade?: boolean;
+}

package/types/modules/effect-flip.d.ts

@@ -0,0 +1,18 @@
+export interface FlipEffectMethods {}
+
+export interface FlipEffectEvents {}
+
+export interface FlipEffectOptions {
+  /**
+   * Enables slides shadows
+   *
+   * @default true
+   */
+  slideShadows?: boolean;
+  /**
+   * Limit edge slides rotation
+   *
+   * @default true
+   */
+  limitRotation?: boolean;
+}

package/types/modules/free-mode.d.ts

@@ -0,0 +1,64 @@
+export interface FreeModeMethods {
+  onTouchMove(): void;
+  onTouchEnd(): void;
+}
+
+export interface FreeModeEvents {}
+
+export interface FreeModeOptions {
+  /**
+   * Whether the free mode is enabled
+   *
+   * @default false
+   */
+  enabled?: boolean;
+
+  /**
+   * If enabled, then slide will keep moving for a while after you release it
+   *
+   * @default true
+   */
+  momentum?: boolean;
+
+  /**
+   * Higher value produces larger momentum distance after you release slider
+   *
+   * @default 1
+   */
+  momentumRatio?: number;
+
+  /**
+   * Higher value produces larger momentum velocity after you release slider
+   *
+   * @default 1
+   */
+  momentumVelocityRatio?: number;
+
+  /**
+   * Set to `false` if you want to disable momentum bounce in free mode
+   *
+   * @default true
+   */
+  momentumBounce?: boolean;
+
+  /**
+   * Higher value produces larger momentum bounce effect
+   *
+   * @default 1
+   */
+  momentumBounceRatio?: number;
+
+  /**
+   * Minimum touchmove-velocity required to trigger free mode momentum
+   *
+   * @default 0.02
+   */
+  minimumVelocity?: number;
+
+  /**
+   * Set to enabled to enable snap to slides positions in free mode
+   *
+   * @default false
+   */
+  sticky?: boolean;
+}

package/types/modules/grid.d.ts

@@ -0,0 +1,21 @@
+export interface GridMethods {}
+
+export interface GridEvents {}
+
+export interface GridOptions {
+  /**
+   * Number of slides rows, for multirow layout
+   *
+   * @default 1
+   */
+  rows?: number;
+
+  /**
+   * Can be `'column'` or `'row'`. Defines how slides should fill rows, by column or by row
+   *
+   * @note if used with loop mode make sure number of slides is even specified in loop mode requirements, or enable `loopAddBlankSlides` parameter
+   *
+   * @default 'column'
+   */
+  fill?: 'row' | 'column';
+}

package/types/modules/hash-navigation.d.ts

@@ -0,0 +1,38 @@
+import type Swiper from '../swiper-class.d.ts';
+
+export interface HashNavigationMethods {}
+
+export interface HashNavigationEvents {
+  /**
+   * Event will be fired on window hash change
+   */
+  hashChange: (swiper: Swiper) => void;
+  /**
+   * Event will be fired when swiper updates the hash
+   */
+  hashSet: (swiper: Swiper) => void;
+}
+
+export interface HashNavigationOptions {
+  /**
+   * Set to `true` to enable also navigation through slides (when hashnav
+   * is enabled) by browser history or by setting directly hash on document location
+   *
+   * @default false
+   */
+  watchState?: boolean;
+
+  /**
+   * Works in addition to hashnav to replace current url state with the
+   * new one instead of adding it to history
+   *
+   * @default     false
+   */
+  replaceState?: boolean;
+
+  /**
+   * Designed to be used with Virtual slides when it is impossible to find slide in DOM by hash (e.g. not yet rendered)
+   *
+   */
+  getSlideIndex?: (swiper: Swiper, hash: string) => number;
+}

package/types/modules/history.d.ts

@@ -0,0 +1,43 @@
+export interface HistoryMethods {}
+
+export interface HistoryEvents {}
+
+export interface HistoryOptions {
+  /**
+   * Enables History Plugin.
+   *
+   * @default false
+   */
+  enabled?: boolean;
+
+  /**
+   * Swiper page root, useful to specify when you use Swiper history mode not on root website page.
+   * For example can be `https://my-website.com/` or `https://my-website.com/subpage/` or `/subpage/`
+   *
+   *
+   * @default ''
+   */
+  root?: string;
+
+  /**
+   * Works in addition to hashnav or history to replace current url state with the
+   * new one instead of adding it to history
+   *
+   * @default false
+   */
+  replaceState?: boolean;
+
+  /**
+   * Url key for slides
+   *
+   * @default 'slides'
+   */
+  key?: string;
+
+  /**
+   * Keep query parameters when changing browser url.
+   *
+   * @default false
+   */
+  keepQuery?: boolean;
+}

package/types/modules/index.d.ts

@@ -0,0 +1,51 @@
+import type { SwiperModule } from '../shared.d.ts';
+
+declare const A11y: SwiperModule;
+declare const Autoplay: SwiperModule;
+declare const Controller: SwiperModule;
+declare const EffectCoverflow: SwiperModule;
+declare const EffectCube: SwiperModule;
+declare const EffectFade: SwiperModule;
+declare const EffectFlip: SwiperModule;
+declare const EffectCreative: SwiperModule;
+declare const EffectCards: SwiperModule;
+declare const HashNavigation: SwiperModule;
+declare const History: SwiperModule;
+declare const Keyboard: SwiperModule;
+declare const Mousewheel: SwiperModule;
+declare const Navigation: SwiperModule;
+declare const Pagination: SwiperModule;
+declare const Parallax: SwiperModule;
+declare const Scrollbar: SwiperModule;
+declare const Thumbs: SwiperModule;
+declare const Virtual: SwiperModule;
+declare const Zoom: SwiperModule;
+declare const FreeMode: SwiperModule;
+declare const Grid: SwiperModule;
+declare const Manipulation: SwiperModule;
+
+export {
+  A11y,
+  Autoplay,
+  Controller,
+  EffectCoverflow,
+  EffectCube,
+  EffectFade,
+  EffectFlip,
+  EffectCreative,
+  EffectCards,
+  HashNavigation,
+  History,
+  Keyboard,
+  Mousewheel,
+  Navigation,
+  Pagination,
+  Parallax,
+  Scrollbar,
+  Thumbs,
+  Virtual,
+  Zoom,
+  FreeMode,
+  Grid,
+  Manipulation,
+};

package/types/modules/keyboard.d.ts

@@ -0,0 +1,46 @@
+import type Swiper from '../swiper-class.d.ts';
+
+export interface KeyboardMethods {
+  /**
+   * Whether the keyboard control is enabled
+   */
+  enabled: boolean;
+
+  /**
+   * Enable keyboard control
+   */
+  enable(): void;
+
+  /**
+   * Disable keyboard control
+   */
+  disable(): void;
+}
+
+export interface KeyboardEvents {
+  /**
+   * Event will be fired on key press
+   */
+  keyPress: (swiper: Swiper, keyCode: string) => void;
+}
+
+export interface KeyboardOptions {
+  /**
+   * Set to `true` to enable keyboard control
+   *
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * When enabled it will control sliders that are currently in viewport
+   *
+   * @default true
+   */
+  onlyInViewport?: boolean;
+  /**
+   * When enabled it will enable keyboard navigation by Page Up and Page Down keys
+   *
+   * @default true
+   */
+  pageUpDown?: boolean;
+}