Interface IZCircusKey

Represents a key on a keyboard.

interface IZCircusKey {
    code: string;
    lower: string;
    modifier: boolean;
    printable: boolean;
    shift: boolean;
    toggle: boolean;
    upper: string;
}

Properties

code: string

The keycode of the actual key on the keyboard.

lower: string

The key value when the shift key is not pressed and the caps lock key is off.

modifier: boolean

Whether or not the key is a modifier key.

A modifier key is a key that is meant to be used with other keys.

printable: boolean

Whether or not the key is printable.

Printable keys are keys that can be displayed on a document or printer paper.

White space is considered printable so those count here.

shift: boolean

A key that modifies the lower case to upper case.

toggle: boolean

A key that can be toggled on and off.

upper: string

The key value when the shift key is pressed or the caps lock key is on.