Interface SwiperProps

interface SwiperProps {
    _emitClasses?: boolean;
    _loopSwapReset?: boolean;
    a11y?: boolean | A11yOptions;
    about?: string;
    accessKey?: string;
    allowSlideNext?: boolean;
    allowSlidePrev?: boolean;
    allowTouchMove?: boolean;
    "aria-activedescendant"?: string;
    "aria-atomic"?: Booleanish;
    "aria-autocomplete"?: "none" | "list" | "inline" | "both";
    "aria-braillelabel"?: string;
    "aria-brailleroledescription"?: string;
    "aria-busy"?: Booleanish;
    "aria-checked"?: boolean | "true" | "false" | "mixed";
    "aria-colcount"?: number;
    "aria-colindex"?: number;
    "aria-colindextext"?: string;
    "aria-colspan"?: number;
    "aria-controls"?: string;
    "aria-current"?:
        | boolean
        | "time"
        | "true"
        | "false"
        | "page"
        | "step"
        | "location"
        | "date";
    "aria-describedby"?: string;
    "aria-description"?: string;
    "aria-details"?: string;
    "aria-disabled"?: Booleanish;
    "aria-dropeffect"?: "copy"
    | "link"
    | "none"
    | "execute"
    | "move"
    | "popup";
    "aria-errormessage"?: string;
    "aria-expanded"?: Booleanish;
    "aria-flowto"?: string;
    "aria-grabbed"?: Booleanish;
    "aria-haspopup"?:
        | boolean
        | "dialog"
        | "menu"
        | "true"
        | "false"
        | "grid"
        | "listbox"
        | "tree";
    "aria-hidden"?: Booleanish;
    "aria-invalid"?: boolean
    | "true"
    | "false"
    | "grammar"
    | "spelling";
    "aria-keyshortcuts"?: string;
    "aria-label"?: string;
    "aria-labelledby"?: string;
    "aria-level"?: number;
    "aria-live"?: "off" | "assertive" | "polite";
    "aria-modal"?: Booleanish;
    "aria-multiline"?: Booleanish;
    "aria-multiselectable"?: Booleanish;
    "aria-orientation"?: "horizontal" | "vertical";
    "aria-owns"?: string;
    "aria-placeholder"?: string;
    "aria-posinset"?: number;
    "aria-pressed"?: boolean | "true" | "false" | "mixed";
    "aria-readonly"?: Booleanish;
    "aria-relevant"?:
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "all"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals";
    "aria-required"?: Booleanish;
    "aria-roledescription"?: string;
    "aria-rowcount"?: number;
    "aria-rowindex"?: number;
    "aria-rowindextext"?: string;
    "aria-rowspan"?: number;
    "aria-selected"?: Booleanish;
    "aria-setsize"?: number;
    "aria-sort"?: "none"
    | "ascending"
    | "descending"
    | "other";
    "aria-valuemax"?: number;
    "aria-valuemin"?: number;
    "aria-valuenow"?: number;
    "aria-valuetext"?: string;
    autoCapitalize?:
        | string & {}
        | "off"
        | "none"
        | "on"
        | "sentences"
        | "words"
        | "characters";
    autoCorrect?: string;
    autoFocus?: boolean;
    autoHeight?: boolean;
    autoplay?: boolean
    | AutoplayOptions;
    autoSave?: string;
    breakpoints?: {
        [width: number]: SwiperOptions;
        [ratio: string]: SwiperOptions;
    };
    breakpointsBase?: "container"
    | CSSSelector
    | "window";
    cardsEffect?: CardsEffectOptions;
    centeredSlides?: boolean;
    centeredSlidesBounds?: boolean;
    centerInsufficientSlides?: boolean;
    children?: ReactNode;
    className?: string;
    color?: string;
    containerModifierClass?: string;
    content?: string;
    contentEditable?: Booleanish | "inherit" | "plaintext-only";
    contextMenu?: string;
    controller?: boolean | ControllerOptions;
    coverflowEffect?: CoverflowEffectOptions;
    createElements?: boolean;
    creativeEffect?: CreativeEffectOptions;
    cssMode?: boolean;
    cubeEffect?: CubeEffectOptions;
    dangerouslySetInnerHTML?: { __html: string | TrustedHTML };
    datatype?: string;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    dir?: string;
    direction?: "horizontal" | "vertical";
    draggable?: Booleanish;
    edgeSwipeDetection?: string | boolean;
    edgeSwipeThreshold?: number;
    effect?:
        | "slide"
        | "fade"
        | "cube"
        | "coverflow"
        | "flip"
        | "creative"
        | "cards"
        | string & {};
    enabled?: boolean;
    enterKeyHint?: | "search"
    | "enter"
    | "done"
    | "go"
    | "next"
    | "previous"
    | "send";
    eventsPrefix?: string;
    exportparts?: string;
    fadeEffect?: FadeEffectOptions;
    flipEffect?: FlipEffectOptions;
    focusableElements?: string;
    followFinger?: boolean;
    freeMode?: boolean
    | FreeModeOptions;
    grabCursor?: boolean;
    grid?: GridOptions;
    hashNavigation?: boolean | HashNavigationOptions;
    height?: number | null;
    hidden?: boolean;
    history?: boolean | HistoryOptions;
    id?: string;
    inert?: boolean;
    init?: boolean;
    initialSlide?: number;
    injectStyles?: string[];
    injectStylesUrls?: string[];
    inlist?: any;
    inputMode?:
        | "search"
        | "text"
        | "none"
        | "tel"
        | "url"
        | "email"
        | "numeric"
        | "decimal";
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    keyboard?: boolean
    | KeyboardOptions;
    lang?: string;
    lazyPreloaderClass?: string;
    lazyPreloadPrevNext?: number;
    longSwipes?: boolean;
    longSwipesMs?: number;
    longSwipesRatio?: number;
    loop?: boolean;
    loopAddBlankSlides?: boolean;
    loopAdditionalSlides?: number;
    loopPreventsSliding?: boolean;
    maxBackfaceHiddenSlides?: number;
    modules?: SwiperModule[];
    mousewheel?: boolean | MousewheelOptions;
    navigation?: boolean | NavigationOptions;
    nested?: boolean;
    nonce?: string;
    normalizeSlideIndex?: boolean;
    noSwiping?: boolean;
    noSwipingClass?: string;
    noSwipingSelector?: string;
    observeParents?: boolean;
    observer?: boolean;
    observeSlideChildren?: boolean;
    on?: {
        _beforeBreakpoint?: (
            swiper: Swiper,
            breakpointParams: SwiperOptions,
        ) => void;
        _containerClasses?: (swiper: Swiper, classNames: string) => void;
        _freeModeNoMomentumRelease?: (swiper: Swiper) => void;
        _freeModeStaticRelease?: () => void;
        _slideClass?: (
            swiper: Swiper,
            slideEl: HTMLElement,
            classNames: string,
        ) => void;
        _slideClasses?: (
            swiper: Swiper,
            slides: { classNames: string; index: number; slideEl: HTMLElement }[],
        ) => void;
        _swiper?: (swiper: Swiper) => void;
        activeIndexChange?: (swiper: Swiper) => void;
        afterInit?: (swiper: Swiper) => void;
        autoplay?: (swiper: Swiper) => void;
        autoplayPause?: (swiper: Swiper) => void;
        autoplayResume?: (swiper: Swiper) => void;
        autoplayStart?: (swiper: Swiper) => void;
        autoplayStop?: (swiper: Swiper) => void;
        autoplayTimeLeft?: (
            swiper: Swiper,
            timeLeft: number,
            percentage: number,
        ) => void;
        beforeDestroy?: (swiper: Swiper) => void;
        beforeInit?: (swiper: Swiper) => void;
        beforeLoopFix?: (swiper: Swiper) => void;
        beforeResize?: (swiper: Swiper) => void;
        beforeSlideChangeStart?: (swiper: Swiper) => void;
        beforeTransitionStart?: (
            swiper: Swiper,
            speed: number,
            internal: unknown,
        ) => void;
        breakpoint?: (swiper: Swiper, breakpointParams: SwiperOptions) => void;
        changeDirection?: (swiper: Swiper) => void;
        click?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        destroy?: (swiper: Swiper) => void;
        doubleClick?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        doubleTap?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        fromEdge?: (swiper: Swiper) => void;
        hashChange?: (swiper: Swiper) => void;
        hashSet?: (swiper: Swiper) => void;
        init?: (swiper: Swiper) => any;
        keyPress?: (swiper: Swiper, keyCode: string) => void;
        lock?: (swiper: Swiper) => void;
        loopFix?: (swiper: Swiper) => void;
        momentumBounce?: (swiper: Swiper) => void;
        navigationHide?: (swiper: Swiper) => void;
        navigationNext?: (swiper: Swiper) => void;
        navigationPrev?: (swiper: Swiper) => void;
        navigationShow?: (swiper: Swiper) => void;
        observerUpdate?: (swiper: Swiper) => void;
        orientationchange?: (swiper: Swiper) => void;
        paginationHide?: (swiper: Swiper) => void;
        paginationRender?: (swiper: Swiper, paginationEl: HTMLElement) => void;
        paginationShow?: (swiper: Swiper) => void;
        paginationUpdate?: (swiper: Swiper, paginationEl: HTMLElement) => void;
        progress?: (swiper: Swiper, progress: number) => void;
        reachBeginning?: (swiper: Swiper) => void;
        reachEnd?: (swiper: Swiper) => void;
        realIndexChange?: (swiper: Swiper) => void;
        resize?: (swiper: Swiper) => void;
        scroll?: (swiper: Swiper, event: WheelEvent) => void;
        scrollbarDragEnd?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        scrollbarDragMove?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        scrollbarDragStart?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        setTransition?: (
            swiper: Swiper,
            transition: number,
            byController?: boolean | Swiper,
        ) => void;
        setTranslate?: (
            swiper: Swiper,
            translate: number,
            byController?: boolean | Swiper,
        ) => void;
        slideChange?: (swiper: Swiper) => void;
        slideChangeTransitionEnd?: (swiper: Swiper) => void;
        slideChangeTransitionStart?: (swiper: Swiper) => void;
        slideNextTransitionEnd?: (swiper: Swiper) => void;
        slideNextTransitionStart?: (swiper: Swiper) => void;
        slidePrevTransitionEnd?: (swiper: Swiper) => void;
        slidePrevTransitionStart?: (swiper: Swiper) => void;
        slideResetTransitionEnd?: (swiper: Swiper) => void;
        slideResetTransitionStart?: (swiper: Swiper) => void;
        sliderFirstMove?: (swiper: Swiper, event: TouchEvent) => void;
        sliderMove?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        slidesGridLengthChange?: (swiper: Swiper) => void;
        slidesLengthChange?: (swiper: Swiper) => void;
        slidesUpdated?: (swiper: Swiper) => void;
        snapGridLengthChange?: (swiper: Swiper) => void;
        snapIndexChange?: (swiper: Swiper) => void;
        tap?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        toEdge?: (swiper: Swiper) => void;
        touchEnd?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        touchMove?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        touchMoveOpposite?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        touchStart?: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        transitionEnd?: (swiper: Swiper) => void;
        transitionStart?: (swiper: Swiper) => void;
        unlock?: (swiper: Swiper) => void;
        update?: (swiper: Swiper) => void;
        virtualUpdate?: (swiper: Swiper) => void;
        zoomChange?: (
            swiper: Swiper,
            scale: number,
            imageEl: HTMLElement,
            slideEl: HTMLElement,
        ) => void;
    };
    onAbort?: ReactEventHandler<HTMLElement>;
    onAbortCapture?: ReactEventHandler<HTMLElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
    onAnimationStart?: AnimationEventHandler<HTMLElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
    onAuxClick?: MouseEventHandler<HTMLElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLElement>;
    onBeforeInput?: InputEventHandler<HTMLElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLElement>;
    onBeforeToggle?: ToggleEventHandler<HTMLElement>;
    onBlur?: FocusEventHandler<HTMLElement>;
    onBlurCapture?: FocusEventHandler<HTMLElement>;
    onCanPlay?: ReactEventHandler<HTMLElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>;
    onChange?: FormEventHandler<HTMLElement>;
    onChangeCapture?: FormEventHandler<HTMLElement>;
    onClickCapture?: MouseEventHandler<HTMLElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionStart?: CompositionEventHandler<HTMLElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>;
    onContextMenu?: MouseEventHandler<HTMLElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLElement>;
    onCopy?: ClipboardEventHandler<HTMLElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLElement>;
    onCut?: ClipboardEventHandler<HTMLElement>;
    onCutCapture?: ClipboardEventHandler<HTMLElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
    onDrag?: DragEventHandler<HTMLElement>;
    onDragCapture?: DragEventHandler<HTMLElement>;
    onDragEnd?: DragEventHandler<HTMLElement>;
    onDragEndCapture?: DragEventHandler<HTMLElement>;
    onDragEnter?: DragEventHandler<HTMLElement>;
    onDragEnterCapture?: DragEventHandler<HTMLElement>;
    onDragExit?: DragEventHandler<HTMLElement>;
    onDragExitCapture?: DragEventHandler<HTMLElement>;
    onDragLeave?: DragEventHandler<HTMLElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLElement>;
    onDragOver?: DragEventHandler<HTMLElement>;
    onDragOverCapture?: DragEventHandler<HTMLElement>;
    onDragStart?: DragEventHandler<HTMLElement>;
    onDragStartCapture?: DragEventHandler<HTMLElement>;
    onDrop?: DragEventHandler<HTMLElement>;
    onDropCapture?: DragEventHandler<HTMLElement>;
    onDurationChange?: ReactEventHandler<HTMLElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLElement>;
    onEmptied?: ReactEventHandler<HTMLElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLElement>;
    onEncrypted?: ReactEventHandler<HTMLElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLElement>;
    onEnded?: ReactEventHandler<HTMLElement>;
    onEndedCapture?: ReactEventHandler<HTMLElement>;
    onError?: ReactEventHandler<HTMLElement>;
    onErrorCapture?: ReactEventHandler<HTMLElement>;
    oneWayMovement?: boolean;
    onFocus?: FocusEventHandler<HTMLElement>;
    onFocusCapture?: FocusEventHandler<HTMLElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onInput?: FormEventHandler<HTMLElement>;
    onInputCapture?: FormEventHandler<HTMLElement>;
    onInvalid?: FormEventHandler<HTMLElement>;
    onInvalidCapture?: FormEventHandler<HTMLElement>;
    onKeyDown?: KeyboardEventHandler<HTMLElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLElement>;
    onKeyUp?: KeyboardEventHandler<HTMLElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLElement>;
    onLoad?: ReactEventHandler<HTMLElement>;
    onLoadCapture?: ReactEventHandler<HTMLElement>;
    onLoadedData?: ReactEventHandler<HTMLElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>;
    onLoadStart?: ReactEventHandler<HTMLElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
    onMouseDown?: MouseEventHandler<HTMLElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLElement>;
    onMouseEnter?: MouseEventHandler<HTMLElement>;
    onMouseLeave?: MouseEventHandler<HTMLElement>;
    onMouseMove?: MouseEventHandler<HTMLElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
    onMouseOut?: MouseEventHandler<HTMLElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLElement>;
    onMouseOver?: MouseEventHandler<HTMLElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLElement>;
    onMouseUp?: MouseEventHandler<HTMLElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLElement>;
    onPaste?: ClipboardEventHandler<HTMLElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLElement>;
    onPause?: ReactEventHandler<HTMLElement>;
    onPauseCapture?: ReactEventHandler<HTMLElement>;
    onPlay?: ReactEventHandler<HTMLElement>;
    onPlayCapture?: ReactEventHandler<HTMLElement>;
    onPlaying?: ReactEventHandler<HTMLElement>;
    onPlayingCapture?: ReactEventHandler<HTMLElement>;
    onPointerCancel?: PointerEventHandler<HTMLElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
    onPointerDown?: PointerEventHandler<HTMLElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLElement>;
    onPointerEnter?: PointerEventHandler<HTMLElement>;
    onPointerLeave?: PointerEventHandler<HTMLElement>;
    onPointerMove?: PointerEventHandler<HTMLElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
    onPointerOut?: PointerEventHandler<HTMLElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLElement>;
    onPointerOver?: PointerEventHandler<HTMLElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLElement>;
    onPointerUp?: PointerEventHandler<HTMLElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLElement>;
    onProgressCapture?: ReactEventHandler<HTMLElement>;
    onRateChange?: ReactEventHandler<HTMLElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLElement>;
    onReset?: FormEventHandler<HTMLElement>;
    onResetCapture?: FormEventHandler<HTMLElement>;
    onScrollCapture?: UIEventHandler<HTMLElement>;
    onScrollEnd?: UIEventHandler<HTMLElement>;
    onScrollEndCapture?: UIEventHandler<HTMLElement>;
    onSeeked?: ReactEventHandler<HTMLElement>;
    onSeekedCapture?: ReactEventHandler<HTMLElement>;
    onSeeking?: ReactEventHandler<HTMLElement>;
    onSeekingCapture?: ReactEventHandler<HTMLElement>;
    onSelect?: ReactEventHandler<HTMLElement>;
    onSelectCapture?: ReactEventHandler<HTMLElement>;
    onStalled?: ReactEventHandler<HTMLElement>;
    onStalledCapture?: ReactEventHandler<HTMLElement>;
    onSubmit?: FormEventHandler<HTMLElement>;
    onSubmitCapture?: FormEventHandler<HTMLElement>;
    onSuspend?: ReactEventHandler<HTMLElement>;
    onSuspendCapture?: ReactEventHandler<HTMLElement>;
    onSwiper?: (swiper: Swiper) => void;
    onTimeUpdate?: ReactEventHandler<HTMLElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLElement>;
    onToggle?: ToggleEventHandler<HTMLElement>;
    onTouchCancel?: TouchEventHandler<HTMLElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLElement>;
    onTransitionCancel?: TransitionEventHandler<HTMLElement>;
    onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionRun?: TransitionEventHandler<HTMLElement>;
    onTransitionRunCapture?: TransitionEventHandler<HTMLElement>;
    onTransitionStart?: TransitionEventHandler<HTMLElement>;
    onTransitionStartCapture?: TransitionEventHandler<HTMLElement>;
    onVolumeChange?: ReactEventHandler<HTMLElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLElement>;
    onWaiting?: ReactEventHandler<HTMLElement>;
    onWaitingCapture?: ReactEventHandler<HTMLElement>;
    onWheel?: WheelEventHandler<HTMLElement>;
    onWheelCapture?: WheelEventHandler<HTMLElement>;
    pagination?: boolean | PaginationOptions;
    parallax?: boolean | ParallaxOptions;
    part?: string;
    passiveListeners?: boolean;
    popover?: "" | "auto" | "manual" | "hint";
    popoverTarget?: string;
    popoverTargetAction?: "toggle" | "show" | "hide";
    prefix?: string;
    preventClicks?: boolean;
    preventClicksPropagation?: boolean;
    preventInteractionOnTransition?: boolean;
    property?: string;
    radioGroup?: string;
    rel?: string;
    resistance?: boolean;
    resistanceRatio?: number;
    resizeObserver?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    rewind?: boolean;
    role?: AriaRole;
    roundLengths?: boolean;
    runCallbacksOnInit?: boolean;
    scrollbar?: boolean | ScrollbarOptions;
    security?: string;
    setWrapperSize?: boolean;
    shortSwipes?: boolean;
    simulateTouch?: boolean;
    slideActiveClass?: string;
    slideBlankClass?: string;
    slideClass?: string;
    slideFullyVisibleClass?: string;
    slideNextClass?: string;
    slidePrevClass?: string;
    slidesOffsetAfter?: number;
    slidesOffsetBefore?: number;
    slidesPerGroup?: number;
    slidesPerGroupAuto?: boolean;
    slidesPerGroupSkip?: number;
    slidesPerView?: number | "auto";
    slideToClickedSlide?: boolean;
    slideVisibleClass?: string;
    slot?: string;
    snapToSlideEdge?: boolean;
    spaceBetween?: string | number;
    speed?: number;
    spellCheck?: Booleanish;
    style?: CSSProperties;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    swipeHandler?: CSSSelector | HTMLElement | null;
    swiperElementNodeName?: string;
    tabIndex?: number;
    tag?: string;
    threshold?: number;
    thumbs?: ThumbsOptions;
    title?: string;
    touchAngle?: number;
    touchEventsTarget?: "container" | "wrapper";
    touchMoveStopPropagation?: boolean;
    touchRatio?: number;
    touchReleaseOnEdges?: boolean;
    touchStartForcePreventDefault?: boolean;
    touchStartPreventDefault?: boolean;
    translate?: "yes" | "no";
    typeof?: string;
    uniqueNavElements?: boolean;
    unselectable?: "off" | "on";
    updateOnWindowResize?: boolean;
    url?: string | null;
    userAgent?: string | null;
    virtual?: boolean | VirtualOptions<unknown>;
    virtualTranslate?: boolean;
    vocab?: string;
    watchOverflow?: boolean;
    watchSlidesProgress?: boolean;
    width?: number | null;
    wrapperClass?: string;
    wrapperTag?: string;
    zoom?: boolean | ZoomOptions;
    onAny?(eventName: string, ...args: any[]): void;
}

