SheetXL - v0.3.20
    Preparing search index...

    Interface StandaloneWorkbookProps

    Properties for the StandaloneWorkbook component.

    interface StandaloneWorkbookProps {
        autoFocus?: boolean | FocusOptions;
        commands?: IGroup;
        contextMenuSx?: SxProps<Theme>;
        createWorkbookOptions?: ConstructorOptions;
        errorPanel?: ComponentType<ErrorPanelProps>;
        forceLightImages?: boolean;
        formulaBarProps?: FormulaBarProps;
        gridTheme?: Theme;
        headersTheme?: Theme;
        importExportDisabled?: boolean;
        licenseKey?: string;
        loadingPanelProps?: LoadingPanelProps;
        logo?: ReactNode;
        notifier?: Notifier;
        onElementLoad?: (event: WorkbookLoadEvent) => void;
        onError?: (error: any) => void;
        onNewWorkbook?: () => void;
        onRepeatCommandChange?: (command: ICommand<any, any>) => void;
        onTitleChange?: (title: string) => void;
        onWorkbookChange?: (workbook: IWorkbook) => void;
        renderContextMenu?: (props: WorkbookContextMenuProps) => ReactElement;
        renderFilterMenu?: (props: FilterColumnMenuProps) => ReactElement;
        renderFormulaBar?: (
            props: FormulaBarProps,
            ref: Ref<IFormulaBarElement>,
        ) => ReactElement;
        renderLoadingPanel?: (props: LoadingPanelProps) => ReactElement;
        renderMovableMenu?: (props: MovableContextMenuProps) => ReactElement;
        renderSheet?: (props: SheetProps) => ReactElement;
        renderStatusBar?: (props: StatusBarProps) => ReactElement;
        renderTabs?: (props: WorkbookStripProps) => ReactElement;
        renderToolbar?: (props: WorkbookToolbarsProps) => ReactElement;
        sheetProps?: SheetProps;
        showFormulaBar?: boolean;
        showHorizontalScrollbar?: boolean;
        showStatusBar?: boolean;
        showTabs?: boolean;
        showVerticalScrollbar?: boolean;
        statusBarProps?: StatusBarProps;
        sx?: SxProps<Theme>;
        tabsProps?: WorkbookStripProps;
        themeModeOptions?: ThemeModeOptions;
        title?: string;
        titleProps?: WorkbookTitleProps;
        toolbarProps?: WorkbookToolbarsProps;
        undoManager?: UndoManager;
        workbook?:
            | IWorkbook
            | Promise<IWorkbook>
            | WorkbookHandle
            | ReadWorkbookOptions;
    }

    Hierarchy

    • Omit<WorkbookElementProps, "workbook" | "onError">
      • StandaloneWorkbookProps
    Index

    Properties

    autoFocus? commands? contextMenuSx? createWorkbookOptions? errorPanel? forceLightImages? formulaBarProps? gridTheme? headersTheme? importExportDisabled? licenseKey? loadingPanelProps? logo? notifier? onElementLoad? onError? onNewWorkbook? onRepeatCommandChange? onTitleChange? onWorkbookChange? renderContextMenu? renderFilterMenu? renderFormulaBar? renderLoadingPanel? renderMovableMenu? renderSheet? renderStatusBar? renderTabs? renderToolbar? sheetProps? showFormulaBar? showHorizontalScrollbar? showStatusBar? showTabs? showVerticalScrollbar? statusBarProps? sx? tabsProps? themeModeOptions? title? titleProps? toolbarProps? undoManager? workbook?

    Properties

    autoFocus?: boolean | FocusOptions

    Autofocus on load. If loading multiple workbooks or using an a secondary component this should be set to false.

    false
    commands?: IGroup

    Additional commands provided by application.

    contextMenuSx?: SxProps<Theme>

    Allow for customizations on the context menu.

    createWorkbookOptions?: ConstructorOptions

    Options to use when a new Workbook is created.

    This is ignored if the model is provided externally. The default behavior is to use the options from the current workbook if provided.

    errorPanel?: ComponentType<ErrorPanelProps>

    Allow for a custom error panel to be used for errors.

    ErrorPanel
    forceLightImages?: boolean

    If dark theme then the images will invert unless true.

    false
    formulaBarProps?: FormulaBarProps

    Allow for customizations on FormulaBar.

    gridTheme?: Theme

    Allow you to specify a specific material ui theme for the grid.

    - The current Theme.

    Useful for decorating the application with a single theme (such as dark mode) but render the main grid using a different theme (for example light mode).

    headersTheme?: Theme

    Allow you to specify a specific material ui theme for the headers.

    - The grid theme.
    importExportDisabled?: boolean

    Disable the import export options in the menu.

    licenseKey?: string

    Set the license key via a property

    This will only be used the first time.

    loadingPanelProps?: LoadingPanelProps

    Allow for customizations on loading panel.

    logo?: ReactNode

    Custom logo.

    notifier?: Notifier

    Configure the notifier to use for alerts.

    onElementLoad?: (event: WorkbookLoadEvent) => void

    Callback for when the workbook is loaded. Useful for hiding/showing loading panels.

    onError?: (error: any) => void

    Called if the workbook model is a promise that fails to load.

    Type declaration

      • (error: any): void

      • Parameters

        • error: any

          The error

        Returns void

    onNewWorkbook?: () => void

    Hook to perform a action on new workbook

    Type declaration

      • (): void

      • Returns void

    onRepeatCommandChange?: (command: ICommand<any, any>) => void

    Notify that there is a new repeatable command.

    onTitleChange?: (title: string) => void

    Callback for title changes.

    Type declaration

      • (title: string): void

      • Parameters

        • title: string

          The new title.

        Returns void

    onWorkbookChange?: (workbook: IWorkbook) => void

    Called if the IWorkbook changes.

    Type declaration

      • (workbook: IWorkbook): void

      • Parameters

        • workbook: IWorkbook

          The workbook

        Returns void

    renderContextMenu?: (props: WorkbookContextMenuProps) => ReactElement

    Render custom context menu.

    Type declaration

      • (props: WorkbookContextMenuProps): ReactElement

      • Parameters

        • props: WorkbookContextMenuProps

        Returns ReactElement

        A React Element representing the ContextMenu.

    renderFilterMenu?: (props: FilterColumnMenuProps) => ReactElement

    Render custom filter menu.

    Type declaration

      • (props: FilterColumnMenuProps): ReactElement

      • Parameters

        • props: FilterColumnMenuProps

        Returns ReactElement

        A React Element representing the FilterMenu.

    renderFormulaBar?: (
        props: FormulaBarProps,
        ref: Ref<IFormulaBarElement>,
    ) => ReactElement

    Render FormulaBar.

    Type declaration

      • (props: FormulaBarProps, ref: Ref<IFormulaBarElement>): ReactElement

      • Parameters

        Returns ReactElement

        A React Element representing the FormulaBar.

    renderLoadingPanel?: (props: LoadingPanelProps) => ReactElement

    Render custom loading panel.

    Type declaration

      • (props: LoadingPanelProps): ReactElement

      • Parameters

        • props: LoadingPanelProps

        Returns ReactElement

        A React Element representing the LoadingPane.

    renderMovableMenu?: (props: MovableContextMenuProps) => ReactElement

    Render custom movable menu.

    Type declaration

      • (props: MovableContextMenuProps): ReactElement

      • Parameters

        • props: MovableContextMenuProps

        Returns ReactElement

        A React Element representing the MovableMenu.

    renderSheet?: (props: SheetProps) => ReactElement

    Render custom ISheetElement.

    Type declaration

      • (props: SheetProps): ReactElement

      • Parameters

        • props: SheetProps

        Returns ReactElement

        A React Element representing the Sheet.

    renderStatusBar?: (props: StatusBarProps) => ReactElement

    Pass in a custom toolbar.

    Type declaration

      • (props: StatusBarProps): ReactElement

      • Parameters

        • props: StatusBarProps

        Returns ReactElement

        A React Element representing the StatusBar.

    renderTabs?: (props: WorkbookStripProps) => ReactElement

    Render custom tabs.

    Type declaration

    renderToolbar?: (props: WorkbookToolbarsProps) => ReactElement

    Pass in a custom toolbar.

    Type declaration

      • (props: WorkbookToolbarsProps): ReactElement

      • Parameters

        • props: WorkbookToolbarsProps

        Returns ReactElement

        A React Element representing the Toolbar.

    sheetProps?: SheetProps

    Allow for customizations on loading panel.

    showFormulaBar?: boolean

    Indicate if the formulaBar should be showing.

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

    Show the horizontal scrollbar

    showStatusBar?: boolean

    Shows the statusbar.

    'workbook model but can be overridden'
    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

    statusBarProps?: StatusBarProps

    Customizations for the status bar

    sx?: SxProps<Theme>

    MUI SX props https://mui.com/system/getting-started/the-sx-prop/

    tabsProps?: WorkbookStripProps

    Allow for customizations on tabs.

    themeModeOptions?: ThemeModeOptions

    Standalone workbook will inherit the theme unless this is explicitly set.

    If this is set then there are two additional options that can be provided:

    • onForceModeChange(mode: ThemeMode);
    • onForceLightGridChange(force: boolean);
    • onForceLightImagesChange(force: boolean);
    title?: string

    Title to display.

    none

    If title is null then it is hidden but if it is '' then it is shown with placeholder

    titleProps?: WorkbookTitleProps

    Additional WorkbookTitle properties.

    If onTitleChange or title is provided then the prop versions are ignored

    toolbarProps?: WorkbookToolbarsProps

    Props for the toolbar.

    undoManager?: UndoManager

    Allow for a custom undo manager.

    a new undo manager for each standaloneWorkbook
    workbook?: IWorkbook | Promise<IWorkbook> | WorkbookHandle | ReadWorkbookOptions

    The model to use in the IWorkbookElement.

    If not provided a default model will be created.

    Settings

    Member Visibility

    On This Page

    Properties