Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-14 06:28:00 +08:00
Code Issues Projects Releases Wiki Activity

docs(nvim-plug): update readme

Browse Source
This commit is contained in:
Eric Wong 2025-02-07 22:15:01 +08:00
parent 1611f8c274
commit 28fc69c56a
No known key found for this signature in database
GPG Key ID: 41BB7053E835C848
1 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
bundle/nvim-plug/README.md vendored
View File

@ -104,17 +104,36 @@ The default highlight group.
| -------------------- | ------------------------------- |
| `PlugTitle` | the first line of plugin window |
| `PlugProcess` | the process of downloading |
| `PlugDone` | clone/build/install done |
| `PlugFailed` | clone/build/install failed |
| `PlugDoing` | job is running |
Default highlight link:
```lua
vim.cmd('hi def link PlugTitle TODO')
vim.cmd('hi def link PlugProcess Repeat')
vim.cmd('hi def link PlugDone Type')
vim.cmd('hi def link PlugFailed WarningMsg')
vim.cmd('hi def link PlugDoing Number')
```
## Custom Plugin UI
To setup custom UI, you need to creat a on_update function, this function is called with two arges:
To setup custom UI, you need to creat a on_update function, this function is called with two arges, `name` and `plugUiData`.
- name: `string`
- date: `PlugUiData`
The plugUiData is table with following keys:
| key | description |
| ------------ | ---------------------------------------- |
| --------------- | ---------------------------------------------------- |
| `clone_done` | boolead, is true when clone successfully |
| `command` | string, clone, pull or build |
| `clone_process` | string, git clone progress, such as `16% (160/1000)` |
| `clone_done` | boolean, git clone exit status |
| `building` | boolean |
| `build_done` | boolean |
| `pull_done` | boolean |
| `pull_process` | string |
```lua
--- your custom UI