SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface WorkbookAppOptions

    interface WorkbookAppOptions {
        confirmOnClose?: boolean;
        defaultTheme?: ITheme;
        documentTitle?: string | boolean;
        fromUrl?: boolean;
        io?: IWorkbookIO;
        keyboardGuard?: boolean | string[];
        source?: string | IWorkbook | Promise<IWorkbook> | ReadOptions;
    }

    Hierarchy (View Summary)

    Index
    confirmOnClose? defaultTheme? documentTitle? fromUrl? io? keyboardGuard? source?
    confirmOnClose?: boolean

    When true (default), install a beforeunload guard that prompts the browser's "leave site / unsaved changes" dialog while the workbook is dirty.

    defaultTheme?: ITheme

    Theme for a freshly-created blank workbook (no source).

    documentTitle?: string | boolean

    Manage document.title from the workbook name + a leading ● when there are unsaved changes.

    • true (default): capture the current document.title as the base (e.g. the app name).
    • a string: use it as the base.
    • false: leave document.title alone.

    The title becomes "<name> - <base>" (or just "<base>" for an unnamed workbook), with a leading "● " while dirty.

    fromUrl?: boolean

    When no explicit WorkbookAppOptions.source is given, read ?source / ?title from the URL.

    true
    io?: IWorkbookIO

    IO used to read a source AND as the save commit-source for the dirty marker. Defaults to the shared WorkbookIO (the same instance Studio's file commands use, so the dirty state matches) — most apps don't need to pass this.

    keyboardGuard?: boolean | string[]

    Suppress browser keyboard shortcuts so they don't fire the browser instead of the app.

    • true (default): the DEFAULT_GUARD_KEYS (Ctrl/Cmd + O/S/W/N/T/M) plus Alt+Arrows.
    • a string array: those keys (with Ctrl/Cmd), plus Alt+Arrows.
    • false: don't touch the keyboard.
    source?: string | IWorkbook | Promise<IWorkbook> | ReadOptions

    What to open. A live IWorkbook / Promise for one is used directly; a IWorkbookIO.ReadOptions (or a source string) is read via WorkbookAppOptions.io. If omitted, the ?source (and ?title) URL query is used (see WorkbookAppOptions.fromUrl); with no source at all, a blank workbook is created.

    Settings
    Member Visibility

    On This Page
    Properties