Class Keybind

constructor

• new Keybind(
      keys: {
          alt: boolean;
          ctrl: boolean;
          key: string | number;
          meta: boolean;
          shift: boolean;
      },
      variations: any,
  ): Keybind

  Create a keybind

  Parameters

  • keys: {
        alt: boolean;
        ctrl: boolean;
        key: string | number;
        meta: boolean;
        shift: boolean;
    }

    Set up the default keys that need to be pressed

    • alt: boolean

      Alt key

    • ctrl: boolean

      Control key. On MacOS this automatically works for Cmd

    • key: string | number

      Main key. Check keycode.info to find out the numeric value, or simply use letters for letter keys

    • meta: boolean

      Meta key

    • shift: boolean

      Shift key

  • variations: any

  Returns Keybind

action

alt

conflict

ctrl

key

label

meta

shift

sub_id

variations

additionalModifierTriggered

• additionalModifierTriggered(event: any, variation: any): string | true

  Parameters

  • event: any
  • variation: any

  Returns string | true

clear

• clear(): this

  Returns this

getCode

• getCode(key: any): string

  Parameters

  • key: any

  Returns string

getText

• getText(colorized?: boolean): string

  Parameters

  • Optionalcolorized: boolean

  Returns string

hasKey

• hasKey(): boolean

  Returns boolean

isTriggered

• isTriggered(event: any): boolean

  Parameters

  • event: any

  Returns boolean

record

• record(): this

  Returns this

save

• save(save: any): this

  Parameters

  • save: any

  Returns this

set

• set(keys: any, dflt: any): this

  Parameters

  • keys: any
  • dflt: any

  Returns this

setAction

• setAction(id: any, sub_id: any): this

  Parameters

  • id: any
  • sub_id: any

  Returns this

setConflict

• setConflict(): this

  Returns this

stopRecording

• stopRecording(): this

  Returns this

toString

• toString(): string

  Returns string