KeyboardShortcut Class

Keyboard Shortcut used to execute an action

Extends

Methods

Name Description
constructor(props: KeyboardShortcutProps): KeyboardShortcut    
getShortcut(mapKey: string): KeyboardShortcut | undefined    
itemPicked(): void    

Inherited methods

Name Inherited from Description
setLabel(v: string | StringGetter): void ItemDefBase Set the label.
setTooltip(v: string | StringGetter): void ItemDefBase Set the tooltip.
initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static ItemDefBase  

Properties

Name Type Description
id Accessor ReadOnly string    
isAltKeyRequired Accessor ReadOnly boolean Gets whether the Alt key required.  
isCtrlKeyRequired Accessor ReadOnly boolean Gets whether the Ctrl key required.  
isFunctionKey Accessor ReadOnly boolean Gets whether this is a Function key.  
isShiftKeyRequired Accessor ReadOnly boolean Gets whether the Shift key required.  
isSpecialKey Accessor ReadOnly boolean Gets whether this is a Special key.  
item Accessor ReadOnly ActionButtonItemDef | undefined    
key Accessor ReadOnly string Gets the keyboard key  
keyMapKey Accessor ReadOnly string    
shortcutContainer Accessor ReadOnly KeyboardShortcutContainer    

Inherited properties

Name Type Inherited from Description
applicationData undefined | any ItemDefBase  
betaBadge boolean ItemDefBase  
iconElement undefined | React.ReactNode ItemDefBase  
iconSpec string | React.ReactNode ItemDefBase  
isActive boolean ItemDefBase  
isEnabled boolean ItemDefBase  
isPressed boolean ItemDefBase  
isVisible boolean ItemDefBase  
label Accessor ReadOnly string ItemDefBase Get the label string
stateFunc undefined | (state: Readonly<BaseItemState>) => BaseItemState ItemDefBase  
stateSyncIds string[] ItemDefBase  
tooltip Accessor ReadOnly string ItemDefBase Get the tooltip string
trayId Accessor ReadOnly undefined ItemDefBase  

Defined in

Last Updated: 20 September, 2019