barrett/canola.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs: add vimdoc for open_split/toggle_split and macOS trash recipe

Browse source 
Cherry-picked from: stevearc/oil.nvim#739
This commit is contained in:
Barrett Ruth 2026-03-07 15:37:28 -05:00
parent 943bf750cc
commit 07fa3be626
Signed by: barrett
GPG key ID: A6C96C9349D2FC81
1 changed files with 35 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

35
doc/canola.txt
View file

@ -404,6 +404,32 @@ toggle_float({dir}, {opts}, {cb}) *canola.toggle_f
plit modifier
{cb} `nil|fun()` Called after the canola buffer is ready
open_split({dir}, {opts}, {cb}) *canola.open_split*
Open canola browser in a split window
Parameters:
{dir} `nil|string` When nil, open the parent of the current buffer, or
the cwd if current buffer is not a file
{opts} `nil|canola.OpenSplitOpts`
{vertical} `nil|boolean` Open the buffer in a vertical split
{horizontal} `nil|boolean` Open the buffer in a horizontal split
{split} `nil|"aboveleft"|"belowright"|"topleft"|"botright"` Split
modifier
{cb} `nil|fun()` Called after the canola buffer is ready
toggle_split({dir}, {opts}, {cb}) *canola.toggle_split*
Open canola browser in a split window, or close it if open
Parameters:
{dir} `nil|string` When nil, open the parent of the current buffer, or
the cwd if current buffer is not a file
{opts} `nil|canola.OpenSplitOpts`
{vertical} `nil|boolean` Open the buffer in a vertical split
{horizontal} `nil|boolean` Open the buffer in a horizontal split
{split} `nil|"aboveleft"|"belowright"|"topleft"|"botright"` Split
modifier
{cb} `nil|fun()` Called after the canola buffer is ready
open({dir}, {opts}, {cb}) *canola.open*
Open canola browser for a directory
@ -1109,6 +1135,15 @@ variant after calling `setup()`:
end
<
Use FreeDesktop trash on macOS ~
*canola-recipe-macos-freedesktop-trash*
For full FreeDesktop spec compliance on macOS (list, restore operations), or
for compatibility with FreeDesktop-compliant trash programs like gtrash:
>lua
package.loaded["canola.adapters.trash.mac"] = require("canola.adapters.trash.freedesktop")
<
--------------------------------------------------------------------------------
EVENTS *canola-events*