HTML Flip Book - v0.0.0-alpha.36
    Preparing search index...

    Interface ToolbarContextValue

    interface ToolbarContextValue {
        currentPage: number;
        direction: "rtl" | "ltr";
        downloadExecutorRef: MutableRefObject<
            ((from?: number, to?: number) => void)
            | null,
        >;
        flipBookRef: RefObject<FlipBookHandle | null>;
        fullscreenTargetRef?: RefObject<HTMLElement | null>;
        isFirstPage: boolean;
        isLastPage: boolean;
        locale: Locale;
        of: string | number;
        openDownloadMenuRef: MutableRefObject<(() => void) | null>;
        pageSemantics?: any;
        totalPages: number;
    }
    Index

    Properties

    currentPage direction downloadExecutorRef flipBookRef fullscreenTargetRef? isFirstPage isLastPage locale of openDownloadMenuRef pageSemantics? totalPages

    Properties

    currentPage: number
    direction: "rtl" | "ltr"
    downloadExecutorRef: MutableRefObject<
        ((from?: number, to?: number) => void)
        | null,
    >

    Ref set by DownloadDropdown: (from?, to?) => void to run download (entire book or range). Used by download command.

    flipBookRef: RefObject<FlipBookHandle | null>
    fullscreenTargetRef?: RefObject<HTMLElement | null>

    When set (via Toolbar fullscreenTargetRef), fullscreen targets this container (e.g. sefer + toolbar).

    isFirstPage: boolean
    isLastPage: boolean
    locale: Locale

    Locale for UI strings (toolbar, download menu). Defaults to en-US.

    of: string | number

    "Of" value from the book (for page indicator). Sourced from FlipBook ref.

    openDownloadMenuRef: MutableRefObject<(() => void) | null>

    Ref used by openDownloadMenu command (Ctrl+S) to open the download dropdown. DownloadDropdown sets this.

    pageSemantics?: any
    totalPages: number

    Settings

    Member Visibility

    On This Page

    Properties