Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document requirements for widgets that call autosuggestion widgets (#716) #717

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

document requirements for widgets that call autosuggestion widgets (#716) #717

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8036b61
docs: widgets calling autosuggestion widgets must be ignored (#716)
olets Dec 19, 2022
5b1708d
docs: autosuggestion widgets can be called directly
olets Dec 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Widgets that modify the buffer and are not found in any of these arrays will fet

**Note:** A widget shouldn't belong to more than one of the above arrays.

**Note:** Any widget which calls one of the [autosuggestion widgets](#autosuggestion-widgets) must be added to `ZSH_AUTOSUGGEST_IGNORE_WIDGETS` before creating the new widget's keymap.

### Disabling suggestion for large buffers

Expand Down Expand Up @@ -102,9 +103,9 @@ Set `ZSH_AUTOSUGGEST_COMPLETION_IGNORE` to a [glob pattern](http://zsh.sourcefor
**Note:** This only affects the `completion` suggestion strategy.


### Key Bindings
### Autosuggestion widgets

This plugin provides a few widgets that you can use with `bindkey`:
This plugin adds a few [zle widgets](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets):

1. `autosuggest-accept`: Accepts the current suggestion.
2. `autosuggest-execute`: Accepts and executes the current suggestion.
Expand All @@ -114,12 +115,22 @@ This plugin provides a few widgets that you can use with `bindkey`:
6. `autosuggest-enable`: Re-enables suggestions.
7. `autosuggest-toggle`: Toggles between enabled/disabled suggestions.

For example, this would bind <kbd>ctrl</kbd> + <kbd>space</kbd> to accept the current suggestion.
You can bind any of these widgets to a keyboard shortcut with [`bindkey`](https://zsh.sourceforge.io/Doc/Release/Zsh-Line-Editor.html#Zle-Builtins). For example, the following command would bind <kbd>ctrl</kbd> + <kbd>space</kbd> to accept the current suggestion.

```sh
bindkey '^ ' autosuggest-accept
```

You can also call any of them directly with `zle`. For example, the following command would accept the current suggestion (for an explanation of `ZSH_AUTOSUGGEST_IGNORE_WIDGETS` see [Widget mapping](#widget-mapping), above).

```sh
my_widget() {
zle autosuggest-accept
}
typeset -ga ZSH_AUTOSUGGEST_IGNORE_WIDGETS
ZSH_AUTOSUGGEST_IGNORE_WIDGETS+=( my_widget )
zle -N my_widget
```

## Troubleshooting

Expand Down