etui/keymap

Types

Binding

A single key binding: key → action + description.

pub type Binding(action) {
  Binding(key: String, action: action, description: String)
}

Constructors

Binding(key: String, action: action, description: String)

Keymap

</>

Ordered list of key bindings.

pub type Keymap(action) {
  Keymap(bindings: List(Binding(action)))
}

Constructors

```
Keymap(bindings: List(Binding(action)))
```

Values

all_bindings

</>

pub fn all_bindings(
  km: Keymap(action),
) -> List(#(String, action))

All bindings as #(key, action) pairs.

bind

</>

pub fn bind(
  km: Keymap(action),
  key: String,
  action: action,
  description: String,
) -> Keymap(action)

Add a binding to the end of the keymap. The first matching binding wins on lookup.

filter

</>

pub fn filter(
  km: Keymap(action),
  query: String,
) -> Keymap(action)

Keep only bindings whose description contains query (case-insensitive). Useful for a live-filter command palette.

help_lines

</>

pub fn help_lines(km: Keymap(action)) -> List(#(String, String))

All bindings as #(key, description) pairs, in registration order.

keymap_new

</>

pub fn keymap_new() -> Keymap(action)

Empty keymap.

lookup

</>

pub fn lookup(
  km: Keymap(action),
  key: String,
) -> Result(action, Nil)

Find the action bound to key. Returns Error(Nil) if not found.

merge

</>

pub fn merge(km: Keymap(a), other: Keymap(a)) -> Keymap(a)

Merge other into km. Bindings from other are appended.

render_help

</>

pub fn render_help(
  buf: buffer.Buffer,
  area: geometry.Rect,
  km: Keymap(action),
  st: style.Style,
) -> buffer.Buffer

Render a help table into area. Each row shows key_col description. key_col_width is the minimum column width for keys (auto-computed if 0). Returns the buffer with the help overlay drawn.

unbind

</>

pub fn unbind(km: Keymap(action), key: String) -> Keymap(action)

Remove all bindings for a given key.