aboutsummaryrefslogtreecommitdiff
path: root/book/src
diff options
context:
space:
mode:
authorPeepNSheep2022-10-03 14:45:32 +0000
committerGitHub2022-10-03 14:45:32 +0000
commit77f33e7b20bb84c6506d745ce05ec6835eee6756 (patch)
tree198c0063a53ff7c919d12d2662438d9573dd4a15 /book/src
parent589d17c7583716b339875b72972aaffe0ae5efc1 (diff)
Add configureable statusline mode names (#3311)
* Added 'long-mode' statusline element * Added customizable statusline mode names * Removed a string clone * Added documentation * Updated documentation, moved modenames to a seperate section * Update configuration.md * Documentation update * Documentation update * Documentation update * Update configuration.md * Update configuration.md * Fixed merge error * Update configuration.md * Update configuration.md
Diffstat (limited to 'book/src')
-rw-r--r--book/src/configuration.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/book/src/configuration.md b/book/src/configuration.md
index fdabe768..d44855c7 100644
--- a/book/src/configuration.md
+++ b/book/src/configuration.md
@@ -68,13 +68,27 @@ left = ["mode", "spinner"]
center = ["file-name"]
right = ["diagnostics", "selections", "position", "file-encoding", "file-line-ending", "file-type"]
separator = "│"
+mode.normal = "NORMAL"
+mode.insert = "INSERT"
+mode.select = "SELECT"
```
+The `[editor.statusline]` key takes the following sub-keys:
-The following elements can be configured:
+| Key | Description | Default |
+| --- | --- | --- |
+| `left` | A list of elements aligned to the left of the statusline | `["mode", "spinner", "file-name"]` |
+| `center` | A list of elements aligned to the middle of the statusline | `[]` |
+| `right` | A list of elements aligned to the right of the statusline | `["diagnostics", "selections", "position", "file-encoding"]` |
+| `separator` | The character used to separate elements in the statusline | `"│"` |
+| `mode.normal` | The text shown in the `mode` element for normal mode | `"NOR"` |
+| `mode.insert` | The text shown in the `mode` element for insert mode | `"INS"` |
+| `mode.select` | The text shown in the `mode` element for select mode | `"SEL"` |
+
+The following statusline elements can be configured:
| Key | Description |
| ------ | ----------- |
-| `mode` | The current editor mode (`NOR`/`INS`/`SEL`) |
+| `mode` | The current editor mode (`mode.normal`/`mode.insert`/`mode.select`) |
| `spinner` | A progress spinner indicating LSP activity |
| `file-name` | The path/name of the opened file |
| `file-encoding` | The encoding of the opened file if it differs from UTF-8 |