Module kanata_keyberon::action

The different actions that can be executed via any given key.

Re-exports

• pub use switch::*;

Modules

• switch
  Handle processing of the switch action for Keyberon.

Structs

• ChordsGroup
  A group of chords (actions mapped to a combination of multiple physical keys pressed together).
• ForkConfig
  An action that can do one of two actions. The left action is the default. The right action will trigger if any of the key codes in right_triggers are active in the current layout state.
• HoldTapAction
  Perform different actions on key hold/tap.
• OneShot
  Define one shot key behaviour.
• TapDance
  Define tap dance behaviour.

Enums

• Action
  The different actions that can be done.
• HoldTapConfig
  Behavior configuration of HoldTap.
• OneShotEndConfig
  Determine the ending behaviour of the one shot key.
• ReleasableState
  A state that that can be released from the active states via the ReleaseState action.
• SequenceEvent
  The different types of actions we support for key sequences/macros
• TapDanceConfig
  Determines the behaviour for a TapDance.

Constants

• MAX_CHORD_KEYS
  Defines the maximum number of (virtual) keys that can be used in a single chords group.
• ONE_SHOT_MAX_ACTIVE
  Defines the maximum number of one shot keys that can be combined.

Functions

• d
  A shortcut to create a Action::DefaultLayer, useful to create compact layout.
• k
  A shortcut to create a Action::KeyCode, useful to create compact layout.
• l
  A shortcut to create a Action::Layer, useful to create compact layout.

Type Aliases

• ChordKeys
  A set of virtual keys (represented as a bit mask) pressed together. The keys do not directly correspond to physical keys. They are unique to a given [ChordGroup] and their mapping from physical keys is definied in [ChordGroup.coords]. As such, each chord group can effectively have at most 32 different keys (though multiple physical keys may be mapped to the same virtual key).