Interface CommandButtonOptions<STATE, CONTEXT>

interface CommandButtonOptions<STATE, CONTEXT> {
    commandHook?: ICommandHook<STATE, CONTEXT>;
    commandState?: STATE;
    context?: CONTEXT;
    disableHover?: boolean;
    disabled?: boolean;
    icon?: ReactNode | (() => ReactNode);
    scope?: string;
    selected?: boolean;
    sx?: SxProps<Theme>;
    variant?: CommandButtonType;
}

Type Parameters

  • STATE = any
  • CONTEXT = any

Hierarchy (view full)

Properties

commandHook? commandState? context? disableHover? disabled? icon? scope? selected? sx? variant?

Properties

Optional commandHook

commandHook?: ICommandHook<STATE, CONTEXT>

Allow for listeners against a specific buttons execute rather than the command. This is useful when know the specific button that executed a command is required. (For example when closing menus or restoring focus)

Optional commandState

commandState?: STATE

Optional state for this specific command button.

Default Value

to undefined

Optional context

context?: CONTEXT

Optional disableHover

disableHover?: boolean

Optional disabled

disabled?: boolean

Optional icon

icon?: ReactNode | (() => ReactNode)

Type declaration

    • (): ReactNode

    • Returns ReactNode

Optional scope

scope?: string

Optional string to enable the command label to be configured based on the scope of how it is being used.

Optional selected

selected?: boolean

Optional sx

sx?: SxProps<Theme>

MUI SX props

See

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

Optional variant

variant?: CommandButtonType

How the button will be styles.

Default Value

CommandButtonType.Toolbar

Settings

Member Visibility

Theme

On This Page

commandHookcommandStatecontextdisableHoverdisablediconscopeselectedsxvariant