docs(win): document width/height behavior for win

This commit is contained in:
Folke Lemaitre 2024-11-08 13:20:00 +01:00
parent edbd40aab4
commit 5ccf72e6d0
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
3 changed files with 6 additions and 0 deletions

View file

@ -20,6 +20,8 @@ local M = setmetatable({}, {
---@class snacks.win.Config: vim.api.keyset.win_config
---@field style? string merges with config from `Snacks.config.styles[style]`
---@field show? boolean Show the window immediately (default: true)
---@field height? number Height of the window. Use <1 for relative height. 0 means full height. (default: 0.9)
---@field width? number Width of the window. Use <1 for relative width. 0 means full width. (default: 0.9)
---@field minimal? boolean Disable a bunch of options to make the window minimal (default: true)
---@field position? "float"|"bottom"|"top"|"left"|"right"
---@field buf? number If set, use this buffer instead of creating a new one