@witchcraft/spellcraft
    Preparing search index...

    Interface Shortcut<TCommand, TCondition>

    interface Shortcut<
        TCommand extends Command["name"] = Command["name"],
        TCondition extends Condition = Condition,
    > {
        chain: string[][];
        command?: TCommand;
        condition: TCondition;
        enabled: boolean;
        forceUnequal: boolean;
        type: "shortcut";
    }

    Type Parameters

    Index

    Properties

    chain: string[][]

    The chain of key chords that make up the shortcut. Note that this is NOT a unique identifier for shortcuts and cannot be used to compare them if you are making use of the when/context/active options.

    command?: TCommand

    The Command to associate with the shortcut.

    condition: TCondition

    The Condition a shortcut is allowed to be triggered on. If both the command and the shortcut have a condition, both must be met.

    enabled: boolean

    Whether the shortcut is enabled. Defaults to true.

    forceUnequal: boolean

    It is sometimes useful for some shortcuts to not equal or conflict with eachother temporarily.

    Only methods that compare shortcut instances are affected.

    While the property is managed by the manager, it can be safely set then unset if not modifying anything.

    type: "shortcut"