charm.components.help — de.timokramer/charm.clj 0.1.42

Help component for displaying key bindings.

Usage: (def bindings [{:key "j/k" :desc "up/down"} {:key "q" :desc "quit"}]) (def my-help (help bindings))

;; In view function: (help-view my-help)

add-binding clj

(add-binding hlp key desc)

Add a binding.

bindings clj

(bindings hlp)

Get the bindings.

from-pairs clj

(from-pairs & args)

Create bindings from pairs of [key desc] or interleaved key desc args.

Examples: (from-pairs ["j/k" "up/down"] ["q" "quit"]) (from-pairs "j/k" "up/down" "q" "quit")

help clj

(help bindings
      &
      {:keys [width separator show-all key-style desc-style separator-style
              ellipsis id]
       :or {width 0
            separator " • "
            show-all false
            ellipsis "…"
            id (rand-int 1000000)}})

Create a help component.

Bindings is a sequence of maps with :key and :desc keys, or a sequence of [key desc] pairs.

Options: :width - Maximum width (0 = unlimited) :separator - Separator between bindings (default " • ") :show-all - Show full help instead of short (default false) :key-style - Style for key text :desc-style - Style for description text :separator-style - Style for separator :ellipsis - Ellipsis when truncated (default "…") :id - Unique ID

help-init clj

(help-init hlp)

Initialize help, returns [help cmd].

help-update clj

(help-update hlp _msg)

Update help state. Help components don't typically handle messages directly - use toggle-show-all for ? key handling in your update fn. Returns [help nil].

help-view clj

(help-view hlp)

Render the help to a string.

set-bindings clj

(set-bindings hlp bs)

Set the bindings.

set-show-all clj

(set-show-all hlp show?)

Set whether to show full help.

set-width clj

(set-width hlp w)

Set the width constraint.

show-all? clj

(show-all? hlp)

Check if showing full help.

toggle-show-all clj

(toggle-show-all hlp)

Toggle between short and full help.