summaryrefslogtreecommitdiff
path: root/docs/transient.texi
AgeCommit message (Collapse)Author
2025-06-09Release version 0.9.2v0.9.2Jonas Bernoulli
2025-06-06manual: Mention transient-copy-menu-text in relevant FAQJonas Bernoulli
2025-06-03Release version 0.9.1v0.9.1Jonas Bernoulli
2025-06-01Release version 0.9.0v0.9.0Jonas Bernoulli
2025-05-26manual: Omit LEVEL in transient-information exampleJonas Bernoulli
Positional LEVEL is semi-deprecated.
2025-05-26transient-cons-option: New suffix class for non-cmdline optionsJonas Bernoulli
The existing `transient-option' class is suitable for options passed to commands. A suffix that uses that class may represent an argument such as "--option". In the list returned by `transient-args', that argument and its value, "value", is represented as one element "--option=value". For "options" that are not passed to a command that is not appropriate. A caller that wants to extract the value of such an option would have to parse that string. `transient-arg-value' can help with that, but it always returns a string (or nil). The new `transient-cons-option' class provides a more direct way to deal with "non-command-line options", by representing the key value pair using a cons-cell (ARGUMENT . VALUE), not just internally, but in particular when handing it of to a caller. VALUE can have any printable type and ARGUMENT can have any printable type, expect string. We cannot use the term "key" because that is already used to the key binding for the command. Also avoid using "property" because that implies a property list, while the value returned by `transient-args' is an alist when all infixes use the `transient-cons-options' class. Sticking to "argument" also has the advantage, that we don't have to implement or generalize a dozen methods.
2025-05-16Regenerate manualJonas Bernoulli
2025-05-01Release version 0.8.8v0.8.8Jonas Bernoulli
2025-04-18Reduce usage of the term "popup"Jonas Bernoulli
2025-04-15transient-common-command-prefix: New optionJonas Bernoulli
2025-04-15manual: Document transient-error-on-insert-failureJonas Bernoulli
2025-04-15transient--insert-suffix: Do not signal error by defaultJonas Bernoulli
In [1: 8daf9890] we started to signal an error instead of merely showing a message on failure. That was a mistake, see #374. Add new option `transient-error-on-insert-failure', so users can opt-in to fatal errors for minor issues. 1: 2025-03-24 8daf9890ee65335a23eebc8919e9cfdd7c7249eb transient--insert-suffix: Signal error if location is invalid
2025-04-01Release version 0.8.7v0.8.7Jonas Bernoulli
2025-03-24transient--insert-suffix: Signal error if location is invalidJonas Bernoulli
Closes #374.
2025-03-20transient-post-exit-hook: New hookJonas Bernoulli
2025-03-15Release version 0.8.6v0.8.6Jonas Bernoulli
2025-03-01Release version 0.8.5v0.8.5Jonas Bernoulli
2025-03-01Regenerate manualJonas Bernoulli
2025-02-15manual: Update how to prevent C-g from returning to the parent prefixJonas Bernoulli
Nowadays we have more explicit pre-commands for prefixes we can choose from, and don't have to rely on `transient' being unbound. The documented behavior no longer worked; nil has been a shorthand for `stack' (itself a shorthand for `transient--do-stack') for a long time, and leaving the slot unbound meant that the default was used, which is also `transient--do-stack'. Now `replace' prevents even "C-g" from returning to the parent, and `recurse' makes all suffixes of the sub-prefix default to returning to the parent, not just "C-g". Closes #356.
2025-02-15transient--insert-suffix: Support forcing to keep other bindingsJonas Bernoulli
Closes #355.
2025-02-15Regenerate manualJonas Bernoulli
2025-02-01Release version 0.8.4v0.8.4Jonas Bernoulli
2025-01-31Allow setting a suffix's default level via its prototypeJonas Bernoulli
2025-01-21manual: Document transient-scopeJonas Bernoulli
2025-01-21Add support for advising suffix commandsJonas Bernoulli
This is still experimental. See #340. (defun third-party-command (arg) (interactive (list default-directory)) (message "arg: %s -- value: %s" arg default-directory)) (defun demo-in-tmp (fn &rest args) (let ((default-directory "/tmp/")) (apply fn args))) (transient-define-prefix demo () :transient-suffix t [("h" "here" third-party-command) ("m" "in /tmp" third-party-command :advice demo-in-tmp) ("b" "in /tmp (both)" third-party-command :advice* demo-in-tmp)])
2025-01-21transient--parse-{group,suffix}: Support ## macro following keywordJonas Bernoulli
2025-01-08manual: Correct name of column-widths slotJonas Bernoulli
Also mention the type. Closes #345.
2025-01-03Release version 0.8.3v0.8.3Jonas Bernoulli
2025-01-01Release version 0.8.2v0.8.2Jonas Bernoulli
2025-01-01Regenerate manualJonas Bernoulli
2025-01-01Bump copyright yearsJonas Bernoulli
2024-12-19transient-describe: New commandJonas Bernoulli
Two examples: ("d" "show magit-status' docstring" transient-describe := magit-status) ("m" "show transient's manual" transient-describe := "transient" :helper transient--show-manual)
2024-12-19transient-toggle-docstrings: New commandJonas Bernoulli
2024-12-19transient-copy-menu-text: New commandJonas Bernoulli
2024-12-19Use transient-default-value in transient-init-value(suffix)Jonas Bernoulli
2024-12-19Store parent group in suffix and subgroup objectsJonas Bernoulli
2024-12-08Release version 0.8.1v0.8.1Jonas Bernoulli
2024-12-06Release version 0.8.0v0.8.0Jonas Bernoulli
2024-12-06Update manualJonas Bernoulli
2024-12-03manual: Document transient-save-historyJonas Bernoulli
2024-12-03manual: Document in transient-show-common-commands "Essential Options"Jonas Bernoulli
Keep the existing description in "Common Suffix Commands".
2024-12-03manual: Move two more options to "Essential Options"Jonas Bernoulli
2024-12-02Fix typos in documentationJonas Bernoulli
2024-12-01transient-prefix: Add mode-line-format slotJoseph Turner
2024-12-01transient-prefix: Add display-action slotJoseph Turner
This change lets each transient-prefix display according to its own display-buffer-action. Closes #303.
2024-12-01Improve options for showing menu during minibuffer useJonas Bernoulli
- Use the `window-preserve-size' window properly instead of the more aggressive `window-size-fixed' variable, as recommended in the documentation. - Delay fixing the size until the window is actually being displayed. - Add a new option `transient-show-during-minibuffer-read', replacing `transient-hide-during-minibuffer-read'. This is necessary because there are now multiple values that show the menu, but in different ways, which can only be expressed using distinct non-nil values. - When the user chose that the size should be `fixed', but we know that won't fly because the menu window uses the full frame height, then override that choice. This is necessary because it will soon become possible for an individual prefix to use a different display action, which may have different needs from the global value the user optimized for. - Allow displaying the fixed menu if possible, while also falling back to not displaying it either at all or while potentially resizing it, if that is not possible. Closes #330.
2024-11-22docs: Fix word orderJonas Bernoulli
Replace "also see" with "see also". Before links in the manual that sadly isn't possible because, if the word before a link is neither "see" not "in", makeinfo injects "see" before the link. While wrong, "also see <link>" is still better than "see also see <link>".
2024-11-15manual: Document inapt-if* slotsJonas Bernoulli
2024-11-11transient-mode-line-format: Fix typos in documentationJonas Bernoulli
2024-11-04Release version 0.7.9v0.7.9Jonas Bernoulli