snacks.nvim/doc/snacks-layout.txt

*snacks-layout*                                              snacks_layout

==============================================================================
Table of Contents                            *snacks-layout-table-of-contents*

1. Setup                                                 |snacks-layout-setup|
2. Config                                               |snacks-layout-config|
3. Types                                                 |snacks-layout-types|
4. Module                                               |snacks-layout-module|
  - Snacks.layout.new()             |snacks-layout-module-snacks.layout.new()|
  - layout:close()                       |snacks-layout-module-layout:close()|
  - layout:each()                         |snacks-layout-module-layout:each()|
  - layout:hide()                         |snacks-layout-module-layout:hide()|
  - layout:is_enabled()             |snacks-layout-module-layout:is_enabled()|
  - layout:is_hidden()               |snacks-layout-module-layout:is_hidden()|
  - layout:maximize()                 |snacks-layout-module-layout:maximize()|
  - layout:needs_layout()         |snacks-layout-module-layout:needs_layout()|
  - layout:show()                         |snacks-layout-module-layout:show()|
  - layout:toggle()                     |snacks-layout-module-layout:toggle()|
  - layout:unhide()                     |snacks-layout-module-layout:unhide()|
  - layout:valid()                       |snacks-layout-module-layout:valid()|

==============================================================================
1. Setup                                                 *snacks-layout-setup*

>lua
    -- lazy.nvim
    {
      "folke/snacks.nvim",
      ---@type snacks.Config
      opts = {
        layout = {
          -- your layout configuration comes here
          -- or leave it empty to use the default settings
          -- refer to the configuration section below
        }
      }
    }
<


==============================================================================
2. Config                                               *snacks-layout-config*

>lua
    ---@class snacks.layout.Config
    ---@field show? boolean show the layout on creation (default: true)
    ---@field wins table<string, snacks.win> windows to include in the layout
    ---@field layout snacks.layout.Box layout definition
    ---@field fullscreen? boolean open in fullscreen
    ---@field hidden? string[] list of windows that will be excluded from the layout (but can be toggled)
    ---@field on_update? fun(layout: snacks.layout)
    ---@field on_update_pre? fun(layout: snacks.layout)
    {
      layout = {
        width = 0.6,
        height = 0.6,
        zindex = 50,
      },
    }
<


==============================================================================
3. Types                                                 *snacks-layout-types*

>lua
    ---@class snacks.layout.Win: snacks.win.Config,{}
    ---@field depth? number
    ---@field win string layout window name
<

>lua
    ---@class snacks.layout.Box: snacks.layout.Win,{}
    ---@field box "horizontal" | "vertical"
    ---@field id? number
    ---@field [number] snacks.layout.Win | snacks.layout.Box children
<

>lua
    ---@alias snacks.layout.Widget snacks.layout.Win | snacks.layout.Box
<


==============================================================================
4. Module                                               *snacks-layout-module*

>lua
    ---@class snacks.layout
    ---@field opts snacks.layout.Config
    ---@field root snacks.win
    ---@field wins table<string, snacks.win|{enabled?:boolean, layout?:boolean}>
    ---@field box_wins snacks.win[]
    ---@field win_opts table<string, snacks.win.Config>
    ---@field closed? boolean
    ---@field split? boolean
    ---@field screenpos number[]?
    Snacks.layout = {}
<


`Snacks.layout.new()`                                    *Snacks.layout.new()*

>lua
    ---@param opts snacks.layout.Config
    Snacks.layout.new(opts)
<


LAYOUT:CLOSE()                           *snacks-layout-module-layout:close()*

Close the layout

>lua
    ---@param opts? {wins?: boolean}
    layout:close(opts)
<


LAYOUT:EACH()                             *snacks-layout-module-layout:each()*

>lua
    ---@param cb fun(widget: snacks.layout.Widget, parent?: snacks.layout.Box)
    ---@param opts? {wins?:boolean, boxes?:boolean, box?:snacks.layout.Box}
    layout:each(cb, opts)
<


LAYOUT:HIDE()                             *snacks-layout-module-layout:hide()*

>lua
    layout:hide()
<


LAYOUT:IS_ENABLED()                 *snacks-layout-module-layout:is_enabled()*

Check if the window has been used in the layout

>lua
    ---@param w string
    layout:is_enabled(w)
<


LAYOUT:IS_HIDDEN()                   *snacks-layout-module-layout:is_hidden()*

Check if a window is hidden

>lua
    ---@param win string
    layout:is_hidden(win)
<


LAYOUT:MAXIMIZE()                     *snacks-layout-module-layout:maximize()*

Toggle fullscreen

>lua
    layout:maximize()
<


LAYOUT:NEEDS_LAYOUT()             *snacks-layout-module-layout:needs_layout()*

>lua
    ---@param win string
    layout:needs_layout(win)
<


LAYOUT:SHOW()                             *snacks-layout-module-layout:show()*

Show the layout

>lua
    layout:show()
<


LAYOUT:TOGGLE()                         *snacks-layout-module-layout:toggle()*

Toggle a window

>lua
    ---@param win string
    ---@param enable? boolean
    ---@param on_update? fun(enabled: boolean) called when the layout will be updated
    layout:toggle(win, enable, on_update)
<


LAYOUT:UNHIDE()                         *snacks-layout-module-layout:unhide()*

>lua
    layout:unhide()
<


LAYOUT:VALID()                           *snacks-layout-module-layout:valid()*

Check if layout is valid (visible)

>lua
    layout:valid()
<

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl: