Class pinnacle.layout.builtin

Builtin layout generators.

This contains functions that create various builtin generators.

Functions

function line

function pinnacle.layout.builtin.line(options: pinnacle.layout.builtin.LineOpts)
    -> pinnacle.layout.builtin.Line

Creates a layout generator that lays out windows in a line.

Parameters

options - Options for the generator.
  ┃ pinnacle.layout.builtin.LineOpts

Returns

1. pinnacle.layout.builtin.Line

function master_stack

function pinnacle.layout.builtin.master_stack(options: pinnacle.layout.builtin.MasterStackOpts)
    -> pinnacle.layout.builtin.MasterStack

Creates a layout generator that lays windows out in two stacks: a master and side stack.

Parameters

options - Options for the generator.
  ┃ pinnacle.layout.builtin.MasterStackOpts

Returns

1. pinnacle.layout.builtin.MasterStack

function dwindle

function pinnacle.layout.builtin.dwindle(options: pinnacle.layout.builtin.DwindleOpts)
    -> pinnacle.layout.builtin.Dwindle

Creates a layout generator that lays windows out dwindling down to the bottom right.

Parameters

options - Options for the generator.
  ┃ pinnacle.layout.builtin.DwindleOpts

Returns

1. pinnacle.layout.builtin.Dwindle

function spiral

function pinnacle.layout.builtin.spiral(options: pinnacle.layout.builtin.SpiralOpts)
    -> pinnacle.layout.builtin.Spiral

Creates a layout generator that lays windows out in a spiral.

Parameters

options - Options for the generator.
  ┃ pinnacle.layout.builtin.SpiralOpts

Returns

1. pinnacle.layout.builtin.Spiral

function corner

function pinnacle.layout.builtin.corner(options: pinnacle.layout.builtin.CornerOpts)
    -> pinnacle.layout.builtin.Corner

Creates a layout generator that lays windows out with one main corner window and a horizontal and vertical stack flanking the other two sides.

Parameters

options - Options for the generator.
  ┃ pinnacle.layout.builtin.CornerOpts

Returns

1. pinnacle.layout.builtin.Corner

function fair

function pinnacle.layout.builtin.fair(options: pinnacle.layout.builtin.FairOpts)
    -> pinnacle.layout.builtin.Fair

Creates a layout generator that lays windows out keeping their sizes roughly the same.

Parameters

options - Options for the generator.
  ┃ pinnacle.layout.builtin.FairOpts

Returns

1. pinnacle.layout.builtin.Fair

function floating

function pinnacle.layout.builtin.floating()
    -> pinnacle.layout.builtin.Floating

Creates a layout generator that floats windows.

Returns

1. pinnacle.layout.builtin.Floating

function cycle

function pinnacle.layout.builtin.cycle(layouts: pinnacle.layout.LayoutGenerator[])
    -> pinnacle.layout.builtin.Cycle

Creates a layout generator that delegates to other layout generators depending on the tag and allows you to cycle between the generators.

Parameters

layouts - The layouts that this generator will cycle between.
  ┃ pinnacle.layout.LayoutGenerator[]

Returns

1. pinnacle.layout.builtin.Cycle