Hierarchy (View Summary)

Omit<HTMLAttributes<HTMLElement>, DropEvents>
SwiperOptions
- SwiperProps

Index

Properties

_emitClasses? _loopSwapReset? a11y? about? accessKey? allowSlideNext? allowSlidePrev? allowTouchMove? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoCorrect? autoFocus? autoHeight? autoplay? autoSave? breakpoints? breakpointsBase? cardsEffect? centeredSlides? centeredSlidesBounds? centerInsufficientSlides? children? className? color? containerModifierClass? content? contentEditable? contextMenu? controller? coverflowEffect? createElements? creativeEffect? cssMode? cubeEffect? dangerouslySetInnerHTML? datatype? defaultChecked? defaultValue? dir? direction? draggable? edgeSwipeDetection? edgeSwipeThreshold? effect? enabled? enterKeyHint? eventsPrefix? exportparts? fadeEffect? flipEffect? focusableElements? followFinger? freeMode? grabCursor? grid? hashNavigation? height? hidden? history? id? inert? init? initialSlide? injectStyles? injectStylesUrls? inlist? inputMode? is? itemID? itemProp? itemRef? itemScope? itemType? keyboard? lang? lazyPreloaderClass? lazyPreloadPrevNext? longSwipes? longSwipesMs? longSwipesRatio? loop? loopAddBlankSlides? loopAdditionalSlides? loopPreventsSliding? maxBackfaceHiddenSlides? modules? mousewheel? navigation? nested? nonce? normalizeSlideIndex? noSwiping? noSwipingClass? noSwipingSelector? observeParents? observer? observeSlideChildren? on? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBeforeToggle? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? oneWayMovement? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onScrollCapture? onScrollEnd? onScrollEndCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onSwiper? onTimeUpdate? onTimeUpdateCapture? onToggle? onTouchCancel? onTouchCancelCapture? onTouchEndCapture? onTouchMoveCapture? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? pagination? parallax? part? passiveListeners? popover? popoverTarget? popoverTargetAction? prefix? preventClicks? preventClicksPropagation? preventInteractionOnTransition? property? radioGroup? rel? resistance? resistanceRatio? resizeObserver? resource? results? rev? rewind? role? roundLengths? runCallbacksOnInit? scrollbar? security? setWrapperSize? shortSwipes? simulateTouch? slideActiveClass? slideBlankClass? slideClass? slideFullyVisibleClass? slideNextClass? slidePrevClass? slidesOffsetAfter? slidesOffsetBefore? slidesPerGroup? slidesPerGroupAuto? slidesPerGroupSkip? slidesPerView? slideToClickedSlide? slideVisibleClass? slot? snapToSlideEdge? spaceBetween? speed? spellCheck? style? suppressContentEditableWarning? suppressHydrationWarning? swipeHandler? swiperElementNodeName? tabIndex? tag? threshold? thumbs? title? touchAngle? touchEventsTarget? touchMoveStopPropagation? touchRatio? touchReleaseOnEdges? touchStartForcePreventDefault? touchStartPreventDefault? translate? typeof? uniqueNavElements? unselectable? updateOnWindowResize? url? userAgent? virtual? virtualTranslate? vocab? watchOverflow? watchSlidesProgress? width? wrapperClass? wrapperTag? zoom?

