API Reference > ui-framework > KeyboardShortcut > KeyboardShortcut KeyboardShortcut Class Keyboard Shortcut used to execute an action Extends ItemDefBase Methods Name Description constructor(props: KeyboardShortcutProps): KeyboardShortcut getShortcut(mapKey: string): undefined | KeyboardShortcut Finds a shortcut with a given key in the shortcut's container itemPicked(): void Called when the ActionButtonItemDef associated with this shortcut is invoked Inherited methods Name Inherited from Description setDescription(v: string | ConditionalStringValue | StringGetter): void ItemDefBase Set the description. setLabel(v: string | ConditionalStringValue | StringGetter): void ItemDefBase Set the label. setTooltip(v: string | ConditionalStringValue | StringGetter): void ItemDefBase Set the tooltip. initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static ItemDefBase Properties Name Type Description id Accessor ReadOnly string Returns the id for this shortcut 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 undefined | ActionButtonItemDef Returns the ActionButtonItemDef associated with this shortcut key Accessor ReadOnly string Gets the keyboard key keyMapKey Accessor ReadOnly string Returns the shortcut's key map key used as the id shortcutContainer Accessor ReadOnly KeyboardShortcutContainer Returns the shortcut container Inherited properties Name Type Inherited from Description applicationData undefined | any ItemDefBase badgeType undefined | BadgeType ItemDefBase description Accessor ReadOnly string ItemDefBase Get the description string iconElement undefined | ReactNode ItemDefBase iconSpec undefined | IconSpec ItemDefBase isActive Accessor boolean ItemDefBase isDisabled boolean | ConditionalBooleanValue ItemDefBase isEnabled boolean ItemDefBase isHidden boolean | ConditionalBooleanValue ItemDefBase isPressed boolean ItemDefBase isVisible boolean ItemDefBase label Accessor ReadOnly string ItemDefBase Get the label string rawLabel Accessor ReadOnly string | ConditionalStringValue | StringGetter 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 ui/framework/src/ui-framework/keyboardshortcut/KeyboardShortcut.ts Line 43 Last Updated: 29 November, 2022