KeyboardShortcutProps Interface

Properties for a Keyboard Shortcut

Extends

Properties

Name Type Description
isAltKeyRequired undefined | false | true Indicates whether the Alt key required.  
isCtrlKeyRequired undefined | false | true Indicates whether the Ctrl key required.  
isShiftKeyRequired undefined | false | true Indicates whether the Shift key required.  
item undefined | ActionButtonItemDef The item to execute when this shortcut is invoked.  
key string | FunctionKey | SpecialKey The key that invokes the shortcut.  
shortcuts undefined | KeyboardShortcutProps[] Nested array of shortcut props.  

Inherited properties

Name Type Inherited from Description
applicationData undefined | any ItemProps can be used by application to store miscellaneous data.
betaBadge undefined | false | true ItemProps Indicates whether to draw a Beta badge.
iconSpec undefined | IconSpec IconProps CSS class name or SvgSprite for icon
isActive undefined | false | true ItemProps if set, component will be considered "active" an will display an "active stripe" - defaults to false
isEnabled undefined | false | true ItemProps if set, component will be enabled - defaults to true
isPressed undefined | false | true ItemProps if set, component will be considered selected but will NOT display an "active stripe" - defaults to false.
isVisible undefined | false | true ItemProps if set, component will be visible - defaults to true
label string | StringGetter LabelProps if set, it is used to explicitly set the label shown by a component.
labelKey undefined | string LabelProps if set, it is used to define a key that is used to look up a localized string.
stateFunc undefined | (state: Readonly<BaseItemState>) => BaseItemState SyncUiProps  
stateSyncIds undefined | string[] SyncUiProps  
tooltip string | StringGetter TooltipProps used to explicitly set the tooltip shown by a component.
tooltipKey undefined | string TooltipProps if set, it is used to define a key that is used to look up a localized string.

Defined in

Last Updated: 20 September, 2019