Methods

onAny?

Properties

`Optional`_emitClasses

_emitClasses?: boolean

!INTERNAL When enabled will emit "_containerClasses" and "_slideClass" events

`Optional`_loopSwapReset

_loopSwapReset?: boolean

!INTERNAL Set by effect-cards.overwriteParams to opt the cards effect out of the loop-swap reset that runs on the touch-move boundary.

`Optional`a11y

a11y?: boolean | A11yOptions

Object with a11y parameters or boolean true to enable with default settings.

Example

const swiper = new Swiper('.swiper', {
  a11y: {
    prevSlideMessage: 'Previous slide',
    nextSlideMessage: 'Next slide',
  },
});

`Optional`about

about?: string

`Optional`accessKey

accessKey?: string

`Optional`allowSlideNext

allowSlideNext?: boolean

Set to false to disable swiping to next slide direction (to right or bottom)

Default

true

`Optional`allowSlidePrev

allowSlidePrev?: boolean

Set to false to disable swiping to previous slide direction (to left or top)

Default

true

`Optional`allowTouchMove

allowTouchMove?: boolean

If false, then the only way to switch the slide is use of external API functions like slidePrev or slideNext

Default

true

`Optional`aria-activedescendant

"aria-activedescendant"?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

`Optional`aria-atomic

"aria-atomic"?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

`Optional`aria-autocomplete

"aria-autocomplete"?: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

`Optional`aria-braillelabel

"aria-braillelabel"?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

`Optional`aria-brailleroledescription

"aria-brailleroledescription"?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

`Optional`aria-busy

"aria-busy"?: Booleanish

`Optional`aria-checked

"aria-checked"?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

aria-pressed
aria-selected.

`Optional`aria-colcount

"aria-colcount"?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

`Optional`aria-colindex

"aria-colindex"?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

aria-colcount
aria-colspan.

`Optional`aria-colindextext

"aria-colindextext"?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

`Optional`aria-colspan

"aria-colspan"?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

aria-colindex
aria-rowspan.

`Optional`aria-controls

"aria-controls"?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

`Optional`aria-current

Indicates the element that represents the current item within a container or set of related elements.

`Optional`aria-describedby

"aria-describedby"?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

`Optional`aria-description

"aria-description"?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

`Optional`aria-details

"aria-details"?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

`Optional`aria-disabled

"aria-disabled"?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

aria-hidden
aria-readonly.

`Optional`aria-dropeffect

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

`Optional`aria-errormessage

"aria-errormessage"?: string

Identifies the element that provides an error message for the object.

See

aria-invalid
aria-describedby.

`Optional`aria-expanded

"aria-expanded"?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

`Optional`aria-flowto

"aria-flowto"?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

`Optional`aria-grabbed

"aria-grabbed"?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

`Optional`aria-haspopup

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

`Optional`aria-hidden

"aria-hidden"?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

`Optional`aria-invalid

"aria-invalid"?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

`Optional`aria-keyshortcuts

"aria-keyshortcuts"?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

`Optional`aria-label

"aria-label"?: string

Defines a string value that labels the current element.

See

aria-labelledby.

`Optional`aria-labelledby

"aria-labelledby"?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

`Optional`aria-level

"aria-level"?: number

Defines the hierarchical level of an element within a structure.

`Optional`aria-live

"aria-live"?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

`Optional`aria-modal

"aria-modal"?: Booleanish

Indicates whether an element is modal when displayed.

`Optional`aria-multiline

"aria-multiline"?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

`Optional`aria-multiselectable

"aria-multiselectable"?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

`Optional`aria-orientation

"aria-orientation"?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

`Optional`aria-owns

"aria-owns"?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

`Optional`aria-placeholder

"aria-placeholder"?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

`Optional`aria-posinset

"aria-posinset"?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

`Optional`aria-pressed

"aria-pressed"?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

aria-checked
aria-selected.

`Optional`aria-readonly

"aria-readonly"?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

`Optional`aria-relevant

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

`Optional`aria-required

"aria-required"?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

`Optional`aria-roledescription

"aria-roledescription"?: string

Defines a human-readable, author-localized description for the role of an element.

`Optional`aria-rowcount

"aria-rowcount"?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

`Optional`aria-rowindex

"aria-rowindex"?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

aria-rowcount
aria-rowspan.

`Optional`aria-rowindextext

"aria-rowindextext"?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

`Optional`aria-rowspan

"aria-rowspan"?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

aria-rowindex
aria-colspan.

`Optional`aria-selected

"aria-selected"?: Booleanish

Indicates the current "selected" state of various widgets.

See

aria-checked
aria-pressed.

`Optional`aria-setsize

"aria-setsize"?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

`Optional`aria-sort

"aria-sort"?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

`Optional`aria-valuemax

"aria-valuemax"?: number

Defines the maximum allowed value for a range widget.

`Optional`aria-valuemin

"aria-valuemin"?: number

Defines the minimum allowed value for a range widget.

`Optional`aria-valuenow

"aria-valuenow"?: number

Defines the current value for a range widget.

See

aria-valuetext.

`Optional`aria-valuetext

"aria-valuetext"?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

`Optional`autoCapitalize

autoCapitalize?:
    | string & {}
    | "off"
    | "none"
    | "on"
    | "sentences"
    | "words"
    | "characters"

`Optional`autoCorrect

autoCorrect?: string

`Optional`autoFocus

autoFocus?: boolean

`Optional`autoHeight

autoHeight?: boolean

Set to true and slider wrapper will adapt its height to the height of the currently active slide

Default

false

`Optional`autoplay

autoplay?: boolean | AutoplayOptions

Object with autoplay parameters or boolean true to enable with default settings

Example

const swiper = new Swiper('.swiper', {
  autoplay: {
    delay: 5000,
  },
});

`Optional`autoSave

autoSave?: string

`Optional`breakpoints

breakpoints?: { [width: number]: SwiperOptions; [ratio: string]: SwiperOptions }

Allows to set different parameter for different responsive breakpoints (screen sizes). Not all parameters can be changed in breakpoints, only those which do not require different layout and logic, like slidesPerView, slidesPerGroup, spaceBetween, grid.rows. Such parameters like loop and effect won't work

Example

const swiper = new Swiper('.swiper', {
  // Default parameters
  slidesPerView: 1,
  spaceBetween: 10,
  // Responsive breakpoints
  breakpoints: {
    // when window width is >= 320px
    320: {
      slidesPerView: 2,
      spaceBetween: 20
    },
    // when window width is >= 480px
    480: {
      slidesPerView: 3,
      spaceBetween: 30
    },
    // when window width is >= 640px
    640: {
      slidesPerView: 4,
      spaceBetween: 40
    }
  }
})

Example

const swiper = new Swiper('.swiper', {
  slidesPerView: 1,
  spaceBetween: 10,
  // using "ratio" endpoints
  breakpoints: {
    '@0.75': {
      slidesPerView: 2,
      spaceBetween: 20,
    },
    '@1.00': {
      slidesPerView: 3,
      spaceBetween: 40,
    },
    '@1.50': {
      slidesPerView: 4,
      spaceBetween: 50,
    },
  }
});

`Optional`breakpointsBase

breakpointsBase?: "container" | CSSSelector | "window"

Base for breakpoints (beta). Can be window or container. If set to window (by default) then breakpoint keys mean window width. If set to container then breakpoint keys treated as swiper container width

Default

'window'

`Optional`cardsEffect

