Neovim plugin improving access to clipboard history (mirror)
auto-generate vimdoc
+36
-6
+36
-6
doc/yankbank-nvim.txt
+36
-6
doc/yankbank-nvim.txt
···
7
7
- What it Does |yankbank-nvim-yankbank-what-it-does|
8
8
- Installation and Setup |yankbank-nvim-yankbank-installation-and-setup|
9
9
- Usage |yankbank-nvim-yankbank-usage|
10
+
- API (WIP) |yankbank-nvim-yankbank-api-(wip)|
10
11
- Potential Improvements |yankbank-nvim-yankbank-potential-improvements|
11
12
- Alternatives |yankbank-nvim-yankbank-alternatives|
12
13
2. Links |yankbank-nvim-links|
···
84
85
string separator to show between table entries | `"-----"` | | keymaps | table
85
86
containing keymap overrides | `{}` | | keymaps.navigation_next | string | `"j"`
86
87
| | keymaps.navigation_prev | string | `"k"` | | keymaps.paste | string |
87
-
`"<CR>"` | | keymaps.yank | string | `"yy"` | | keymaps.close | table of
88
-
strings | `{ "<Esc>", "<C-c>", "q" }` | | num_behavior | string defining jump
89
-
behavior "prefix" or "jump" | `"prefix"` | | focus_gain_poll | boolean | `nil`
90
-
| | registers | table container for register overrides | `{ }` | |
91
-
registers.yank_register | default register to yank from popup to | `"+"` | |
92
-
persist_type | string defining persistence type "sqlite" or nil | `nil` |
88
+
`"<CR>"` | | keymaps.paste_back | string | `"P"` | | keymaps.yank | string |
89
+
`"yy"` | | keymaps.close | table of strings | `{ "<Esc>", "<C-c>", "q" }` | |
90
+
num_behavior | string defining jump behavior "prefix" or "jump" | `"prefix"` |
91
+
| focus_gain_poll | boolean | `nil` | | registers | table container for
92
+
register overrides | `{ }` | | registers.yank_register | default register to
93
+
yank from popup to | `"+"` | | persist_type | string defining persistence type
94
+
"sqlite" or nil | `nil` |
93
95
94
96
95
97
EXAMPLE CONFIGURATION
···
106
108
persist_type = "sqlite",
107
109
keymaps = {
108
110
paste = "<CR>",
111
+
paste_back = "P",
109
112
},
110
113
registers = {
111
114
yank_register = "+",
···
169
172
vim.keymap.set("n", "<leader>y", "<cmd>YankBank<CR>", { noremap = true })
170
173
<
171
174
175
+
------------------------------------------------------------------------------
176
+
177
+
API (WIP) *yankbank-nvim-yankbank-api-(wip)*
178
+
179
+
Some plugin internals are also accessible via the YankBank api.
180
+
181
+
Examples:
182
+
183
+
>lua
184
+
-- get the 2nd entry in the bank
185
+
---@param i integer index to get
186
+
-- output format: { yank_text = "entry", reg_type = "v" }
187
+
local e = require("yankbank.api").get_entry(2)
188
+
189
+
-- add an entry to the bank
190
+
---@param yank_text string yank text to add to YANKS table
191
+
---@param reg_type string register type "v", "V", or "^V" (visual, v-line, v-block respectively)
192
+
require("yankbank.api").add_entry("yank_text", "reg_type")
193
+
194
+
-- remove an entry from the bank by index
195
+
---@param i integer index to remove
196
+
require("yankbank.api").remove_entry(1)
197
+
<
198
+
199
+
For more details about the API see lua/yankbank/api.lua <lua/yankbank/api.lua>
200
+
201
+
------------------------------------------------------------------------------
172
202
173
203
POTENTIAL IMPROVEMENTS *yankbank-nvim-yankbank-potential-improvements*
174
204