Skip to content

Commit 53b5abb

Browse files
author
skywind3000
committed
update docs
1 parent 39b534a commit 53b5abb

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ Menu color schemes:
6565

6666
![](https://skywind3000.github.io/images/p/quickui/colors.png)
6767

68+
See: [Menu help](MANUAL.md#menu).
69+
6870
### Listbox
6971

7072
When you have hundres of items to deal with, menu is not enough to hold them. Then you will need a listbox.
@@ -79,6 +81,8 @@ It can be used to select buffers or functions in current file:
7981

8082
The cursor will stay in the current function initially. Navigate and press enter to jump to the selected function.
8183

84+
See: [Listbox help](MANUAL.md#listbox).
85+
8286
### Inputbox
8387

8488
Prompt user to input a string in a TUI box:
@@ -87,6 +91,8 @@ Prompt user to input a string in a TUI box:
8791

8892
Could be used as a drop-in replacement of `input()` function.
8993

94+
See: [Input box help](MANUAL.md#inputbox).
95+
9096
### Context menu
9197

9298
Context menu imitates Windows context menu (triggered by your mouse right button), which will display around the cursor:
@@ -101,6 +107,8 @@ The border can be changed too:
101107

102108
Because some terminals or fonts cannot display unicode borders correctly, so QuickUI choose ascii border characters by default. But you can change it as you like.
103109

110+
See: [Context menu help](MANUAL.md#context-menu).
111+
104112
### Textbox
105113

106114
Textbox is used to display arbitrary text in a popup window.
@@ -119,6 +127,8 @@ Display vim messages:
119127

120128
Navigating the messages with `HJKL` or `PageUp/PageDown` is much more convenient than using `:messages`.
121129

130+
See: [Text box help](MANUAL.md#textbox).
131+
122132
### Preview window
123133

124134
Preview window is used to replace traditional `pedit` command and can be used to display certain file in a small popup window around your cursor:
@@ -133,6 +143,8 @@ Use it to preview quickfix result:
133143

134144
If you have many items in the quickfix window, instead of open them one by one, you are able to press `p` in the quickfix window and preview them in the popup.
135145

146+
See: [Preview window help](MANUAL.md#preview-window).
147+
136148
### Terminal
137149

138150
The `terminal` widget can allow you open a terminal in the popup window:
@@ -141,6 +153,8 @@ The `terminal` widget can allow you open a terminal in the popup window:
141153

142154
This feature require vim `8.2.200` (nvim `0.4.0`) or later, it enables you to run various tui programs in a dialog window.
143155

156+
See: [Terminal help](MANUAL.md#terminal).
157+
144158
## User Manual
145159

146160
To get started, please visit:

0 commit comments

Comments
 (0)