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

    Interface WorkbookElementProps

    Properties and methods available on the workbook element.

    interface WorkbookElementProps {
        autoFocus?: boolean | FocusOptions;
        colorScheme?: ThemeMode;
        editable?: SheetEditable;
        focusNameBox?: () => void;
        gridColorScheme?: ThemeMode;
        onWorkbookLoad?: (event: WorkbookLoadEvent) => void | Promise<void>;
        propsContextMenu?: any;
        propsFloatPanel?: Partial<FloatPanelProps>;
        propsSheet?: Partial<SheetElementProps>;
        propsTabs?: Partial<WorkbookStripProps>;
        propsWorkbookLoading?: Partial<LoadingPanelProps>;
        ref?: Ref<IWorkbookElement>;
        renderColumnMenu?: (props: any) => ReactElement;
        renderContextMenu?: (props: any) => ReactElement;
        renderFillMenu?: (props: any) => ReactElement;
        renderFloatPanel?: RenderFloatPanel;
        renderMovableMenu?: (props: any) => ReactElement;
        renderSheet?: (props: SheetElementProps) => ReactElement;
        renderTabs?: (props: WorkbookStripProps) => ReactElement;
        renderWorkbookError?: (props: ErrorPanelProps) => ReactElement;
        renderWorkbookLoading?: (props: LoadingPanelProps) => ReactElement;
        showHorizontalScrollbar?: boolean;
        showTabs?: boolean;
        showVerticalScrollbar?: boolean;
        undoManager?: UndoManager;
        workbook?: IWorkbook | Promise<IWorkbook> | ReadOptions;
        wrapperMain?: (children: ReactNode) => ReactElement;
    }

    Hierarchy

    • Omit<React.HTMLAttributes<HTMLDivElement>, "autoFocus">
    • Attributes
      • WorkbookElementProps
    Index
    autoFocus? colorScheme? editable? focusNameBox? gridColorScheme? onWorkbookLoad? propsContextMenu? propsFloatPanel? propsSheet? propsTabs? propsWorkbookLoading? ref? renderColumnMenu? renderContextMenu? renderFillMenu? renderFloatPanel? renderMovableMenu? renderSheet? renderTabs? renderWorkbookError? renderWorkbookLoading? showHorizontalScrollbar? showTabs? showVerticalScrollbar? undoManager? workbook? wrapperMain?
    autoFocus?: boolean | FocusOptions

    Will autofocus to the sheet.

    false
    colorScheme?: ThemeMode

    Controlled override for the app (chrome) light/dark scheme. When omitted, the workbook self-sources it from the shared appearance preference (ThemeStateKey.Mode, resolved via prefers-color-scheme).

    editable?: SheetEditable

    The app-created editor for the new always-mounted cell editor. Pass the SAME stable IEditable instance here and to the formula bar for free two-way sync; this forwards it to the sheet's editor layer.

    focusNameBox?: () => void

    Focus the formula-bar name box (Alt+F3 / activeNameBox) — a bridge from a host shell (e.g. studio) to the workbook-ops command, until the name box has a react home. Wired into the per-workbook command scope's workbook commands.

    gridColorScheme?: ThemeMode

    Controlled override for the grid-body scheme (stays light in a dark app when Enable Dark Grid is off). When omitted, derived from colorScheme + the ThemeStateKey.DarkGrid preference.

    onWorkbookLoad?: (event: WorkbookLoadEvent) => void | Promise<void>

    Callback for when the workbook is loaded (first render). Useful for hiding/showing loading panels.

    propsContextMenu?: any

    Props for the context menu.

    propsFloatPanel?: Partial<FloatPanelProps>

    Allow for customizations on the floating surface used for the workbook's popups.

    propsSheet?: Partial<SheetElementProps>

    Allow for customizations on the sheet.

    propsTabs?: Partial<WorkbookStripProps>

    Allow for customizations on tabs.

    propsWorkbookLoading?: Partial<LoadingPanelProps>

    Allow for customizations on loading panels.

    ref?: Ref<IWorkbookElement>

    Ref for the workbook element.

    renderColumnMenu?: (props: any) => ReactElement

    Render custom filter/column menu. (chrome - no default)

    renderContextMenu?: (props: any) => ReactElement

    Render custom context menu. (chrome - no default)

    renderFillMenu?: (props: any) => ReactElement

    Render the fill menu a right-drag of the fill handle ends in. (chrome - no default; without it the right-drag is inert)

    renderFloatPanel?: RenderFloatPanel

    Render the floating surface used for the workbook's own popups (e.g. context menus). Defaults to the neutral FloatPanel; UI layers inject a themed surface (e.g. MUI Paper).

    renderMovableMenu?: (props: any) => ReactElement

    Render custom movable menu. (chrome - no default)

    renderSheet?: (props: SheetElementProps) => ReactElement

    Render custom ISheetElement.

    renderTabs?: (props: WorkbookStripProps) => ReactElement

    Render custom tabs.

    renderWorkbookError?: (props: ErrorPanelProps) => ReactElement

    Custom error panel, shown when a Promise / IWorkbookIO.ReadOptions WorkbookElementProps.workbook fails to resolve. Defaults to a minimal message. (Studio supplies a themed panel.)

    renderWorkbookLoading?: (props: LoadingPanelProps) => ReactElement

    Assign a custom loading panel.

    showHorizontalScrollbar?: boolean

    Show the horizontal scrollbar.

    showTabs?: boolean

    This doesn't influence # of tabs just the visibility of the widget.

    'workbook model but can be overridden'
    showVerticalScrollbar?: boolean

    Show the vertical scrollbar.

    undoManager?: UndoManager

    A custom undo manager.

    A TransactionUndoManager bound to the workbook's transaction store.

    workbook?: IWorkbook | Promise<IWorkbook> | ReadOptions

    The workbook to render: a live IWorkbook, a Promise for one, or IWorkbookIO.ReadOptions to read one from a source. If omitted (or an empty object), a default workbook is created. A promise / read-options input shows the loading panel while resolving and the error panel (WorkbookElementProps.renderWorkbookError) on failure.

    This can be accessed (once resolved) via the workbook ref.

    wrapperMain?: (children: ReactNode) => ReactElement

    Allows users to Wrap stage children in Top level Context.

    Settings
    Member Visibility

    On This Page
    Properties