kbind/dist/src/enums/Key.d.ts

Library for working with keybinds

/**
 * Enum representing various keyboard key codes.
 *
 * This enum provides a comprehensive list of keyboard key codes, including
 * alphanumeric keys, function keys, control keys, and special characters.
 * Each key is represented by a string that corresponds to its key code.
 */
declare enum Key {
    Alt = "Alt",
    AltLeft = "AltLeft",
    AltRight = "AltRight",
    ArrowDown = "ArrowDown",
    ArrowLeft = "ArrowLeft",
    ArrowRight = "ArrowRight",
    ArrowUp = "ArrowUp",
    Backquote = "Backquote",
    Backslash = "Backslash",
    Backspace = "Backspace",
    BracketLeft = "BracketLeft",
    BracketRight = "BracketRight",
    CapsLock = "CapsLock",
    Comma = "Comma",
    Control = "Control",
    ControlLeft = "ControlLeft",
    ControlRight = "ControlRight",
    Delete = "Delete",
    Digit0 = "Digit0",
    Digit1 = "Digit1",
    Digit2 = "Digit2",
    Digit3 = "Digit3",
    Digit4 = "Digit4",
    Digit5 = "Digit5",
    Digit6 = "Digit6",
    Digit7 = "Digit7",
    Digit8 = "Digit8",
    Digit9 = "Digit9",
    Minus = "Minus",
    Equal = "Equal",
    End = "End",
    Enter = "Enter",
    Escape = "Escape",
    Home = "Home",
    Insert = "Insert",
    IntlBackslash = "IntlBackslash",
    IntlRo = "IntlRo",
    IntlYen = "IntlYen",
    F1 = "F1",
    F2 = "F2",
    F3 = "F3",
    F4 = "F4",
    F5 = "F5",
    F6 = "F6",
    F7 = "F7",
    F8 = "F8",
    F9 = "F9",
    F10 = "F10",
    F11 = "F11",
    F12 = "F12",
    F13 = "F13",
    F14 = "F14",
    F15 = "F15",
    F16 = "F16",
    F17 = "F17",
    F18 = "F18",
    F19 = "F19",
    F20 = "F20",
    F21 = "F21",
    F22 = "F22",
    F23 = "F23",
    F24 = "F24",
    KeyA = "KeyA",
    KeyB = "KeyB",
    KeyC = "KeyC",
    KeyD = "KeyD",
    KeyE = "KeyE",
    KeyF = "KeyF",
    KeyG = "KeyG",
    KeyH = "KeyH",
    KeyI = "KeyI",
    KeyJ = "KeyJ",
    KeyK = "KeyK",
    KeyL = "KeyL",
    KeyM = "KeyM",
    KeyN = "KeyN",
    KeyO = "KeyO",
    KeyP = "KeyP",
    KeyQ = "KeyQ",
    KeyR = "KeyR",
    KeyS = "KeyS",
    KeyT = "KeyT",
    KeyU = "KeyU",
    KeyV = "KeyV",
    KeyW = "KeyW",
    KeyX = "KeyX",
    KeyY = "KeyY",
    KeyZ = "KeyZ",
    Numpad0 = "Numpad0",
    Numpad1 = "Numpad1",
    Numpad2 = "Numpad2",
    Numpad3 = "Numpad3",
    Numpad4 = "Numpad4",
    Numpad5 = "Numpad5",
    Numpad6 = "Numpad6",
    Numpad7 = "Numpad7",
    Numpad8 = "Numpad8",
    Numpad9 = "Numpad9",
    NumpadAdd = "NumpadAdd",
    NumpadSubtract = "NumpadSubtract",
    NumpadMultiply = "NumpadMultiply",
    NumpadDivide = "NumpadDivide",
    NumpadEqual = "NumpadEqual",
    NumpadDecimal = "NumpadDecimal",
    NumpadComma = "NumpadComma",
    NumpadEnter = "NumpadEnter",
    PageUp = "PageUp",
    PageDown = "PageDown",
    Pause = "Pause",
    Period = "Period",
    Quote = "Quote",
    ScrollLock = "ScrollLock",
    Semicolon = "Semicolon",
    Shift = "Shift",
    ShiftLeft = "ShiftLeft",
    ShiftRight = "ShiftRight",
    Slash = "Slash",
    Space = "Space",
    Tab = "Tab"
}
declare namespace Key {
    /**
     * A type representing the values of the `Key` enum.
     * It allows to use the enum values as string literals.
     */
    type Values = `${Key}`;
}
export default Key;