dolysis/ohmyzsh
3
0
Fork 0
Code Issues Pull requests Releases Activity

feat(vi-mode): add settings for vi-mode cursor styles (#10860)

Browse source
This commit is contained in:
Julien Vincent 2023-03-07 21:46:21 +02:00 committed by GitHub
parent d342b353e3
commit e0f92c8df5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
plugins/vi-mode/README.md
View file

@ -29,6 +29,8 @@ plugins=(... vi-mode)
VI_MODE_SET_CURSOR=true VI_MODE_SET_CURSOR=true
``` ```
See [Cursor Styles](#cursor-styles) for controlling how the cursor looks in different modes
- `MODE_INDICATOR`: controls the string displayed when the shell is in normal mode. - `MODE_INDICATOR`: controls the string displayed when the shell is in normal mode.
See [Mode indicators](#mode-indicators) for details. See [Mode indicators](#mode-indicators) for details.
@ -52,6 +54,25 @@ INSERT_MODE_INDICATOR="%F{yellow}+%f"
You can also use the `vi_mode_prompt_info` function in your prompt, which will display You can also use the `vi_mode_prompt_info` function in your prompt, which will display
this mode indicator. this mode indicator.
## Cursor Styles
You can control the cursor style used in each active vim mode by changing the values of the following variables.
```zsh
# defaults
VI_MODE_CURSOR_NORMAL=2
VI_MODE_CURSOR_VISUAL=6
VI_MODE_CURSOR_INSERT=6
VI_MODE_CURSOR_OPPEND=0
```
- 0, 1 - Blinking block
- 2 - Solid block
- 3 - Blinking underline
- 4 - Solid underline
- 5 - Blinking line
- 6 - Solid line
## Key bindings ## Key bindings
Use `ESC` or `CTRL-[` to enter `Normal mode`. Use `ESC` or `CTRL-[` to enter `Normal mode`.

23
plugins/vi-mode/vi-mode.plugin.zsh
View file

@ -14,6 +14,15 @@ typeset -g VI_MODE_RESET_PROMPT_ON_MODE_CHANGE
# Unset or set to any other value to do the opposite. # Unset or set to any other value to do the opposite.
typeset -g VI_MODE_SET_CURSOR typeset -g VI_MODE_SET_CURSOR
# Control how the cursor appears in the various vim modes. This only applies
# if $VI_MODE_SET_CURSOR=true.
#
# See https://vt100.net/docs/vt510-rm/DECSCUSR for cursor styles
typeset -g VI_MODE_CURSOR_NORMAL=2
typeset -g VI_MODE_CURSOR_VISUAL=6
typeset -g VI_MODE_CURSOR_INSERT=6
typeset -g VI_MODE_CURSOR_OPPEND=0
typeset -g VI_KEYMAP=main typeset -g VI_KEYMAP=main
function _vi-mode-set-cursor-shape-for-keymap() { function _vi-mode-set-cursor-shape-for-keymap() {
@ -22,13 +31,13 @@ function _vi-mode-set-cursor-shape-for-keymap() {
# https://vt100.net/docs/vt510-rm/DECSCUSR # https://vt100.net/docs/vt510-rm/DECSCUSR
local _shape=0 local _shape=0
case "${1:-${VI_KEYMAP:-main}}" in case "${1:-${VI_KEYMAP:-main}}" in
main) _shape=6 ;; # vi insert: line main) _shape=$VI_MODE_CURSOR_INSERT ;; # vi insert: line
viins) _shape=6 ;; # vi insert: line viins) _shape=$VI_MODE_CURSOR_INSERT ;; # vi insert: line
isearch) _shape=6 ;; # inc search: line isearch) _shape=$VI_MODE_CURSOR_INSERT ;; # inc search: line
command) _shape=6 ;; # read a command name command) _shape=$VI_MODE_CURSOR_INSERT ;; # read a command name
vicmd) _shape=2 ;; # vi cmd: block vicmd) _shape=$VI_MODE_CURSOR_NORMAL ;; # vi cmd: block
visual) _shape=2 ;; # vi visual mode: block visual) _shape=$VI_MODE_CURSOR_VISUAL ;; # vi visual mode: block
viopp) _shape=0 ;; # vi operation pending: blinking block viopp) _shape=$VI_MODE_CURSOR_OPPEND ;; # vi operation pending: blinking block
*) _shape=0 ;; *) _shape=0 ;;
esac esac
printf $'\e[%d q' "${_shape}" printf $'\e[%d q' "${_shape}"