Swiper - v14.0.1
    Preparing search index...

    Interface VirtualInternals<T>

    interface VirtualInternals<T = unknown> {
        cache: Record<number, HTMLElement>;
        from: number;
        offset: number;
        slides: T[];
        slidesAfter?: number;
        slidesBefore?: number;
        slidesGrid: number[];
        to: number;
        appendSlide(slide: T | T[]): void;
        prependSlide(slide: T | T[]): void;
        removeAllSlides(): void;
        removeSlide(slideIndexes: number | number[]): void;
        update(
            force?: boolean,
            beforeInit?: boolean,
            forceActiveIndex?: number,
        ): void;
    }

    Type Parameters

    • T = unknown

    Hierarchy (View Summary)

    Index

    Properties

    cache from offset slides slidesAfter? slidesBefore? slidesGrid to

    Methods

    appendSlide prependSlide removeAllSlides removeSlide update

    Properties

    cache: Record<number, HTMLElement>

    Object with cached slides HTML elements, keyed by slide index.

    from: number

    Index of first rendered slide

    offset: number

    Pixel offset applied to virtual slides — left/top depending on direction.

    slides: T[]

    Array with slide items passed by virtual.slides parameter

    slidesAfter?: number

    Number of virtual slides reserved after the active slice.

    slidesBefore?: number

    Number of virtual slides reserved before the active slice. Set on each update and read by core code that translates between virtual indices and DOM positions.

    slidesGrid: number[]

    Snapshot of swiper.slidesGrid taken when the last update ran. Used to detect that the grid changed without a from/to change.

    to: number

    Index of last rendered slide

    Methods

    • Append slide. slides can be a single slide item or array with such slides.

      Parameters

      • slide: T | T[]

      Returns void

      Only for Core version (in React & Vue it should be done by modifying slides array/data/source)

    • Prepend slide. slides can be a single slide item or array with such slides.

      Parameters

      • slide: T | T[]

      Returns void

      Only for Core version (in React & Vue it should be done by modifying slides array/data/source)

    • Remove all slides

      Returns void

      Only for Core version (in React & Vue it should be done by modifying slides array/data/source)

    • Remove specific slide or slides. slideIndexes can be a number with slide index to remove or array with indexes.

      Parameters

      • slideIndexes: number | number[]

      Returns void

      Only for Core version (in React & Vue it should be done by modifying slides array/data/source)

    • Update virtual slides state.

      Parameters

      • Optionalforce: boolean

        re-render even if the slice didn't move

      • OptionalbeforeInit: boolean

        internal flag set by the module during beforeInit

      • OptionalforceActiveIndex: number

        override swiper.activeIndex when computing the slice

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods