holm/ohmyzsh
1
1
Fork 0
forked from extern/ohmyzsh
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(vi-mode): document how to add vi-mode info on the prompt (#11548)

Browse Source
This commit is contained in:
Benjamin Lieb 2023-03-08 03:29:21 -05:00 committed by GitHub
parent 1c325de464
commit 3ea0e0d234
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
plugins/vi-mode/README.md
View File

@ -51,8 +51,23 @@ MODE_INDICATOR="%F{white}+%f"
INSERT_MODE_INDICATOR="%F{yellow}+%f"
```
You can also use the `vi_mode_prompt_info` function in your prompt, which will display
this mode indicator.
### Adding mode indicators to your prompt
`Vi-mode` by default will add mode indicators to `RPROMPT` **unless** that is defined by
a preceding plugin.
If `PROMPT` or `RPROMPT` is not defined to your liking, you can add mode info manually. The `vi_mode_prompt_info` function is available to insert mode indicator information.
Here are some examples:
```bash
source $ZSH/oh-my-zsh.sh
PROMPT="$PROMPT\$(vi_mode_prompt_info)"
RPROMPT="\$(vi_mode_prompt_info)$RPROMPT"
```
Note the `\$` here, which importantly prevents interpolation at the time of defining, but allows it to be executed for each prompt update event.
## Cursor Styles