SheetXL - v0.3.20
    Preparing search index...

    Interface WorkbookStripProps

    Tab strip that operates on IWorkbook

    interface WorkbookStripProps {
        contextMenuProps?: Partial<SheetTabMenuProps>;
        disabled?: boolean;
        readOnly?: boolean;
        renderContextMenu?: (props: SheetTabMenuProps) => ReactElement;
        renderSheetsAll?: (props: SheetsAllMenuProps) => ReactElement;
        renderSheetTab?: (props: SheetTabProps) => ReactElement;
        sheetsAllProps?: SheetsAllMenuProps;
        sheetTabProps?: Partial<SheetTabProps>;
        sx?: SxProps<Theme>;
        workbook?: IWorkbook;
        onBeforeUserChange(index: number): boolean | void;
        onUserChange(index: number): void;
    }

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
      • WorkbookStripProps
    Index

    Properties

    contextMenuProps? disabled? readOnly? renderContextMenu? renderSheetsAll? renderSheetTab? sheetsAllProps? sheetTabProps? sx? workbook?

    Methods

    onBeforeUserChange? onUserChange?

    Properties

    contextMenuProps?: Partial<SheetTabMenuProps>

    Allow for customizations on context menu

    disabled?: boolean

    If true, the tab strip is disabled

    false
    readOnly?: boolean

    If true then the tab strips can not be modified but can still be selected.

    !models.getProtection().isStructureAllowed()

    This can be set to true but if models.getProtection().isStructureAllowed() is false then false is ignored.

    renderContextMenu?: (props: SheetTabMenuProps) => ReactElement

    Render custom context menu.

    Type declaration

      • (props: SheetTabMenuProps): ReactElement

      • Parameters

        • props: SheetTabMenuProps

        Returns ReactElement

        A React Element representing the ContextMenu.

    renderSheetsAll?: (props: SheetsAllMenuProps) => ReactElement

    Render custom sheet all menu.

    Type declaration

      • (props: SheetsAllMenuProps): ReactElement

      • Parameters

        • props: SheetsAllMenuProps

        Returns ReactElement

        A React Element representing the SheetAllMenu.

    renderSheetTab?: (props: SheetTabProps) => ReactElement

    Render custom sheet tabs.

    Type declaration

      • (props: SheetTabProps): ReactElement

      • Parameters

        • props: SheetTabProps

        Returns ReactElement

        A React Element representing a Tab for a Sheet.

    sheetsAllProps?: SheetsAllMenuProps

    Allow for customizations on context menu

    sheetTabProps?: Partial<SheetTabProps>

    Allow for customizations om sheet tabs.

    sx?: SxProps<Theme>

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

    workbook?: IWorkbook

    The workbook

    Methods

    • Called when the user has initiated a change to the active tab but before it has been rendered. This allows for cleanup events or a chance to cancel the change by returning false.

      Parameters

      • index: number

      Returns boolean | void

    • Called after the tab has been changed.

      Parameters

      • index: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods