Юниверс DG SDK UI
v2.16.0

Интерфейс KeyboardHandlerProps

Свойства обработчика клавиатурных событий.

interface KeyboardHandlerProps {
    altKey?: boolean;
    canHandleKeyDown?: (e: KeyboardEvent) => boolean;
    canHandleKeyPress?: (e: KeyboardEvent) => boolean;
    canHandleKeyUp?: (e: KeyboardEvent) => boolean;
    combinations?: HotKeyManagerConfig[];
    ctrlKey?: boolean;
    forwardRef?: RefObject<HTMLElement>;
    global?: boolean;
    letterKey?: string;
    onKeyDown?: (e: KeyboardEvent) => void;
    onKeyPress?: (e: KeyboardEvent) => void;
    onKeyUp?: (e: KeyboardEvent) => void;
    shiftKey?: boolean;
}
Индекс

Свойства

altKey? canHandleKeyDown? canHandleKeyPress? canHandleKeyUp? combinations? ctrlKey? forwardRef? global? letterKey? onKeyDown? onKeyPress? onKeyUp? shiftKey?

Свойства

Окончание поддержки:2.16.0
altKey?: boolean

Флаг, используется ли alt

необходимо использовать combinations

canHandleKeyDown?: (e: KeyboardEvent) => boolean

Будет ли вызван глобальный обработчик события нажатия на клавишу

Если возвращает false, то обработка события будет передана обработчику ниже по стэку.

Если не задан, то обработчик будет вызван

Объявление типа

    • (e: KeyboardEvent): boolean

    • Параметры

      • e: KeyboardEvent

        Событие клавиатуры

      Возвращает boolean

canHandleKeyPress?: (e: KeyboardEvent) => boolean

Будет ли вызван глобальный обработчик события нажатия на клавишу

Если возвращает false, то обработка события будет передана обработчику ниже по стэку.

Если не задан, то обработчик будет вызван

Объявление типа

    • (e: KeyboardEvent): boolean

    • Параметры

      • e: KeyboardEvent

        Событие клавиатуры

      Возвращает boolean

canHandleKeyUp?: (e: KeyboardEvent) => boolean

Будет ли вызван глобальный обработчик события при отпускании клавиши

Если возвращает false, то обработка события будет передана обработчику ниже по стэку.

Если не задан, то обработчик будет вызван

Объявление типа

    • (e: KeyboardEvent): boolean

    • Параметры

      • e: KeyboardEvent

        Событие клавиатуры

      Возвращает boolean

combinations?: HotKeyManagerConfig[]

Конфигурация горячих клавиш

Окончание поддержки:2.16.0
ctrlKey?: boolean

Флаг, используется ли ctrl

необходимо использовать combinations

forwardRef?: RefObject<HTMLElement>

Ссылка на элемент, для которого обрабатываются события

Окончание поддержки:2.16.0
global?: boolean

Флаг, нужна ли регистрация в глобальном менеджере

пропс устарел. За регистрацию в GlobalHotKeyManager отвечает отсутствие пропса forwardRef.

Окончание поддержки:2.16.0
letterKey?: string

Клавиша

необходимо использовать combinations

onKeyDown?: (e: KeyboardEvent) => void

Обработчик события при нажатой клавише

Объявление типа

    • (e: KeyboardEvent): void

    • Параметры

      • e: KeyboardEvent

        Событие клавиатуры

      Возвращает void

onKeyPress?: (e: KeyboardEvent) => void

Обработчик события нажатия клавиши

Объявление типа

    • (e: KeyboardEvent): void

    • Параметры

      • e: KeyboardEvent

        Событие клавиатуры

      Возвращает void

onKeyUp?: (e: KeyboardEvent) => void

Обработчик события при отпускании клавиши

Объявление типа

    • (e: KeyboardEvent): void

    • Параметры

      • e: KeyboardEvent

        Событие клавиатуры

      Возвращает void

Окончание поддержки:2.16.0
shiftKey?: boolean

Флаг, используется ли shift

необходимо использовать combinations

© Авторские права 2026, Юниверс Дата.

Настройки

Видимость элементов?

На этой странице

Свойства