summaryrefslogtreecommitdiff
path: root/plugins/vi-mode/README.md
diff options
context:
space:
mode:
authorbretello <bretello@users.noreply.github.com>2021-12-29 10:34:57 +0100
committerGitHub <noreply@github.com>2021-12-29 10:34:57 +0100
commit65bbd24eec6b64f2f526c974781f08373277be0c (patch)
tree0481768db25e22a5929fca617f8581ee1f16aa48 /plugins/vi-mode/README.md
parent3bb23e8e316452c40eaa0917c8f4be1a2f59ff38 (diff)
downloadzsh-65bbd24eec6b64f2f526c974781f08373277be0c.tar.gz
zsh-65bbd24eec6b64f2f526c974781f08373277be0c.tar.bz2
zsh-65bbd24eec6b64f2f526c974781f08373277be0c.zip
feat(vi-mode): add `INSERT_MODE_INDICATOR` (#9732)
Co-authored-by: bretello <bretello@distruzione.org>
Diffstat (limited to 'plugins/vi-mode/README.md')
-rw-r--r--plugins/vi-mode/README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/plugins/vi-mode/README.md b/plugins/vi-mode/README.md
index 46bb6d070..a1d6bc6b0 100644
--- a/plugins/vi-mode/README.md
+++ b/plugins/vi-mode/README.md
@@ -32,16 +32,21 @@ plugins=(... vi-mode)
- `MODE_INDICATOR`: controls the string displayed when the shell is in normal mode.
See [Mode indicator](#mode-indicator) for details.
-## Mode indicator
+- `INSERT_MODE_INDICATOR`: controls the string displayed when the shell is in insert mode.
+ See [Mode indicator](#mode-indicator) for details.
+
+## Mode indicators
*Normal mode* is indicated with a red `<<<` mark at the right prompt, when it
-hasn't been defined by theme.
+hasn't been defined by theme, *Insert mode* is not displayed by default.
-You can change this indicator by setting the `MODE_INDICATOR` variable. This setting
-supports Prompt Expansion sequences. For example:
+You can change these indicators by setting the `MODE_INDICATOR` (*Normal mode*) and
+`INSERT_MODE_INDICATORS` (*Insert mode*) variables.
+This settings support Prompt Expansion sequences. For example:
```zsh
-MODE_INDICATOR="%F{yellow}+%f"
+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