Skip to content

Commit dfa421f

Browse files
committed
add important customization options to the readme
1 parent e91d526 commit dfa421f

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

+26
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ Show informations of the symbols on the current line.
3838
It also show flycheck diagnostics and LSP code actions
3939
![lsp-line](images/lsp-line.gif)
4040

41+
Customization:
42+
43+
- `lsp-ui-sideline-show-diagnostics` show diagnostics messages in sideline
44+
- `lsp-ui-sideline-show-hover` show hover messages in sideline
45+
- `lsp-ui-sideline-show-code-actions` show code actions in sideline
46+
- `lsp-ui-sideline-update-mode`
47+
When set to 'line' the information will be updated when user
48+
changes current line otherwise the information will be updated
49+
when user changes current point
50+
- `lsp-ui-sideline-delay` seconds to wait before showing sideline
51+
4152
## lsp-ui-peek:
4253

4354
Add [peek](https://code.visualstudio.com/docs/editor/editingevolved#_peek) feature
@@ -63,6 +74,11 @@ Other cross references:
6374
(lsp-ui-peek-find-custom 'base "$cquery/base")
6475
```
6576

77+
Customization:
78+
79+
- `lsp-ui-peek-enable` enable ‘lsp-ui-peek’
80+
- `lsp-ui-peek-show-directory` show the directory of files
81+
6682
## lsp-ui-doc
6783

6884
Show object documentation at point in a child frame.
@@ -74,6 +90,14 @@ Show documentation in a WebKit widget
7490
Focus into lsp-ui-doc-frame
7591
![lsp-ui-doc-focus-frame](images/lsp-ui-doc-focus-frame.gif)
7692

93+
Customization:
94+
95+
`lsp-ui-doc-enable` enable lsp-ui-doc
96+
97+
`lsp-ui-doc-position` Where to display the doc
98+
99+
`lsp-ui-doc-delay` Number of seconds before showing the doc
100+
77101
## lsp-ui-imenu
78102

79103
Show imenu entries.
@@ -83,6 +107,8 @@ Show imenu entries.
83107
Customization:
84108

85109
- `lsp-ui-imenu-window-width` set window width
110+
- `lsp-ui-imenu--custom-mode-line-format` mode line format
111+
86112

87113
## Contributing
88114

0 commit comments

Comments
 (0)