@witchcraft/spellcraft
    Preparing search index...

    Type Alias KeyInfo

    type KeyInfo = {
        containsConflicting: boolean;
        isModifierHint: boolean;
        modifierEntries: ShortcutInfo[];
        pressableEntries: ShortcutInfo[];
    }
    Index

    Properties

    containsConflicting: boolean

    Depending on the shortcut's list passed, or how conditions and contexts are implemented, it's possible for their to be conflicting shortcuts in certain contexts.

    isModifierHint: boolean

    Indicates there are shortcuts in the modifierEntries, i.e. there are shortcuts that have unpressedModifiers (see ShortcutInfo.hasUnpressedModifiers). You will usually want to have some visual hint the modifier key can be pressed to show more shortcuts.

    modifierEntries: ShortcutInfo[]

    All shortcuts that contain this key and are not pressable but have unpressed modifiers (see ShortcutInfo.hasUnpressedModifiers).

    pressableEntries: ShortcutInfo[]

    All shortcuts that contain this key and are either pressable, pressable chains, or pressed.