Interface WorkbookStripProps

Tab strip that operates on IWorkbookModel

interface WorkbookStripProps {
    background?: string;
    borderColor?: string;
    borderWidth?: number;
    commands?: CommandMap;
    contextMenuProps?: SheetTabMenuProps;
    disabled?: boolean;
    gridStyle?: GridStyle;
    gridTheme?: Theme;
    notifier?: Notifier;
    readOnly?: boolean;
    renderContextMenu?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    renderSheetTab?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    renderSheetsAll?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>);
    sheetTabProps?: SheetTabProps;
    sheetsAllProps?: SheetsAllMenuProps;
    sx?: SxProps<Theme>;
    workbookModel?: IWorkbookModel;
    onBeforeUserChange?(index): boolean | void;
    onUserChange?(index): void;
}

Hierarchy

  • HTMLAttributes<HTMLDivElement>
    • WorkbookStripProps

Properties

background? borderColor? borderWidth? commands? contextMenuProps? disabled? gridStyle? gridTheme? notifier? readOnly? renderContextMenu? renderSheetTab? renderSheetsAll? sheetTabProps? sheetsAllProps? sx? workbookModel?

Methods

onBeforeUserChange? onUserChange?

Properties

Optional background

background?: string

Optional borderColor

borderColor?: string

Optional borderWidth

borderWidth?: number

Optional commands

commands?: CommandMap

Optional contextMenuProps

contextMenuProps?: SheetTabMenuProps

Allow for customizations on context menu

Optional disabled

disabled?: boolean

If true, the tab strip is disabled

Default Value

false

Optional gridStyle

gridStyle?: GridStyle

Optional gridTheme

gridTheme?: Theme

Optional notifier

notifier?: Notifier

Optional readOnly

readOnly?: boolean

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

Remarks

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

Default Value

models.getProtection().lockStructure

Optional renderContextMenu

renderContextMenu?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>)

Render custom menu

Type declaration

    • (props): ReactElement<any, string | JSXElementConstructor<any>>

    • Parameters

      Returns ReactElement<any, string | JSXElementConstructor<any>>

Returns

Optional renderSheetTab

renderSheetTab?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>)

Render custom sheet tabs.

Type declaration

    • (props): ReactElement<any, string | JSXElementConstructor<any>>

    • Parameters

      Returns ReactElement<any, string | JSXElementConstructor<any>>

Returns

Optional renderSheetsAll

renderSheetsAll?: ((props) => ReactElement<any, string | JSXElementConstructor<any>>)

Render custom menu

Type declaration

    • (props): ReactElement<any, string | JSXElementConstructor<any>>

    • Parameters

      Returns ReactElement<any, string | JSXElementConstructor<any>>

Returns

Optional sheetTabProps

sheetTabProps?: SheetTabProps

Allow for customizations om sheet tabs.

Optional sheetsAllProps

sheetsAllProps?: SheetsAllMenuProps

Allow for customizations on context menu

Optional sx

sx?: SxProps<Theme>

MUI SX props

See

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

Optional workbookModel

workbookModel?: IWorkbookModel

Methods

Optional onBeforeUserChange

  • onBeforeUserChange(index): boolean | void

  • 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

Optional onUserChange

  • onUserChange(index): void

  • Called after the tab has been changed.

    Parameters

    • index: number

    Returns void

Settings

Member Visibility

Theme

On This Page

backgroundborderColorborderWidthcommandscontextMenuPropsdisabledgridStylegridThemenotifierreadOnlyrenderContextMenurenderSheetTabrenderSheetsAllsheetTabPropssheetsAllPropssxworkbookModelonBeforeUserChangeonUserChange