cardsEffect?: CardsEffectOptions

Object with Cards-effect parameters

Example

const swiper = new Swiper('.swiper', {
  effect: 'cards',
  cardsEffect: {
    // ...
  },
});

`Optional`centeredSlides

centeredSlides?: boolean

If true, then active slide will be centered, not always on the left side.

Default

false

`Optional`centeredSlidesBounds

centeredSlidesBounds?: boolean

If true, then active slide will be centered without adding gaps at the beginning and end of slider. Required centeredSlides: true. Not intended to be used with loop or pagination

Default

false

`Optional`centerInsufficientSlides

centerInsufficientSlides?: boolean

When enabled it center slides if the amount of slides less than slidesPerView. Not intended to be used loop mode and grid.rows

Default

false

`Optional`children

children?: ReactNode

`Optional`className

className?: string

`Optional`color

color?: string

`Optional`containerModifierClass

containerModifierClass?: string

The beginning of the modifier CSS class that can be added to swiper container depending on different parameters

Default

'swiper-'

`Optional`content

content?: string

`Optional`contentEditable

contentEditable?: Booleanish | "inherit" | "plaintext-only"

`Optional`contextMenu

contextMenu?: string

`Optional`controller

controller?: boolean | ControllerOptions

Object with controller parameters or boolean true to enable with default settings

Example

const swiper = new Swiper('.swiper', {
  controller: {
    inverse: true,
  },
});

`Optional`coverflowEffect

coverflowEffect?: CoverflowEffectOptions

Object with Coverflow-effect parameters.

Example

const swiper = new Swiper('.swiper', {
  effect: 'coverflow',
  coverflowEffect: {
    rotate: 30,
    slideShadows: false,
  },
});

`Optional`createElements

createElements?: boolean

When enabled Swiper will automatically wrap slides with swiper-wrapper element, and will create required elements for navigation, pagination and scrollbar they are enabled (with their respective params object or with boolean true))

Default

false

`Optional`creativeEffect

creativeEffect?: CreativeEffectOptions

Object with Creative-effect parameters

Example

const swiper = new Swiper('.swiper', {
  effect: 'creative',
  creativeEffect: {
    prev: {
      // will set `translateZ(-400px)` on previous slides
      translate: [0, 0, -400],
    },
    next: {
      // will set `translateX(100%)` on next slides
      translate: ['100%', 0, 0],
    },
  },
});

`Optional`cssMode

cssMode?: boolean

When enabled it will use modern CSS Scroll Snap API. It doesn't support all of Swiper's features, but potentially should bring a much better performance in simple configurations.

This is what is not supported when it is enabled:

Cube effect
speed parameter may not have no effect
All transition start/end related events (use slideChange instead)
slidesPerGroup has limited support
simulateTouch doesn't have effect and "dragging" with mouse doesn't work
resistance doesn't have any effect
allowSlidePrev/Next
swipeHandler

In case if you use it with other effects, especially 3D effects, it is required to wrap slide's content with <div class="swiper-slide-transform"> element. And if you use any custom styles on slides (like background colors, border radius, border, etc.), they should be set on swiper-slide-transform element instead.

Example

<div class="swiper">
  <div class="swiper-wrapper">
    <div class="swiper-slide">
      <!-- wrap slide content with transform element -->
      <div class="swiper-slide-transform">
        ... slide content ...
      </div>
    </div>
    ...
  </div>
</div>
<script>
const swiper = new Swiper('.swiper', {
   effect: 'flip',
   cssMode: true,
 });
</script>

Default

false

`Optional`cubeEffect

cubeEffect?: CubeEffectOptions

Object with Cube-effect parameters

Example

const swiper = new Swiper('.swiper', {
  effect: 'cube',
  cubeEffect: {
    slideShadows: false,
  },
});

`Optional`dangerouslySetInnerHTML

dangerouslySetInnerHTML?: { __html: string | TrustedHTML }

`Optional`datatype

datatype?: string

`Optional`defaultChecked

defaultChecked?: boolean

`Optional`defaultValue

defaultValue?: string | number | readonly string[]

`Optional`dir

dir?: string

`Optional`direction

direction?: "horizontal" | "vertical"

Can be 'horizontal' or 'vertical' (for vertical slider).

Default

'horizontal'

`Optional`draggable

draggable?: Booleanish

`Optional`edgeSwipeDetection

edgeSwipeDetection?: string | boolean

Enable to release Swiper events for swipe-back work in app. If set to 'prevent' then it will prevent system swipe-back navigation instead. This feature works only with "touch" events (and not pointer events), so it will work on iOS/Android devices and won't work on Windows devices with pointer (touch) events.

Default

false

`Optional`edgeSwipeThreshold

edgeSwipeThreshold?: number

Area (in px) from left edge of the screen to release touch events for swipe-back in app

Default

`Optional`effect

effect?:
    | "slide"
    | "fade"
    | "cube"
    | "coverflow"
    | "flip"
    | "creative"
    | "cards"
    | string & {}

Transition effect. Can be 'slide', 'fade', 'cube', 'coverflow', 'flip', 'creative' or 'cards'

Default

'slide'

`Optional`enabled

enabled?: boolean

Whether Swiper initially enabled. When Swiper is disabled, it will hide all navigation elements and won't respond to any events and interactions

Default

true

`Optional`enterKeyHint

`Optional`eventsPrefix

eventsPrefix?: string

Event name prefix for all DOM events emitted by Swiper Element (web component)

Default

swiper

`Optional`exportparts

exportparts?: string

See

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts

`Optional`fadeEffect

fadeEffect?: FadeEffectOptions

Object with Fade-effect parameters

Example

const swiper = new Swiper('.swiper', {
  effect: 'fade',
  fadeEffect: {
    crossFade: true
  },
});

`Optional`flipEffect

flipEffect?: FlipEffectOptions

Object with Flip-effect parameters

Example

const swiper = new Swiper('.swiper', {
  effect: 'flip',
  flipEffect: {
    slideShadows: false,
  },
});

`Optional`focusableElements

focusableElements?: string

CSS selector for focusable elements. Swiping will be disabled on such elements if they are "focused"

Default

'input, select, option, textarea, button, video, label'

`Optional`followFinger

followFinger?: boolean

If disabled, then slider will be animated only when you release it, it will not move while you hold your finger on it

Default

true

`Optional`freeMode

freeMode?: boolean | FreeModeOptions

Enables free mode functionality. Object with free mode parameters or boolean true to enable with default settings.

Example

const swiper = new Swiper('.swiper', {
  freeMode: true,
});

const swiper = new Swiper('.swiper', {
  freeMode: {
    enabled: true,
    sticky: true,
  },
});

`Optional`grabCursor

grabCursor?: boolean

This option may a little improve desktop usability. If true, user will see the "grab" cursor when hover on Swiper

Default

false

`Optional`grid

grid?: GridOptions

Object with grid parameters to enable "multirow" slider.

Example

const swiper = new Swiper('.swiper', {
  grid: {
    rows: 2,
  },
});

`Optional`hashNavigation

hashNavigation?: boolean | HashNavigationOptions

Enables hash url navigation to for slides. Object with hash navigation parameters or boolean true to enable with default settings

Example

const swiper = new Swiper('.swiper', {
  hashNavigation: {
    replaceState: true,
  },
});

`Optional`height

height?: number | null

Swiper height (in px). Parameter allows to force Swiper height. Useful only if you initialize Swiper when it is hidden and in SSR and Test environments for correct Swiper initialization

Default

null

Note

Setting this parameter will make Swiper not responsive

`Optional`hidden

hidden?: boolean

`Optional`history

history?: boolean | HistoryOptions

Enables history push state where every slide will have its own url. In this parameter you have to specify main slides url like "slides" and specify every slide url using data-history attribute.

Object with history navigation parameters or boolean true to enable with default settings

Example

const swiper = new Swiper('.swiper', {
  history: {
    replaceState: true,
  },
});

Example

<!-- will produce "slides/slide1" url in browser history -->
<div class="swiper-slide" data-history="slide1"></div>

`Optional`id

id?: string

`Optional`inert

inert?: boolean

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert

`Optional`init

init?: boolean

Whether Swiper should be initialised automatically when you create an instance. If disabled, then you need to init it manually by calling swiper.init()

Default

true

`Optional`initialSlide

initialSlide?: number

Index number of initial slide.

Default

`Optional`injectStyles

injectStyles?: string[]

Inject text styles to the shadow DOM. Only for usage with Swiper Element

`Optional`injectStylesUrls

injectStylesUrls?: string[]

Inject styles <link>s to the shadow DOM. Only for usage with Swiper Element

`Optional`inlist

inlist?: any

`Optional`inputMode

Hints at the type of data that might be entered by the user while editing the element or its contents

See

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

`Optional`is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

See

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

`Optional`itemID

itemID?: string

`Optional`itemProp

itemProp?: string

`Optional`itemRef

itemRef?: string

`Optional`itemScope

itemScope?: boolean

`Optional`itemType

itemType?: string

`Optional`keyboard

keyboard?: boolean | KeyboardOptions

Enables navigation through slides using keyboard. Object with keyboard parameters or boolean true to enable with default settings

Example

const swiper = new Swiper('.swiper', {
  keyboard: {
    enabled: true,
    onlyInViewport: false,
  },
});

`Optional`lang

lang?: string

`Optional`lazyPreloaderClass

lazyPreloaderClass?: string

CSS class name of lazy preloader

Default

'swiper-lazy-preloader'

`Optional`lazyPreloadPrevNext

lazyPreloadPrevNext?: number

Number of next and previous slides to preload. Only applicable if using lazy loading.

Default

`Optional`longSwipes

longSwipes?: boolean

Set to false if you want to disable long swipes

Default

true

`Optional`longSwipesMs

longSwipesMs?: number

Minimal duration (in ms) to trigger swipe to next/previous slide during long swipes

Default

`Optional`longSwipesRatio

longSwipesRatio?: number

Ratio to trigger swipe to next/previous slide during long swipes

Default

0.5

`Optional`loop

loop?: boolean

Set to true to enable continuous loop mode

Because of nature of how the loop mode works (it will rearrange slides), total number of slides must be:

more than or equal to slidesPerView + slidesPerGroup (and + 1 in case of centeredSlides)
even to slidesPerGroup (or use loopAddBlankSlides parameter)
even to grid.rows (or use loopAddBlankSlides parameter)

Default

false

`Optional`loopAddBlankSlides

loopAddBlankSlides?: boolean

Automatically adds blank slides if you use Grid or slidesPerGroup and the total amount of slides is not even to slidesPerGroup or to grid.rows

Default

true

`Optional`loopAdditionalSlides

loopAdditionalSlides?: number

Allows to increase amount of looped slides

Default

