Interface ICommandProperties<STATE, CONTEXT>

interface ICommandProperties<STATE, CONTEXT> {
    context?: DynamicContext<CONTEXT>;
    description?: DynamicValue<string, CONTEXT>;
    disabled?: boolean | (() => boolean);
    icon?: DynamicValue<ReactNode, CONTEXT>;
    label?: DynamicValue<string, CONTEXT>;
    scopedLabels?: Record<string, DynamicValue<string, CONTEXT>>;
    shortcut?: IKeyStroke | IKeyStroke[] | (() => IKeyStroke);
    state?: STATE;
    tags?: DynamicValue<string[], CONTEXT>;
}

Type Parameters

  • STATE extends any = void
  • CONTEXT extends any = void

Properties

context? description? disabled? icon? label? scopedLabels? shortcut? state? tags?

Properties

Optional context

context?: DynamicContext<CONTEXT>

Optional description

description?: DynamicValue<string, CONTEXT>

Optional disabled

disabled?: boolean | (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Optional icon

icon?: DynamicValue<ReactNode, CONTEXT>

Optional label

label?: DynamicValue<string, CONTEXT>

Optional scopedLabels

scopedLabels?: Record<string, DynamicValue<string, CONTEXT>>

The ability to override labels for specific context. This is useful for content menus For example 'Rename Sheet' command might only want to be displayed as 'Rename' in the content menu.

Optional shortcut

shortcut?: IKeyStroke | IKeyStroke[] | (() => IKeyStroke)

Type declaration

Optional state

state?: STATE

Optional tags

tags?: DynamicValue<string[], CONTEXT>

Settings

Member Visibility

Theme

On This Page

contextdescriptiondisablediconlabelscopedLabelsshortcutstatetags