.. | ||
LICENSE | ||
main.lua | ||
README.md |
toggle-pane.yazi
Toggle the show, hide, and maximize states for different panes: parent, current, and preview. It respects the user's ratio
settings!
Assume the user's ratio
is [A, B, C]
, that is, \text{parent}=A, \text{current}=B, \text{preview}=C
:
min-parent
: Toggles between0
andA
- the parent is either completely hidden or showed with widthA
.max-parent
: Toggles betweenA
and\infty
- the parent is either showed with widthA
or fills the entire screen.min-current
: Toggles between0
andB
- the current is either completely hidden or showed with widthB
.max-current
: Toggles betweenB
and\infty
- the current is either showed with widthB
or fills the entire screen.min-preview
: Toggles between0
andC
- the preview is either completely hidden or showed with widthC
.max-preview
: Toggles betweenC
and\infty
- the preview is either showed with widthC
or fills the entire screen.reset
: Resets to the user's configuredratio
.
Installation
ya pack -a yazi-rs/plugins:toggle-pane
Usage
Hide/Show preview:
# keymap.toml
[[manager.prepend_keymap]]
on = "T"
run = "plugin toggle-pane min-preview"
desc = "Show or hide the preview pane"
Maximize/Restore preview:
# keymap.toml
[[manager.prepend_keymap]]
on = "T"
run = "plugin toggle-pane max-preview"
desc = "Maximize or restore the preview pane"
You can replace preview
with current
or parent
to toggle the other panes.
Advanced
In addition to triggering the plugin with a keypress, you can also trigger it in your init.lua
file:
if os.getenv("NVIM") then
require("toggle-pane"):entry("min-preview")
end
In the example above, when it detects that you're using Yazi in nvim, the preview is hidden by default — you can always press T
(or any key you've bound) to show it again.
Tips
This plugin only maximizes the "available preview area", without actually changing the content size.
This means that the appearance of your preview largely depends on the previewer you are using. However, most previewers tend to make the most of the available space, so this usually isn't an issue.
For image previews, you may want to tune up the max_width
and max_height
options in your yazi.toml
:
[preview]
# Change them to your desired values
max_width = 1000
max_height = 1000
License
This plugin is MIT-licensed. For more information, check the LICENSE file.