`Optional`loopPreventsSliding

loopPreventsSliding?: boolean

If enabled then slideNext/Prev will do nothing while slider is animating in loop mode

Default

true

`Optional`maxBackfaceHiddenSlides

maxBackfaceHiddenSlides?: number

If total number of slides less than specified here value, then Swiper will enable backface-visibility: hidden on slide elements to reduce visual "flicker" in Safari.

Note

It is not recommended to enable it on large amount of slides as it will reduce performance

Default

`Optional`modules

modules?: SwiperModule[]

Array with Swiper modules

Example

import Swiper from 'swiper';
import { Navigation, Pagination } from 'swiper/modules';

const swiper = new Swiper('.swiper', {
   modules: [ Navigation, Pagination ],
 });

`Optional`mousewheel

mousewheel?: boolean | MousewheelOptions

Enables navigation through slides using mouse wheel. Object with mousewheel parameters or boolean true to enable with default settings

Example

const swiper = new Swiper('.swiper', {
  mousewheel: {
    invert: true,
  },
});

`Optional`navigation

navigation?: boolean | NavigationOptions

Object with navigation parameters or boolean true to enable with default settings.

Example

const swiper = new Swiper('.swiper', {
  navigation: {
    nextEl: '.swiper-button-next',
    prevEl: '.swiper-button-prev',
  },
});

`Optional`nested

nested?: boolean

Set to true on Swiper for correct touch events interception. Use only on swipers that use same direction as the parent one

Default

false

`Optional`nonce

nonce?: string

`Optional`normalizeSlideIndex

normalizeSlideIndex?: boolean

Normalize slide index.

Default

true

`Optional`noSwiping

noSwiping?: boolean

Enable/disable swiping on elements matched to class specified in noSwipingClass

Default

true

`Optional`noSwipingClass

noSwipingClass?: string

Specify noSwiping's element css class

Default

'swiper-no-swiping'

`Optional`noSwipingSelector

noSwipingSelector?: string

Can be used instead of noSwipingClass to specify elements to disable swiping on. For example 'input' will disable swiping on all inputs

Default

`Optional`observeParents

observeParents?: boolean

Set to true if you also need to watch Mutations for Swiper parent elements

Default

false

`Optional`observer

observer?: boolean

Set to true to enable Mutation Observer on Swiper and its elements. In this case Swiper will be updated (reinitialized) each time if you change its style (like hide/show) or modify its child elements (like adding/removing slides)

Default

false

`Optional`observeSlideChildren

observeSlideChildren?: boolean

Set to true if you also need to watch Mutations for Swiper slide children elements

Default

false

`Optional`on

on?: {
    _beforeBreakpoint?: (
        swiper: Swiper,
        breakpointParams: SwiperOptions,
    ) => void;
    _containerClasses?: (swiper: Swiper, classNames: string) => void;
    _freeModeNoMomentumRelease?: (swiper: Swiper) => void;
    _freeModeStaticRelease?: () => void;
    _slideClass?: (
        swiper: Swiper,
        slideEl: HTMLElement,
        classNames: string,
    ) => void;
    _slideClasses?: (
        swiper: Swiper,
        slides: { classNames: string; index: number; slideEl: HTMLElement }[],
    ) => void;
    _swiper?: (swiper: Swiper) => void;
    activeIndexChange?: (swiper: Swiper) => void;
    afterInit?: (swiper: Swiper) => void;
    autoplay?: (swiper: Swiper) => void;
    autoplayPause?: (swiper: Swiper) => void;
    autoplayResume?: (swiper: Swiper) => void;
    autoplayStart?: (swiper: Swiper) => void;
    autoplayStop?: (swiper: Swiper) => void;
    autoplayTimeLeft?: (
        swiper: Swiper,
        timeLeft: number,
        percentage: number,
    ) => void;
    beforeDestroy?: (swiper: Swiper) => void;
    beforeInit?: (swiper: Swiper) => void;
    beforeLoopFix?: (swiper: Swiper) => void;
    beforeResize?: (swiper: Swiper) => void;
    beforeSlideChangeStart?: (swiper: Swiper) => void;
    beforeTransitionStart?: (
        swiper: Swiper,
        speed: number,
        internal: unknown,
    ) => void;
    breakpoint?: (swiper: Swiper, breakpointParams: SwiperOptions) => void;
    changeDirection?: (swiper: Swiper) => void;
    click?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    destroy?: (swiper: Swiper) => void;
    doubleClick?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    doubleTap?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    fromEdge?: (swiper: Swiper) => void;
    hashChange?: (swiper: Swiper) => void;
    hashSet?: (swiper: Swiper) => void;
    init?: (swiper: Swiper) => any;
    keyPress?: (swiper: Swiper, keyCode: string) => void;
    lock?: (swiper: Swiper) => void;
    loopFix?: (swiper: Swiper) => void;
    momentumBounce?: (swiper: Swiper) => void;
    navigationHide?: (swiper: Swiper) => void;
    navigationNext?: (swiper: Swiper) => void;
    navigationPrev?: (swiper: Swiper) => void;
    navigationShow?: (swiper: Swiper) => void;
    observerUpdate?: (swiper: Swiper) => void;
    orientationchange?: (swiper: Swiper) => void;
    paginationHide?: (swiper: Swiper) => void;
    paginationRender?: (swiper: Swiper, paginationEl: HTMLElement) => void;
    paginationShow?: (swiper: Swiper) => void;
    paginationUpdate?: (swiper: Swiper, paginationEl: HTMLElement) => void;
    progress?: (swiper: Swiper, progress: number) => void;
    reachBeginning?: (swiper: Swiper) => void;
    reachEnd?: (swiper: Swiper) => void;
    realIndexChange?: (swiper: Swiper) => void;
    resize?: (swiper: Swiper) => void;
    scroll?: (swiper: Swiper, event: WheelEvent) => void;
    scrollbarDragEnd?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    scrollbarDragMove?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    scrollbarDragStart?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    setTransition?: (
        swiper: Swiper,
        transition: number,
        byController?: boolean | Swiper,
    ) => void;
    setTranslate?: (
        swiper: Swiper,
        translate: number,
        byController?: boolean | Swiper,
    ) => void;
    slideChange?: (swiper: Swiper) => void;
    slideChangeTransitionEnd?: (swiper: Swiper) => void;
    slideChangeTransitionStart?: (swiper: Swiper) => void;
    slideNextTransitionEnd?: (swiper: Swiper) => void;
    slideNextTransitionStart?: (swiper: Swiper) => void;
    slidePrevTransitionEnd?: (swiper: Swiper) => void;
    slidePrevTransitionStart?: (swiper: Swiper) => void;
    slideResetTransitionEnd?: (swiper: Swiper) => void;
    slideResetTransitionStart?: (swiper: Swiper) => void;
    sliderFirstMove?: (swiper: Swiper, event: TouchEvent) => void;
    sliderMove?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    slidesGridLengthChange?: (swiper: Swiper) => void;
    slidesLengthChange?: (swiper: Swiper) => void;
    slidesUpdated?: (swiper: Swiper) => void;
    snapGridLengthChange?: (swiper: Swiper) => void;
    snapIndexChange?: (swiper: Swiper) => void;
    tap?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    toEdge?: (swiper: Swiper) => void;
    touchEnd?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    touchMove?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    touchMoveOpposite?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    touchStart?: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void;
    transitionEnd?: (swiper: Swiper) => void;
    transitionStart?: (swiper: Swiper) => void;
    unlock?: (swiper: Swiper) => void;
    update?: (swiper: Swiper) => void;
    virtualUpdate?: (swiper: Swiper) => void;
    zoomChange?: (
        swiper: Swiper,
        scale: number,
        imageEl: HTMLElement,
        slideEl: HTMLElement,
    ) => void;
}

Type Declaration

Optional_beforeBreakpoint?: (swiper: Swiper, breakpointParams: SwiperOptions) => void
!INTERNAL: Event will fired right before breakpoint change
Optional_containerClasses?: (swiper: Swiper, classNames: string) => void
!INTERNAL: Event will fired after setting CSS classes on swiper container element
Optional_freeModeNoMomentumRelease?: (swiper: Swiper) => void
!INTERNAL: Event will be fired on free mode touch end (release) and there will no be momentum
Optional_freeModeStaticRelease?: () => void
!INTERNAL: Event will be fired on free mode touch end (release) and there will be no momentum and no bounce
Optional_slideClass?: (swiper: Swiper, slideEl: HTMLElement, classNames: string) => void
!INTERNAL: Event will fired after setting CSS classes on swiper slide element
Optional_slideClasses?: (
swiper: Swiper,
slides: { classNames: string; index: number; slideEl: HTMLElement }[],
) => void
!INTERNAL: Event will fired after setting CSS classes on all swiper slides
Optional_swiper?: (swiper: Swiper) => void
!INTERNAL: Event will fired as soon as swiper instance available (before init)
OptionalactiveIndexChange?: (swiper: Swiper) => void
Event will fired on active index change
OptionalafterInit?: (swiper: Swiper) => void
Event will fired right after initialization
Optionalautoplay?: (swiper: Swiper) => void
Event will be fired when slide changed with autoplay
OptionalautoplayPause?: (swiper: Swiper) => void
Event will be fired on autoplay pause
OptionalautoplayResume?: (swiper: Swiper) => void
Event will be fired on autoplay resume
OptionalautoplayStart?: (swiper: Swiper) => void
Event will be fired in when autoplay started
OptionalautoplayStop?: (swiper: Swiper) => void
Event will be fired when autoplay stopped
OptionalautoplayTimeLeft?: (swiper: Swiper, timeLeft: number, percentage: number) => 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
OptionalbeforeDestroy?: (swiper: Swiper) => void
Event will be fired right before Swiper destroyed
OptionalbeforeInit?: (swiper: Swiper) => void
Event will fired right before initialization
OptionalbeforeLoopFix?: (swiper: Swiper) => void
Event will be fired right before "loop fix"
OptionalbeforeResize?: (swiper: Swiper) => void
Event will fired before resize handler
OptionalbeforeSlideChangeStart?: (swiper: Swiper) => void
Event will fired before slide change transition start
OptionalbeforeTransitionStart?: (swiper: Swiper, speed: number, internal: unknown) => void
Event will fired before transition start
Optionalbreakpoint?: (swiper: Swiper, breakpointParams: SwiperOptions) => void
Event will be fired on breakpoint change
OptionalchangeDirection?: (swiper: Swiper) => void
Event will fired on direction change
Optionalclick?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user click/tap on Swiper. Receives pointerup event as an arguments.
Optionaldestroy?: (swiper: Swiper) => void
Event will be fired on swiper destroy
OptionaldoubleClick?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user double click/tap on Swiper
OptionaldoubleTap?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user double tap on Swiper's container. Receives pointerup event as an arguments
OptionalfromEdge?: (swiper: Swiper) => void
Event will be fired when Swiper goes from beginning or end position
OptionalhashChange?: (swiper: Swiper) => void
Event will be fired on window hash change
OptionalhashSet?: (swiper: Swiper) => void
Event will be fired when swiper updates the hash

