flip-turn.js API reference
    Preparing search index...

    Type Alias FlipTurnApi

    type FlipTurnApi = {
        update: (options: Partial<FlipTurnOptions>) => FlipTurnApi;
        options: () => ResolvedFlipTurnOptions;
        page: (pageNumber?: number) => number;
        display: (displayMode?: DisplayMode) => DisplayMode;
        next: () => boolean;
        previous: () => boolean;
        size: (
            width?: number | null,
            height?: number | null,
        ) => FlipTurnApi | { width: number | null; height: number | null };
        setPages: (pages: PageSourceInput[]) => FlipTurnApi;
        addPage: (pageSource: PageSourceInput, pageNumber?: number) => FlipTurnApi;
        removePage: (pageNumber: number) => FlipTurnApi;
        stop: () => void;
        animating: () => boolean;
        subscribe: (
            eventName: FlipTurnLifecycleEvent,
            listener: FlipTurnEventListener,
        ) => EventSubscription;
        disable: () => void;
        enable: () => void;
        destroy: () => void;
    }
    Index

    Properties

    update: (options: Partial<FlipTurnOptions>) => FlipTurnApi
    page: (pageNumber?: number) => number
    display: (displayMode?: DisplayMode) => DisplayMode
    next: () => boolean
    previous: () => boolean
    size: (
        width?: number | null,
        height?: number | null,
    ) => FlipTurnApi | { width: number | null; height: number | null }
    setPages: (pages: PageSourceInput[]) => FlipTurnApi
    addPage: (pageSource: PageSourceInput, pageNumber?: number) => FlipTurnApi
    removePage: (pageNumber: number) => FlipTurnApi
    stop: () => void
    animating: () => boolean
    subscribe: (
        eventName: FlipTurnLifecycleEvent,
        listener: FlipTurnEventListener,
    ) => EventSubscription
    disable: () => void
    enable: () => void
    destroy: () => void