a b c d e f g h i j k l m n o p q r s t u v w x y z
Description: Transient command menus
Transient is the library used to implement the keyboard-driven
"menus" in Magit. It is distributed as a separate package, so that it
can be used to implement similar menus in other packages.
.
Some things that Transient can do
* Display current state of arguments
* Display and manage lifecycle of modal bindings
* Contextual user interface
* Flow control for wizard-like composition of interactive forms
* History & persistence
* Rendering arguments for controlling CLI programs
Description: Emacs key and popup interface for complex keybindings
Taking inspiration from prefix keys and prefix arguments, Transient
implements a similar abstraction involving a prefix command, infix
arguments and suffix commands. We could call this abstraction a
"transient command", but because it always involves at least two
commands (a prefix and a suffix) we prefer to call it just a
"transient".
.
When the user calls a transient prefix command, then a transient
(temporary) keymap is activated, which binds the transient's infix
and suffix commands, and functions that control the transient state
are added to `pre-command-hook' and `post-command-hook'. The
available suffix and infix commands and their state are shown in
the echo area until the transient is exited by invoking a suffix
command.
.
Calling an infix command causes its value to be changed, possibly
by reading a new value in the minibuffer.
.
Calling a suffix command usually causes the transient to be exited
but suffix commands can also be configured to not exit the
transient state.
--- 318083 Thu Jan 1 00:00:00 1970
+++ 276861 Thu Jan 1 00:00:00 1970
@@ -1,12 +1,22 @@
-Transient command menus
- Transient is the library used to implement the keyboard-driven
- "menus" in Magit. It is distributed as a separate package, so that it
- can be used to implement similar menus in other packages.
+Emacs key and popup interface for complex keybindings
+ Taking inspiration from prefix keys and prefix arguments, Transient
+ implements a similar abstraction involving a prefix command, infix
+ arguments and suffix commands. We could call this abstraction a
+ "transient command", but because it always involves at least two
+ commands (a prefix and a suffix) we prefer to call it just a
+ "transient".
.
- Some things that Transient can do
+ When the user calls a transient prefix command, then a transient
- * Display current state of arguments
+ (temporary) keymap is activated, which binds the transient's infix
- * Display and manage lifecycle of modal bindings
+ and suffix commands, and functions that control the transient state
- * Contextual user interface
+ are added to `pre-command-hook' and `post-command-hook'. The
- * Flow control for wizard-like composition of interactive forms
+ available suffix and infix commands and their state are shown in
- * History & persistence
+ the echo area until the transient is exited by invoking a suffix
- * Rendering arguments for controlling CLI programs
+ command.
+ .
+ Calling an infix command causes its value to be changed, possibly
+ by reading a new value in the minibuffer.
+ .
+ Calling a suffix command usually causes the transient to be exited
+ but suffix commands can also be configured to not exit the
+ transient state.