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): KeyboardShortcut | undefined itemPicked(): void Inherited methods Name Inherited from Description setDescription(v: string | StringGetter): void ItemDefBase Set the 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 badgeType undefined | BadgeType ItemDefBase betaBadge boolean ItemDefBase description Accessor ReadOnly string ItemDefBase Get the description string 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 ui/framework/src/ui-framework/keyboardshortcut/KeyboardShortcut.ts Line 82 Last Updated: 13 June, 2024