Micrio Client - v6.0.0
    Preparing search index...

    Class GallerySwiper

    Handles swipe gestures for navigating image sequences, particularly for swipe galleries and Omni object rotation.

    Marcel Duin marcel@micr.io

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    • Creates a GallerySwiper instance.

      Parameters

      • micrio: HTMLMicrioElement

        The main HTMLMicrioElement instance.

      • length: number

        The total number of images/frames in the sequence.

      • goto: (i: number) => void

        Callback function to navigate to a specific index.

      • opts: { continuous?: boolean; coverLimit?: boolean; sensitivity?: number } = {}

        Swiper options: sensitivity, continuous looping, coverLimit.

      Returns GallerySwiper

    Properties

    goto: (i: number) => void

    Callback function to navigate to a specific index.

    Accessors

    • get currentIndex(): number

      Getter for the current active image/frame index from the engine.

      Returns number

    Methods

    • Animates smoothly to a target index using requestAnimationFrame.

      Parameters

      • idx: number

        The target index.

      Returns void

    • Cleans up event listeners when the swiper is destroyed.

      Returns void