`Optional`init?: (swiper: Swiper) => any

Fired right after Swiper initialization.

Note

Note that with swiper.on('init') syntax it will work only in case you set init: false parameter.

Example

const swiper = new Swiper('.swiper', {
  init: false,
  // other parameters
});
swiper.on('init', function() {
 // do something
});
// init Swiper
swiper.init();

Example

// Otherwise use it as the parameter:
const swiper = new Swiper('.swiper', {
  // other parameters
  on: {
    init: function () {
      // do something
    },
  }
});

OptionalkeyPress?: (swiper: Swiper, keyCode: string) => void
Event will be fired on key press
Optionallock?: (swiper: Swiper) => void
Event will be fired when swiper is locked (when watchOverflow enabled)
OptionalloopFix?: (swiper: Swiper) => void
Event will be fired after "loop fix"
OptionalmomentumBounce?: (swiper: Swiper) => void
Event will be fired on momentum bounce
OptionalnavigationHide?: (swiper: Swiper) => void
Event will be fired on navigation hide
OptionalnavigationNext?: (swiper: Swiper) => void
Event will be fired on navigation next button click
OptionalnavigationPrev?: (swiper: Swiper) => void
Event will be fired on navigation prev button click
OptionalnavigationShow?: (swiper: Swiper) => void
Event will be fired on navigation show
OptionalobserverUpdate?: (swiper: Swiper) => void
Event will be fired if observer is enabled and it detects DOM mutations
Optionalorientationchange?: (swiper: Swiper) => void
Event will be fired on orientation change (e.g. landscape -> portrait)
OptionalpaginationHide?: (swiper: Swiper) => void
Event will be fired on pagination hide
OptionalpaginationRender?: (swiper: Swiper, paginationEl: HTMLElement) => void
Event will be fired after pagination rendered
OptionalpaginationShow?: (swiper: Swiper) => void
Event will be fired on pagination show
OptionalpaginationUpdate?: (swiper: Swiper, paginationEl: HTMLElement) => void
Event will be fired when pagination updated
Optionalprogress?: (swiper: Swiper, progress: number) => void
Event will be fired when Swiper progress is changed, as an arguments it receives progress that is always from 0 to 1
OptionalreachBeginning?: (swiper: Swiper) => void
Event will be fired when Swiper reach its beginning (initial position)
OptionalreachEnd?: (swiper: Swiper) => void
Event will be fired when Swiper reach last slide
OptionalrealIndexChange?: (swiper: Swiper) => void
Event will fired on real index change
Optionalresize?: (swiper: Swiper) => void
Event will be fired on window resize right before swiper's onresize manipulation
Optionalscroll?: (swiper: Swiper, event: WheelEvent) => void
Event will be fired on mousewheel scroll
OptionalscrollbarDragEnd?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired on draggable scrollbar drag end
OptionalscrollbarDragMove?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired on draggable scrollbar drag move
OptionalscrollbarDragStart?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired on draggable scrollbar drag start
OptionalsetTransition?: (swiper: Swiper, transition: number, byController?: boolean | Swiper) => void
Event will be fired everytime when swiper starts animation. Receives current transition duration (in ms) as an arguments. The optional third argument is set by the Controller module to short-circuit re-propagation between linked Swipers.
OptionalsetTranslate?: (swiper: Swiper, translate: number, byController?: boolean | Swiper) => void
Event will be fired when swiper's wrapper change its position. Receives current translate value as an arguments. The optional third argument is set by the Controller module to short-circuit re-propagation between linked Swipers.
OptionalslideChange?: (swiper: Swiper) => void
Event will be fired when currently active slide is changed
OptionalslideChangeTransitionEnd?: (swiper: Swiper) => void
Event will be fired after animation to other slide (next or previous).
OptionalslideChangeTransitionStart?: (swiper: Swiper) => void
Event will be fired in the beginning of animation to other slide (next or previous).
OptionalslideNextTransitionEnd?: (swiper: Swiper) => void
Same as "slideChangeTransitionEnd" but for "forward" direction only
OptionalslideNextTransitionStart?: (swiper: Swiper) => void
Same as "slideChangeTransitionStart" but for "forward" direction only
OptionalslidePrevTransitionEnd?: (swiper: Swiper) => void
Same as "slideChangeTransitionEnd" but for "backward" direction only
OptionalslidePrevTransitionStart?: (swiper: Swiper) => void
Same as "slideChangeTransitionStart" but for "backward" direction only
OptionalslideResetTransitionEnd?: (swiper: Swiper) => void
Event will be fired in the end of animation of resetting slide to current one
OptionalslideResetTransitionStart?: (swiper: Swiper) => void
Event will be fired in the beginning of animation of resetting slide to current one
OptionalsliderFirstMove?: (swiper: Swiper, event: TouchEvent) => void
Event will be fired with first touch/drag move
OptionalsliderMove?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user touch and move finger over Swiper and move it. Receives pointermove event as an arguments.
OptionalslidesGridLengthChange?: (swiper: Swiper) => void
Event will be fired when slides grid has changed
OptionalslidesLengthChange?: (swiper: Swiper) => void
Event will be fired when number of slides has changed
OptionalslidesUpdated?: (swiper: Swiper) => void
Event will be fired after slides and their sizes are calculated and updated
OptionalsnapGridLengthChange?: (swiper: Swiper) => void
Event will be fired when snap grid has changed
OptionalsnapIndexChange?: (swiper: Swiper) => void
Event will fired on snap index change
Optionaltap?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user click/tap on Swiper. Receives pointerup event as an arguments.
OptionaltoEdge?: (swiper: Swiper) => void
Event will be fired when Swiper goes to beginning or end position
OptionaltouchEnd?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user release Swiper. Receives pointerup event as an arguments.
OptionaltouchMove?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user touch and move finger over Swiper. Receives pointermove event as an arguments.
OptionaltouchMoveOpposite?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user touch and move finger over Swiper in direction opposite to direction parameter. Receives pointermove event as an arguments.
OptionaltouchStart?: (swiper: Swiper, event: PointerEvent | MouseEvent | TouchEvent) => void
Event will be fired when user touch Swiper. Receives pointerdown event as an arguments.
OptionaltransitionEnd?: (swiper: Swiper) => void
Event will be fired after transition.
OptionaltransitionStart?: (swiper: Swiper) => void
Event will be fired in the beginning of transition.
Optionalunlock?: (swiper: Swiper) => void
Event will be fired when swiper is unlocked (when watchOverflow enabled)
Optionalupdate?: (swiper: Swiper) => void
Event will be fired after swiper.update() call
OptionalvirtualUpdate?: (swiper: Swiper) => void
Event will be fired after the virtual slides DOM has been re-rendered (either internally by the module or after a renderExternal round-trip).
OptionalzoomChange?: (
    swiper: Swiper,
    scale: number,
    imageEl: HTMLElement,
    slideEl: HTMLElement,
) => void
Event will be fired on zoom change

`Optional`onAbort

onAbort?: ReactEventHandler<HTMLElement>

`Optional`onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLElement>

`Optional`onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLElement>

`Optional`onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLElement>

`Optional`onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLElement>

`Optional`onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>

`Optional`onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLElement>

`Optional`onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLElement>

`Optional`onAuxClick

onAuxClick?: MouseEventHandler<HTMLElement>

`Optional`onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLElement>

`Optional`onBeforeInput

onBeforeInput?: InputEventHandler<HTMLElement>

`Optional`onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLElement>

`Optional`onBeforeToggle

onBeforeToggle?: ToggleEventHandler<HTMLElement>

`Optional`onBlur

onBlur?: FocusEventHandler<HTMLElement>

`Optional`onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLElement>

`Optional`onCanPlay

onCanPlay?: ReactEventHandler<HTMLElement>

`Optional`onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLElement>

`Optional`onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLElement>

`Optional`onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>

`Optional`onChange

onChange?: FormEventHandler<HTMLElement>

`Optional`onChangeCapture

onChangeCapture?: FormEventHandler<HTMLElement>

`Optional`onClickCapture

onClickCapture?: MouseEventHandler<HTMLElement>

`Optional`onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLElement>

`Optional`onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLElement>

`Optional`onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLElement>

`Optional`onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLElement>

`Optional`onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLElement>

`Optional`onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>

`Optional`onContextMenu

onContextMenu?: MouseEventHandler<HTMLElement>

`Optional`onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLElement>

`Optional`onCopy

onCopy?: ClipboardEventHandler<HTMLElement>

`Optional`onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLElement>

`Optional`onCut

onCut?: ClipboardEventHandler<HTMLElement>

`Optional`onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLElement>

`Optional`onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLElement>

`Optional`onDrag

onDrag?: DragEventHandler<HTMLElement>

`Optional`onDragCapture

onDragCapture?: DragEventHandler<HTMLElement>

`Optional`onDragEnd

onDragEnd?: DragEventHandler<HTMLElement>

`Optional`onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLElement>

`Optional`onDragEnter

onDragEnter?: DragEventHandler<HTMLElement>

`Optional`onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLElement>

`Optional`onDragExit

onDragExit?: DragEventHandler<HTMLElement>

`Optional`onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLElement>

`Optional`onDragLeave

onDragLeave?: DragEventHandler<HTMLElement>

`Optional`onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLElement>

`Optional`onDragOver

onDragOver?: DragEventHandler<HTMLElement>

`Optional`onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLElement>

`Optional`onDragStart

onDragStart?: DragEventHandler<HTMLElement>

`Optional`onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLElement>

`Optional`onDrop

onDrop?: DragEventHandler<HTMLElement>

`Optional`onDropCapture

onDropCapture?: DragEventHandler<HTMLElement>

`Optional`onDurationChange

onDurationChange?: ReactEventHandler<HTMLElement>

`Optional`onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLElement>

`Optional`onEmptied

onEmptied?: ReactEventHandler<HTMLElement>

`Optional`onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLElement>

`Optional`onEncrypted

onEncrypted?: ReactEventHandler<HTMLElement>

`Optional`onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLElement>

`Optional`onEnded

onEnded?: ReactEventHandler<HTMLElement>

`Optional`onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLElement>

`Optional`onError

onError?: ReactEventHandler<HTMLElement>

`Optional`onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLElement>

`Optional`oneWayMovement

oneWayMovement?: boolean

When enabled, will swipe slides only forward (one-way) regardless of swipe direction

Default

false

