tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#1169 document event payloads (#1187)

Browse Source
This commit is contained in:
Alexander Courtis 2022-04-24 19:15:08 +10:00 committed by GitHub
parent c46653b4a3
commit bf467a7cf4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/nvim-tree-lua.txt
View File

@ -963,7 +963,7 @@ on_nvim_tree_ready({handler})
Registers a handler for when NvimTree has been initialized. Registers a handler for when NvimTree has been initialized.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function()`. signature `function()`.
*nvim-tree.events.on_node_renamed()* *nvim-tree.events.on_node_renamed()*
@ -972,55 +972,66 @@ on_node_renamed({handler})
• Note: A node can either be a file or a directory. • Note: A node can either be a file or a directory.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function(payload)`. signature `function(payload)`.
payload: ~
{old_name} `{string}` Absolute path to the old node location.
{new_name} `{string}` Absolute path to the new node location.
*nvim-tree.events.on_file_created()* *nvim-tree.events.on_file_created()*
on_file_created({handler}) on_file_created({handler})
Registers a handler for when a file is created. Registers a handler for when a file is created.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function(payload)`. signature `function(payload)`.
payload: ~
{fname} `{string}` Absolute path to the created file
*nvim-tree.events.on_file_removed()* *nvim-tree.events.on_file_removed()*
on_file_removed({handler}) on_file_removed({handler})
Registers a handler for when a file is removed. Registers a handler for when a file is removed.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function(payload)`. signature `function(payload)`.
payload: ~
{fname} `{string}` Absolute path to the removed file.
*nvim-tree.events.on_folder_created()* *nvim-tree.events.on_folder_created()*
on_folder_created({handler}) on_folder_created({handler})
Registers a handler for when a folder is created. Registers a handler for when a folder is created.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function(payload)`. signature `function(payload)`.
payload: ~
{folder_name} `{string}` Absolute path to the created folder.
*nvim-tree.events.on_folder_removed()* *nvim-tree.events.on_folder_removed()*
on_folder_removed({handler}) on_folder_removed({handler})
Registers a handler for when a folder is removed. Registers a handler for when a folder is removed.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function(payload)`. signature `function(payload)`.
payload: ~
{folder_name} `{string}` Absolute path to the removed folder.
*nvim-tree.events.on_tree_open()* *nvim-tree.events.on_tree_open()*
on_tree_open({handler}) on_tree_open({handler})
Registers a handler for when NvimTree is opened. Registers a handler for when NvimTree is opened.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function(payload)`. signature `function()`.
*nvim-tree.events.on_tree_close()* *nvim-tree.events.on_tree_close()*
on_tree_close({handler}) on_tree_close({handler})
Registers a handler for when NvimTree is closed. Registers a handler for when NvimTree is closed.
Parameters: ~ Parameters: ~
{handler} (function) Handler function, with the {handler} `{function}` Handler function, with the
signature `function(payload)`. signature `function()`.
vim:tw=78:ts=8:noet:ft=help:norl: vim:tw=78:ts=8:noet:ft=help:norl: