mode_keymap

Documentation

Index

• func EnableMode(keymap interface{}, mode string)
• func ForEachKeyBinding(keymap interface{}, f func(b *key.Binding, modes Modes))
• type ModeKeyMap
• type Modes
  • func NewModes(modes []string) Modes
  • func (m Modes) Contains(mode string) bool

Functions

func EnableMode

func EnableMode(keymap interface{}, mode string)

EnableMode enables all key bindings in the given keymap that are tagged with the provided mode.

func ForEachKeyBinding

func ForEachKeyBinding(keymap interface{}, f func(b *key.Binding, modes Modes))

ForEachKeyBinding calls the given function f on every key.Binding in the given keymap, passing the binding and its associated modes. It recurses into nested structs and pointers, extracting all key.Bindings.

Types

type ModeKeyMap

type ModeKeyMap struct {
	Accept key.Binding `keymap-mode:"browse,new"`
	Help   key.Binding `keymap-mode:"*"`
	Exit   key.Binding `keymap-mode:"browse,new"`
	Cancel key.Binding
}

type Modes

type Modes map[string]interface{}

func NewModes

func NewModes(modes []string) Modes

func (Modes) Contains

func (m Modes) Contains(mode string) bool

Contains checks if the given mode exists in the Modes map. If the "*" mode exists, it will match any mode. Otherwise it checks if the specific mode exists.