`Optional`onFocus

onFocus?: FocusEventHandler<HTMLElement>

`Optional`onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLElement>

`Optional`onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLElement>

`Optional`onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>

`Optional`onInput

onInput?: FormEventHandler<HTMLElement>

`Optional`onInputCapture

onInputCapture?: FormEventHandler<HTMLElement>

`Optional`onInvalid

onInvalid?: FormEventHandler<HTMLElement>

`Optional`onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLElement>

`Optional`onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLElement>

`Optional`onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLElement>

`Optional`onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLElement>

Deprecated

Use onKeyUpCapture or onKeyDownCapture instead

`Optional`onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLElement>

`Optional`onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLElement>

`Optional`onLoad

onLoad?: ReactEventHandler<HTMLElement>

`Optional`onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLElement>

`Optional`onLoadedData

onLoadedData?: ReactEventHandler<HTMLElement>

`Optional`onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLElement>

`Optional`onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLElement>

`Optional`onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLElement>

`Optional`onLoadStart

onLoadStart?: ReactEventHandler<HTMLElement>

`Optional`onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLElement>

`Optional`onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLElement>

`Optional`onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>

`Optional`onMouseDown

onMouseDown?: MouseEventHandler<HTMLElement>

`Optional`onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLElement>

`Optional`onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLElement>

`Optional`onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLElement>

`Optional`onMouseMove

onMouseMove?: MouseEventHandler<HTMLElement>

`Optional`onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLElement>

`Optional`onMouseOut

onMouseOut?: MouseEventHandler<HTMLElement>

`Optional`onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLElement>

`Optional`onMouseOver

onMouseOver?: MouseEventHandler<HTMLElement>

`Optional`onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLElement>

`Optional`onMouseUp

onMouseUp?: MouseEventHandler<HTMLElement>

`Optional`onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLElement>

`Optional`onPaste

onPaste?: ClipboardEventHandler<HTMLElement>

`Optional`onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLElement>

`Optional`onPause

onPause?: ReactEventHandler<HTMLElement>

`Optional`onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLElement>

`Optional`onPlay

onPlay?: ReactEventHandler<HTMLElement>

`Optional`onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLElement>

`Optional`onPlaying

onPlaying?: ReactEventHandler<HTMLElement>

`Optional`onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLElement>

`Optional`onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLElement>

`Optional`onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLElement>

`Optional`onPointerDown

onPointerDown?: PointerEventHandler<HTMLElement>

`Optional`onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLElement>

`Optional`onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLElement>

`Optional`onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLElement>

`Optional`onPointerMove

onPointerMove?: PointerEventHandler<HTMLElement>

`Optional`onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLElement>

`Optional`onPointerOut

onPointerOut?: PointerEventHandler<HTMLElement>

`Optional`onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLElement>

`Optional`onPointerOver

onPointerOver?: PointerEventHandler<HTMLElement>

`Optional`onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLElement>

`Optional`onPointerUp

onPointerUp?: PointerEventHandler<HTMLElement>

`Optional`onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLElement>

`Optional`onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLElement>

`Optional`onRateChange

onRateChange?: ReactEventHandler<HTMLElement>

`Optional`onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLElement>

`Optional`onReset

onReset?: FormEventHandler<HTMLElement>

`Optional`onResetCapture

onResetCapture?: FormEventHandler<HTMLElement>

`Optional`onScrollCapture

onScrollCapture?: UIEventHandler<HTMLElement>

`Optional`onScrollEnd

onScrollEnd?: UIEventHandler<HTMLElement>

`Optional`onScrollEndCapture

onScrollEndCapture?: UIEventHandler<HTMLElement>

`Optional`onSeeked

onSeeked?: ReactEventHandler<HTMLElement>

`Optional`onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLElement>

`Optional`onSeeking

onSeeking?: ReactEventHandler<HTMLElement>

`Optional`onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLElement>

`Optional`onSelect

onSelect?: ReactEventHandler<HTMLElement>

`Optional`onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLElement>

`Optional`onStalled

onStalled?: ReactEventHandler<HTMLElement>

`Optional`onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLElement>

`Optional`onSubmit

onSubmit?: FormEventHandler<HTMLElement>

`Optional`onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLElement>

`Optional`onSuspend

onSuspend?: ReactEventHandler<HTMLElement>

`Optional`onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLElement>

`Optional`onSwiper

onSwiper?: (swiper: Swiper) => void

`Optional`onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLElement>

`Optional`onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLElement>

`Optional`onToggle

onToggle?: ToggleEventHandler<HTMLElement>

`Optional`onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLElement>

`Optional`onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLElement>

`Optional`onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLElement>

`Optional`onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLElement>

`Optional`onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLElement>

`Optional`onTransitionCancel

onTransitionCancel?: TransitionEventHandler<HTMLElement>

`Optional`onTransitionCancelCapture

onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>

`Optional`onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLElement>

`Optional`onTransitionRun

onTransitionRun?: TransitionEventHandler<HTMLElement>

`Optional`onTransitionRunCapture

onTransitionRunCapture?: TransitionEventHandler<HTMLElement>

`Optional`onTransitionStart

onTransitionStart?: TransitionEventHandler<HTMLElement>

`Optional`onTransitionStartCapture

onTransitionStartCapture?: TransitionEventHandler<HTMLElement>

`Optional`onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLElement>

`Optional`onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLElement>

`Optional`onWaiting

onWaiting?: ReactEventHandler<HTMLElement>

`Optional`onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLElement>

`Optional`onWheel

onWheel?: WheelEventHandler<HTMLElement>

`Optional`onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLElement>

`Optional`pagination

pagination?: boolean | PaginationOptions

Object with pagination parameters or boolean true to enable with default settings.

Example

const swiper = new Swiper('.swiper', {
  pagination: {
    el: '.swiper-pagination',
    type: 'bullets',
  },
});

`Optional`parallax

parallax?: boolean | ParallaxOptions

Object with parallax parameters or boolean true to enable with default settings.

Example

const swiper = new Swiper('.swiper', {
  parallax: true,
});

`Optional`part

part?: string

See

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part

`Optional`passiveListeners

passiveListeners?: boolean

Passive event listeners will be used by default where possible to improve scrolling performance on mobile devices. But if you need to use e.preventDefault and you have conflict with it, then you should disable this parameter

Default

true

`Optional`popover

popover?: "" | "auto" | "manual" | "hint"

`Optional`popoverTarget

popoverTarget?: string

`Optional`popoverTargetAction

popoverTargetAction?: "toggle" | "show" | "hide"

`Optional`prefix

prefix?: string

`Optional`preventClicks

preventClicks?: boolean

Set to true to prevent accidental unwanted clicks on links during swiping

Default

true

`Optional`preventClicksPropagation

preventClicksPropagation?: boolean

Set to true to stop clicks event propagation on links during swiping

Default

true

`Optional`preventInteractionOnTransition

preventInteractionOnTransition?: boolean

When enabled it won't allow to change slides by swiping or navigation/pagination buttons during transition

Default

false

`Optional`property

property?: string

`Optional`radioGroup

radioGroup?: string

`Optional`rel

rel?: string

`Optional`resistance

resistance?: boolean

Set to false if you want to disable resistant bounds

Default

true

`Optional`resistanceRatio

resistanceRatio?: number

This option allows you to control resistance ratio

Default

0.85

`Optional`resizeObserver

resizeObserver?: boolean

When enabled it will use ResizeObserver (if supported by browser) on swiper container to detect container resize (instead of watching for window resize)

Default

true

`Optional`resource

resource?: string

`Optional`results

results?: number

`Optional`rev

rev?: string

`Optional`rewind

rewind?: boolean

Set to true to enable "rewind" mode. When enabled, clicking "next" navigation button (or calling .slideNext()) when on last slide will slide back to the first slide. Clicking "prev" navigation button (or calling .slidePrev()) when on first slide will slide forward to the last slide.

Default

false

Note

Should not be used together with loop mode

`Optional`role

role?: AriaRole

`Optional`roundLengths

roundLengths?: boolean

Set to true to round values of slides width and height to prevent blurry texts on usual resolution screens (if you have such)

Default

false

`Optional`runCallbacksOnInit

runCallbacksOnInit?: boolean

Fire Transition/SlideChange/Start/End events on swiper initialization. Such events will be fired on initialization in case of your initialSlide is not 0, or you use loop mode

Default

true

`Optional`scrollbar

scrollbar?: boolean | ScrollbarOptions

Object with scrollbar parameters or boolean true to enable with default settings.

Example

const swiper = new Swiper('.swiper', {
  scrollbar: {
    el: '.swiper-scrollbar',
    draggable: true,
  },
});

`Optional`security

security?: string

`Optional`setWrapperSize

setWrapperSize?: boolean

Enabled this option and plugin will set width/height on swiper wrapper equal to total size of all slides. Mostly should be used as compatibility fallback option for browser that don't support flexbox layout well

Default

false

`Optional`shortSwipes

shortSwipes?: boolean

Set to false if you want to disable short swipes

Default

true

`Optional`simulateTouch

simulateTouch?: boolean

If true, Swiper will accept mouse events like touch events (click and drag to change slides)

Default

true

`Optional`slideActiveClass

slideActiveClass?: string

CSS class name of currently active slide

Default

'swiper-slide-active'

Note

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Note

Not supported in Swiper React/Vue components

`Optional`slideBlankClass

slideBlankClass?: string

CSS class name of the blank slide added by the loop mode (when loopAddBlankSlides is enabled)

Default

'swiper-slide-blank'

Note

Not supported in Swiper React/Vue

`Optional`slideClass

slideClass?: string

CSS class name of slide

Default

'swiper-slide'

Note

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Note

Not supported in Swiper React/Vue components

`Optional`slideFullyVisibleClass

slideFullyVisibleClass?: string

CSS class name of fully (when whole slide is in the viewport) visible slide

Default

'swiper-slide-fully-visible'

Note

Not supported in Swiper React/Vue

`Optional`slideNextClass

slideNextClass?: string

CSS class name of slide which is right after currently active slide

Default

'swiper-slide-next'

Note

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Note

Not supported in Swiper React/Vue

`Optional`slidePrevClass

slidePrevClass?: string

CSS class name of slide which is right before currently active slide

Default

'swiper-slide-prev'

Note

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Note

Not supported in Swiper React/Vue

`Optional`slidesOffsetAfter

slidesOffsetAfter?: number

Add (in px) additional slide offset in the end of the container (after all slides)

Default

`Optional`slidesOffsetBefore

slidesOffsetBefore?: number

Add (in px) additional slide offset in the beginning of the container (before all slides)

Default

`Optional`slidesPerGroup

slidesPerGroup?: number

Set numbers of slides to define and enable group sliding. Useful to use with slidesPerView > 1

