typograph-editor-documentation
    Preparing search index...

    Interface page_bar_options

    interface page_bar_options {
        allow_delete?: boolean;
        allow_reorder?: boolean;
        mode?: "narrow" | "overlay";
        show_add_page?: boolean;
        show_name?: boolean;
        show_page_number?: boolean;
        visible?: boolean;
    }
    Index
    allow_delete? allow_reorder? mode? show_add_page? show_name? show_page_number? visible?
    allow_delete?: boolean

    Offer a delete control on the selected page, which asks before it deletes. Never offered for the last page. Default false (TYP-817).

    allow_reorder?: boolean

    Let the user re-order pages by dragging them in the page bar. Default false (TYP-816).

    mode?: "narrow" | "overlay"

    Whether the open page bar narrows the canvas ('narrow', the default) or lies over a full-width canvas ('overlay', the behaviour before 20261022.3) (TYP-999). At runtime: typograph.set_page_bar_mode().

    Optionalshow_add_page

    show_add_page?: boolean

    Offer the "new page" control. Stating this wins over canvas's own viewer-mode rule.

    show_name?: boolean

    Show each page's name. Templates carry authoring names a product may not want shown.

    Optionalshow_page_number

    show_page_number?: boolean

    Show the page-number badge.

    visible?: boolean

    Show the page bar at all. Default true — it is the viewer's only navigation.

    Settings
    Member Visibility

    On This Page
    Properties