A transient’s suffix and infix commands are bound when the transient
prefix command is defined using
Defining Transients. The commands are organized into groups, see
Group Specifications. Here we describe the form used to bind an
individual suffix command.
The same form is also used when later binding additional commands
using functions such as
transient-insert-suffix, see Modifying Existing Transients.
Note that an infix is a special kind of suffix. Depending on context "suffixes" means "suffixes (including infixes)" or "non-infix suffixes". Here it means the former.
Suffix specifications have this form:
([LEVEL] [KEY] [DESCRIPTION] COMMAND|ARGUMENT [KEYWORD VALUE]...)
LEVEL, KEY and DESCRIPTION can also be specified using the KEYWORDs
:description. If the object that is associated with
COMMAND sets these properties, then they do not have to be specified
here. You can however specify them here anyway, possibly overriding
the object’s values just for the binding inside this transient.
:descriptionin that case.
The next element is either a command or an argument. This is the only argument that is mandatory in all cases.
Any command will do; it does not need to have an object associated
with it (as would be the case if
transient-define-infix were used to define it).
The command can also be a closure or lambda expression, but that
should only be used for dynamic transients whose suffixes are
defined when the prefix command is invoked. See information about
:setup-children function in Group Specifications.
As mentioned above, the object that is associated with a command can be used to set the default for certain values that otherwise have to be set in the suffix specification. Therefore if there is no object, then you have to make sure to specify the KEY and the DESCRIPTION.
Instead of a string, this can also be a list of two strings, in
which case the first string is used as the short argument (which can
also be specified using
:shortarg) and the second as the long argument
(which can also be specified using
Only the long argument is displayed in the popup buffer. See
transient-detect-key-conflicts for how the short argument may be
Unless the class is specified explicitly, the appropriate class is
guessed based on the long argument. If the argument ends with "="
(e.g. "–format=") then
transient-option is used, otherwise
Finally, details can be specified using optional KEYWORD-VALUE pairs.
Each keyword has to be a keyword symbol, either
:class or a keyword
argument supported by the constructor of that class. See Suffix Slots.