Default

`Optional`slidesPerGroupAuto

slidesPerGroupAuto?: boolean

This param intended to be used only with slidesPerView: 'auto' and slidesPerGroup: 1. When enabled, it will skip all slides in view on .slideNext() & .slidePrev() methods calls, on Navigation "buttons" clicks and in autoplay.

Default

false

`Optional`slidesPerGroupSkip

slidesPerGroupSkip?: number

The parameter works in the following way: If slidesPerGroupSkip equals 0 (default), no slides are excluded from grouping, and the resulting behaviour is the same as without this change.

If slidesPerGroupSkip is equal or greater than 1 the first X slides are treated as single groups, whereas all following slides are grouped by the slidesPerGroup value.

Default

`Optional`slidesPerView

slidesPerView?: number | "auto"

Number of slides per view (slides visible at the same time on slider's container).

Note

slidesPerView: 'auto' is currently not compatible with multirow mode, when grid.rows > 1

Default

`Optional`slideToClickedSlide

slideToClickedSlide?: boolean

Set to true and click on any slide will produce transition to this slide

Default

false

`Optional`slideVisibleClass

slideVisibleClass?: string

CSS class name of currently/partially visible slide

Default

'swiper-slide-visible'

Note

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Note

Not supported in Swiper React/Vue

`Optional`slot

slot?: string

`Optional`snapToSlideEdge

snapToSlideEdge?: boolean

When enabled, the swiper will always snap to slide edges rather than arbitrary positions. This prevents partial slides from appearing misaligned at the end of the swiper. Only applies when slidesPerView is fractional or 'auto', and is ignored in loop and centeredSlides modes.

Default

false

`Optional`spaceBetween

spaceBetween?: string | number

Distance between slides in px.

Default

Note

If you use "margin" css property to the elements which go into Swiper in which you pass "spaceBetween" into, navigation might not work properly.

`Optional`speed

speed?: number

Duration of transition between slides (in ms)

Default

`Optional`spellCheck

spellCheck?: Booleanish

`Optional`style

style?: CSSProperties

`Optional`suppressContentEditableWarning

suppressContentEditableWarning?: boolean

`Optional`suppressHydrationWarning

suppressHydrationWarning?: boolean

`Optional`swipeHandler

swipeHandler?: CSSSelector | HTMLElement | null

String with CSS selector or HTML element of the container with pagination that will work as only available handler for swiping

Default

null

`Optional`swiperElementNodeName

swiperElementNodeName?: string

The name of the swiper element node name; used for detecting web component rendering

Default

'SWIPER-CONTAINER'

`Optional`tabIndex

tabIndex?: number

`Optional`tag

tag?: string

`Optional`threshold

threshold?: number

Threshold value in px. If "touch distance" will be lower than this value then swiper will not move

Default

`Optional`thumbs

thumbs?: ThumbsOptions

Object with thumbs component parameters

Example

const swiper = new Swiper('.swiper', {
  ...
  thumbs: {
    swiper: thumbsSwiper
  }
});

`Optional`title

title?: string

`Optional`touchAngle

touchAngle?: number

Allowable angle (in degrees) to trigger touch move

Default

`Optional`touchEventsTarget

touchEventsTarget?: "container" | "wrapper"

Target element to listen touch events on. Can be 'container' (to listen for touch events on swiper) or 'wrapper' (to listen for touch events on swiper-wrapper)

Default

'wrapper'

`Optional`touchMoveStopPropagation

touchMoveStopPropagation?: boolean

If enabled, then propagation of "touchmove" will be stopped

Default

false

`Optional`touchRatio

touchRatio?: number

Touch ratio

Default

`Optional`touchReleaseOnEdges

touchReleaseOnEdges?: boolean

Enable to release touch events on slider edge position (beginning, end) to allow for further page scrolling. This feature works only with "touch" events (and not pointer events), so it will work on iOS/Android devices and won't work on Windows devices with pointer events. Also threshold parameter must be set to 0

Default

false

`Optional`touchStartForcePreventDefault

touchStartForcePreventDefault?: boolean

Force to always prevent default for touchstart (pointerdown) event

Default

false

`Optional`touchStartPreventDefault

touchStartPreventDefault?: boolean

If disabled, pointerdown event won't be prevented

Default

true

`Optional`translate

translate?: "yes" | "no"

`Optional`typeof

typeof?: string

`Optional`uniqueNavElements

uniqueNavElements?: boolean

If enabled (by default) and navigation elements' parameters passed as a string (like ".pagination") then Swiper will look for such elements through child elements first. Applies for pagination, prev/next buttons and scrollbar elements

Default

true

`Optional`unselectable

unselectable?: "off" | "on"

`Optional`updateOnWindowResize

updateOnWindowResize?: boolean

Swiper will recalculate slides position on window resize (orientationchange)

Default

true

`Optional`url

url?: string | null

Required for active slide detection when rendered on server-side and enabled history

Default

null

`Optional`userAgent

userAgent?: string | null

userAgent string. Required for browser/device detection when rendered on server-side

Default

null

`Optional`virtual

virtual?: boolean | VirtualOptions<unknown>

Enables virtual slides functionality. Object with virtual slides parameters or boolean true to enable with default settings.

Example

const swiper = new Swiper('.swiper', {
  virtual: {
    slides: ['Slide 1', 'Slide 2', 'Slide 3', 'Slide 4', 'Slide 5'],
  },
});

`Optional`virtualTranslate

virtualTranslate?: boolean

Enabled this option and swiper will be operated as usual except it will not move, real translate values on wrapper will not be set. Useful when you may need to create custom slide transition

Default

false

`Optional`vocab

vocab?: string

`Optional`watchOverflow

watchOverflow?: boolean

When enabled Swiper will be disabled and hide navigation buttons on case there are not enough slides for sliding.

Default

true

`Optional`watchSlidesProgress

watchSlidesProgress?: boolean

Enable this feature to calculate each slides progress and visibility (slides in viewport will have additional visible class)

Default

false

`Optional`width

width?: number | null

Swiper width (in px). Parameter allows to force Swiper width. Useful only if you initialize Swiper when it is hidden and in SSR and Test environments for correct Swiper initialization

Default

null

Note

Setting this parameter will make Swiper not responsive

`Optional`wrapperClass

wrapperClass?: string

CSS class name of slides' wrapper

Default

'swiper-wrapper'

Note

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Note

Not supported in Swiper React/Vue

`Optional`wrapperTag

wrapperTag?: string

`Optional`zoom

zoom?: boolean | ZoomOptions

Enables zooming functionality. Object with zoom parameters or boolean true to enable with default settings

Example

const swiper = new Swiper('.swiper', {
  zoom: {
    maxRatio: 5,
  },
});

Methods

`Optional`onAny

onAny?(eventName: string, ...args: any[]): void
Parameters
- eventName: string
- ...args: any[]
Returns void
Inherited from SwiperOptions.onAny
- Defined in swiper/core/core.d.ts:12

Interface SwiperProps

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Optional_emitClasses

Optional_loopSwapReset

Optionala11y

Example

Optionalabout

OptionalaccessKey

OptionalallowSlideNext

Default

OptionalallowSlidePrev

Default

OptionalallowTouchMove

Default

Optionalaria-activedescendant

Optionalaria-atomic

Optionalaria-autocomplete

Optionalaria-braillelabel

See

Optionalaria-brailleroledescription

See

Optionalaria-busy

Optionalaria-checked

See

Optionalaria-colcount

See

Optionalaria-colindex

See

Optionalaria-colindextext

See

Optionalaria-colspan

See

Optionalaria-controls

See

Optionalaria-current

Optionalaria-describedby

See

Optionalaria-description

See

Optionalaria-details

See

Optionalaria-disabled

See

Optionalaria-dropeffect

Deprecated

Optionalaria-errormessage

See

Optionalaria-expanded

Optionalaria-flowto

Optionalaria-grabbed

Deprecated

Optionalaria-haspopup

Optionalaria-hidden

See

Optionalaria-invalid

See

Optionalaria-keyshortcuts

Optionalaria-label

See

Optionalaria-labelledby

See

Optionalaria-level

Optionalaria-live

Optionalaria-modal

Optionalaria-multiline

Optionalaria-multiselectable

Optionalaria-orientation

Optionalaria-owns

See

Optionalaria-placeholder

Optionalaria-posinset

See

Optionalaria-pressed

See

Optionalaria-readonly

See

`Optional`_emitClasses

`Optional`_loopSwapReset

`Optional`a11y

`Optional`about

`Optional`accessKey

`Optional`allowSlideNext

`Optional`allowSlidePrev

`Optional`allowTouchMove

`Optional`aria-activedescendant

`Optional`aria-atomic

`Optional`aria-autocomplete

`Optional`aria-braillelabel

`Optional`aria-brailleroledescription

`Optional`aria-busy

`Optional`aria-checked

`Optional`aria-colcount

`Optional`aria-colindex

`Optional`aria-colindextext

`Optional`aria-colspan

`Optional`aria-controls

`Optional`aria-current

`Optional`aria-describedby

`Optional`aria-description

`Optional`aria-details

`Optional`aria-disabled

`Optional`aria-dropeffect

`Optional`aria-errormessage

`Optional`aria-expanded

`Optional`aria-flowto

`Optional`aria-grabbed

`Optional`aria-haspopup

`Optional`aria-hidden

`Optional`aria-invalid

`Optional`aria-keyshortcuts

`Optional`aria-label

`Optional`aria-labelledby

`Optional`aria-level

`Optional`aria-live

`Optional`aria-modal

`Optional`aria-multiline

`Optional`aria-multiselectable

`Optional`aria-orientation

`Optional`aria-owns

`Optional`aria-placeholder

`Optional`aria-posinset

`Optional`aria-pressed

`Optional`aria-readonly

`Optional`aria-relevant

`Optional`aria-required

`Optional`aria-roledescription

`Optional`aria-rowcount

`Optional`aria-rowindex

`Optional`aria-rowindextext

`Optional`aria-rowspan

`Optional`aria-selected

`Optional`aria-setsize

`Optional`aria-sort

`Optional`aria-valuemax

`Optional`aria-valuemin

`Optional`aria-valuenow

`Optional`aria-valuetext

`Optional`autoCapitalize

`Optional`autoCorrect

`Optional`autoFocus

`Optional`autoHeight

`Optional`autoplay

`Optional`autoSave

`Optional`breakpoints

`Optional`breakpointsBase

`Optional`cardsEffect

`Optional`centeredSlides

`Optional`centeredSlidesBounds

`Optional`centerInsufficientSlides

`Optional`children

`Optional`className

`Optional`color

`Optional`containerModifierClass

`Optional`content

`Optional`contentEditable

`Optional`contextMenu