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

    Interface WorkbookStripProps

    MUI flavor of the workbook tab strip. A thin wrapper around the chromeless @sheetxl/react!WorkbookStrip: it delegates all of the tab/scroll/rename machinery and layers on only the MUI-specific chrome — the ripple tab surface, the "all sheets" menu, the per-tab context menu and the tooltip-wrapped scroll buttons — through the strip's render seams.

    interface WorkbookStripProps {
        condensed?: boolean;
        disabled?: boolean;
        onBeforeUserChange?: (index: number) => boolean | void;
        onUserChange?: (index: number) => void;
        propsContextMenu?: Partial<SheetTabMenuProps>;
        propsSheetsAll?: SheetsAllMenuProps;
        propsSheetTab?: Partial<SheetTabProps>;
        readOnly?: boolean;
        renderContextMenu?: (props: SheetTabMenuProps) => ReactElement;
        renderSheetsAll?: (props: SheetsAllMenuProps) => ReactElement;
        renderSheetTab?: (props: SheetTabProps) => ReactElement;
        seam?: boolean;
        workbook: IWorkbook;
    }

    Hierarchy

    • Omit<
          ReactWorkbookStripProps,
          | "renderSheetTab"
          | "onTabContextMenu"
          | "renderScrollButtonStart"
          | "renderScrollButtonEnd"
          | "renderScrollButtonEdge",
      >
      • WorkbookStripProps
    Index
    condensed? disabled? onBeforeUserChange? onUserChange? propsContextMenu? propsSheetsAll? propsSheetTab? readOnly? renderContextMenu? renderSheetsAll? renderSheetTab? seam? workbook
    condensed?: boolean

    Condensed (detached) layout: the strip is separated from the grid — e.g. stacked under the scrollbar on a small screen. The selected tab uses a plain rounded tab (rather than the inverted, open-top shape that reads as part of the grid above) and the scroll buttons are hidden. When false (default) the strip reads as an extension of the grid.

    false
    disabled?: boolean

    If true, the tab strip is disabled.

    false
    onBeforeUserChange?: (index: number) => boolean | void

    Type Declaration

      • (index: number): boolean | void

      • Called when the user has initiated a change to the active tab but before it has been rendered. Return false to cancel.

        Parameters

        • index: number

        Returns boolean | void

    onUserChange?: (index: number) => void

    Type Declaration

      • (index: number): void

      • Called after the tab has been changed.

        Parameters

        • index: number

        Returns void

    propsContextMenu?: Partial<SheetTabMenuProps>

    Allow for customizations on the per-tab context menu.

    propsSheetsAll?: SheetsAllMenuProps

    Allow for customizations on the "all sheets" menu.

    propsSheetTab?: Partial<SheetTabProps>

    Allow for customizations on sheet tabs.

    readOnly?: boolean

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

    !workbook.getProtection().isStructureAllowed()

    renderContextMenu?: (props: SheetTabMenuProps) => ReactElement

    Render a custom per-tab context menu.

    renderSheetsAll?: (props: SheetsAllMenuProps) => ReactElement

    Render a custom "all sheets" menu.

    renderSheetTab?: (props: SheetTabProps) => ReactElement

    Render custom sheet tabs. Defaults to the MUI ripple tab (renderWorkbookSheetTab).

    seam?: boolean

    Draw the strip's segment of the seam framing the grid along its top edge. Off when the row above already draws that seam and nothing visible sits between them: the stacked layout on a touch device, where the scrollbar track is invisible and the tabs would get a second line 2px under the first.

    true
    workbook: IWorkbook

    The workbook. Required — the strip renders this workbook's sheets and cannot function without it.

    Settings
    Member Visibility

    On This Page
    Properties