Built-in Layouts

Floating

class libqtile.layout.floating.Floating(float_rules=None, **config)[source]

Floating layout, which does nothing with windows but handles focus order

key default description
auto_float_types {'utility', 'dialog', 'notification', 'splash', 'toolbar'} default wm types to automatically float
border_focus '#0000ff' Border colour for the focused window.
border_normal '#000000' Border colour for un-focused windows.
border_width 1 Border width.
fullscreen_border_width 0 Border width for fullscreen.
max_border_width 0 Border width for maximize.
name 'floating' Name of this layout.

Columns

class libqtile.layout.columns.Columns(**config)[source]

Extension of the Stack layout.

The screen is split into columns, which can be dynamically added or removed. Each column displays either a sigle window at a time from a stack of windows or all of them simultaneously, spliting the column space. Columns and windows can be resized and windows can be shuffled around. This layout can also emulate “Wmii”, “Verical”, and “Max”, depending on the default parameters.

An example key configuration is:

Key([mod], "j", lazy.layout.down()),
Key([mod], "k", lazy.layout.up()),
Key([mod], "h", lazy.layout.left()),
Key([mod], "l", lazy.layout.right()),
Key([mod, "shift"], "j", lazy.layout.shuffle_down()),
Key([mod, "shift"], "k", lazy.layout.shuffle_up()),
Key([mod, "shift"], "h", lazy.layout.shuffle_left()),
Key([mod, "shift"], "l", lazy.layout.shuffle_right()),
Key([mod, "control"], "j", lazy.layout.grow_down()),
Key([mod, "control"], "k", lazy.layout.grow_up()),
Key([mod, "control"], "h", lazy.layout.grow_left()),
Key([mod, "control"], "l", lazy.layout.grow_right()),
Key([mod], "Return", lazy.layout.toggle_split()),
Key([mod], "n", lazy.layout.normalize()),
key default description
autosplit True Autosplit newly created columns.
border_focus '#881111' Border colour for the focused window.
border_normal '#220000' Border colour for un-focused windows.
border_width 2 Border width.
fair False Add new windows to the column with least windows.
grow_amount 10 Amount by which to grow a window/column.
margin 0 Margin of the layout.
name 'columns' Name of this layout.
num_columns 2 Preferred number of columns.

Matrix

class libqtile.layout.matrix.Matrix(columns=2, **config)[source]

This layout divides the screen into a matrix of equally sized cells and places one window in each cell. The number of columns is configurable and can also be changed interactively.

key default description
border_focus '#0000ff' Border colour for the focused window.
border_normal '#000000' Border colour for un-focused windows.
border_width 1 Border width.
margin 0 Margin of the layout
name 'matrix' Name of this layout.

Max

class libqtile.layout.max.Max(**config)[source]

Maximized layout

A simple layout that only displays one window at a time, filling the screen. This is suitable for use on laptops and other devices with small screens. Conceptually, the windows are managed as a stack, with commands to switch to next and previous windows in the stack.

key default description
name 'max' Name of this layout.

MonadTall

class libqtile.layout.xmonad.MonadTall(**config)[source]

Emulate the behavior of XMonad’s default tiling scheme

Main-Pane:

A main pane that contains a single window takes up a vertical portion of the screen based on the ratio setting. This ratio can be adjusted with the cmd_grow_main and cmd_shrink_main or, while the main pane is in focus, cmd_grow and cmd_shrink.

---------------------
|            |      |
|            |      |
|            |      |
|            |      |
|            |      |
|            |      |
---------------------

Using the cmd_flip method will switch which horizontal side the main pane will occupy. The main pane is considered the “top” of the stack.

---------------------
|      |            |
|      |            |
|      |            |
|      |            |
|      |            |
|      |            |
---------------------

Secondary-panes:

Occupying the rest of the screen are one or more secondary panes. The secondary panes will share the vertical space of the screen however they can be resized at will with the cmd_grow and cmd_shrink methods. The other secondary panes will adjust their sizes to smoothly fill all of the space.

---------------------          ---------------------
|            |      |          |            |______|
|            |______|          |            |      |
|            |      |          |            |      |
|            |______|          |            |      |
|            |      |          |            |______|
|            |      |          |            |      |
---------------------          ---------------------

Panes can be moved with the cmd_shuffle_up and cmd_shuffle_down methods. As mentioned the main pane is considered the top of the stack; moving up is counter-clockwise and moving down is clockwise.

The opposite is true if the layout is “flipped”.

---------------------          ---------------------
|            |  2   |          |   2   |           |
|            |______|          |_______|           |
|            |  3   |          |   3   |           |
|     1      |______|          |_______|     1     |
|            |  4   |          |   4   |           |
|            |      |          |       |           |
---------------------          ---------------------

Normalizing:

To restore all client windows to their default size ratios simply use the cmd_normalize method.

Maximizing:

To toggle a client window between its minimum and maximum sizes simply use the cmd_maximize on a focused client.

Suggested Bindings:

Key([modkey], "h", lazy.layout.left()),
Key([modkey], "l", lazy.layout.right()),
Key([modkey], "j", lazy.layout.down()),
Key([modkey], "k", lazy.layout.up()),
Key([modkey, "shift"], "h", lazy.layout.swap_left()),
Key([modkey, "shift"], "l", lazy.layout.swap_right()),
Key([modkey, "shift"], "j", lazy.layout.shuffle_down()),
Key([modkey, "shift"], "k", lazy.layout.shuffle_up()),
Key([modkey], "i", lazy.layout.grow()),
Key([modkey], "m", lazy.layout.shrink()),
Key([modkey], "n", lazy.layout.normalize()),
Key([modkey], "o", lazy.layout.maximize()),
Key([modkey, "shift"], "space", lazy.layout.flip()),
key default description
align 0 Which side master plane will be placed (one of MonadTall._left or MonadTall._right)
border_focus '#ff0000' Border colour for the focused window.
border_normal '#000000' Border colour for un-focused windows.
border_width 2 Border width.
change_ratio 0.05 Resize ratio
change_size 20 Resize change in pixels
margin 0 Margin of the layout
name 'xmonad-tall' Name of this layout.
new_at_current False Place new windows at the position of the active window.
ratio 0.5 The percent of the screen-space the master pane should occupy by default.
single_border_width None Border width for single window

RatioTile

class libqtile.layout.ratiotile.RatioTile(**config)[source]

Tries to tile all windows in the width/height ratio passed in

key default description
border_focus '#0000ff' Border colour for the focused window.
border_normal '#000000' Border colour for un-focused windows.
border_width 1 Border width.
fancy False Use a different method to calculate window sizes.
margin 0 Margin of the layout
name 'ratiotile' Name of this layout.
ratio 1.618 Ratio of the tiles
ratio_increment 0.1 Amount to increment per ratio increment

Slice

class libqtile.layout.slice.Slice(**config)[source]

Slice layout

This layout cuts piece of screen and places a single window on that piece, and delegates other window placement to other layout

key default description
fallback <libqtile.layout.max.Max object at 0x7f0c9613a470> Fallback layout
name 'max' Name of this layout.
role None WM_WINDOW_ROLE to match
side 'left' Side of the slice (left, right, top, bottom)
width 256 Slice width
wmclass None WM_CLASS to match
wname None WM_NAME to match

Stack

class libqtile.layout.stack.Stack(**config)[source]

A layout composed of stacks of windows

The stack layout divides the screen horizontally into a set of stacks. Commands allow you to switch between stacks, to next and previous windows within a stack, and to split a stack to show all windows in the stack, or unsplit it to show only the current window. At the moment, this is the most mature and flexible layout in Qtile.

key default description
autosplit False Auto split all new stacks.
border_focus '#0000ff' Border colour for the focused window.
border_normal '#000000' Border colour for un-focused windows.
border_width 1 Border width.
fair False Add new windows to the stacks in a round robin way.
margin 0 Margin of the layout
name 'stack' Name of this layout.
num_stacks 2 Number of stacks.

Tile

class libqtile.layout.tile.Tile(ratio=0.618, masterWindows=1, expand=True, ratio_increment=0.05, add_on_top=True, shift_windows=False, master_match=None, **config)[source]
key default description
border_focus '#0000ff' Border colour for the focused window.
border_normal '#000000' Border colour for un-focused windows.
border_width 1 Border width.
margin 0 Margin of the layout
name 'tile' Name of this layout.

TreeTab

class libqtile.layout.tree.TreeTab(**config)[source]

Tree Tab Layout

This layout works just like Max but displays tree of the windows at the left border of the screen, which allows you to overview all opened windows. It’s designed to work with uzbl-browser but works with other windows too.

key default description
active_bg '000080' Background color of active tab
active_fg 'ffffff' Foreground color of active tab
bg_color '000000' Background color of tabs
border_width 2 Width of the border
font 'Arial' Font
fontshadow None font shadow color, default is None (no shadow)
fontsize 14 Font pixel size.
inactive_bg '606060' Background color of inactive tab
inactive_fg 'ffffff' Foreground color of inactive tab
level_shift 8 Shift for children tabs
margin_left 6 Left margin of tab panel
margin_y 6 Vertical margin of tab panel
name 'treetab' Name of this layout.
padding_left 6 Left padding for tabs
padding_x 6 Left padding for tab label
padding_y 2 Top padding for tab label
panel_width 150 Width of the left panel
previous_on_rm False Focus previous window on close instead of first.
section_bottom 6 Bottom margin of section
section_fg 'ffffff' Color of section label
section_fontsize 11 Font pixel size of section label
section_left 4 Left margin of section label
section_padding 4 Bottom of margin section label
section_top 4 Top margin of section label
sections ['Default'] Foreground color of inactive tab
vspace 2 Space between tabs

VerticalTile

class libqtile.layout.verticaltile.VerticalTile(**config)[source]

Tiling layout that works nice on vertically mounted monitors

The available height gets divided by the number of panes, if no pane is maximized. If one pane has been maximized, the available height gets split in master- and secondary area. The maximized pane (master pane) gets the full height of the master area and the other panes (secondary panes) share the remaining space. The master area (at default 75%) can grow and shrink via keybindings.

-----------------                -----------------  ---
|               |                |               |   |
|       1       |  <-- Panes     |               |   |
|               |        |       |               |   |
|---------------|        |       |               |   |
|               |        |       |               |   |
|       2       |  <-----+       |       1       |   |  Master Area
|               |        |       |               |   |
|---------------|        |       |               |   |
|               |        |       |               |   |
|       3       |  <-----+       |               |   |
|               |        |       |               |   |
|---------------|        |       |---------------|  ---
|               |        |       |       2       |   |
|       4       |  <-----+       |---------------|   |  Secondary Area
|               |                |       3       |   |
-----------------                -----------------  ---

Normal behavior. No One maximized pane in the master area maximized pane. No and two secondary panes in the specific areas. secondary area.

-----------------------------------  In some cases VerticalTile can be
|                                 |  useful on horizontal mounted
|                1                |  monitors two.
|                                 |  For example if you want to have a
|---------------------------------|  webbrowser and a shell below it.
|                                 |
|                2                |
|                                 |
-----------------------------------

Suggested keybindings:

Key([modkey], 'j', lazy.layout.down()),
Key([modkey], 'k', lazy.layout.up()),
Key([modkey], 'Tab', lazy.layout.next()),
Key([modkey, 'shift'], 'Tab', lazy.layout.next()),
Key([modkey, 'shift'], 'j', lazy.layout.shuffle_down()),
Key([modkey, 'shift'], 'k', lazy.layout.shuffle_up()),
Key([modkey], 'm', lazy.layout.maximize()),
Key([modkey], 'n', lazy.layout.normalize()),
key default description
border_focus '#FF0000' Border color for the focused window.
border_normal '#FFFFFF' Border color for un-focused windows.
border_width 1 Border width.
margin 0 Border margin.
name 'VerticalTile' Name of this layout.

Wmii

class libqtile.layout.wmii.Wmii(**config)[source]

This layout emulates wmii layouts

The screen it split into columns, always starting with one. A new window is created in the active window’s column. Windows can be shifted left and right. If there is no column when shifting, a new one is created. Each column can be stacked or divided (equally split).

This layout implements something akin to wmii’s semantics.

Each group starts with one column. The first window takes up the whole screen. Next window splits the column in half. Windows can be moved to the column to the left or right. If there is no column in the direction being moved into, a new column is created.

Each column can be either stacked (each window takes up the whole vertical real estate) or split (the windows are split equally vertically in the column) Columns can be grown horizontally (cmd_grow_left/right).

My config.py has the following added:

Key(
    [mod, "shift", "control"], "l",
    lazy.layout.grow_right()
),
Key(
    [mod, "shift"], "l",
    lazy.layout.shuffle_right()
),
Key(
    [mod, "shift", "control"], "h",
    lazy.layout.grow_left()
),
Key(
    [mod, "shift"], "h",
    lazy.layout.shuffle_left()
),
Key(
    [mod], "s",
    lazy.layout.toggle_split()
),
key default description
border_focus '#881111' Border colour for the focused window.
border_focus_stack '#0000ff' Border colour for un-focused windows.
border_normal '#220000' Border colour for un-focused windows.
border_normal_stack '#000022' Border colour for un-focused windows.
border_width 2 Border width.
grow_amount 5 Amount by which to grow/shrink a window.
margin 0 Margin of the layout
name 'wmii' Name of this layout.

Zoomy

class libqtile.layout.zoomy.Zoomy(**config)[source]

A layout with single active windows, and few other previews at the right

key default description
columnwidth 150 Width of the right column
margin 0 Margin of the layout
name None The name of this layout (usually the class’ name in lowercase, e.g. ‘max’)
property_big '1.0' Property value to set on normal window
property_name 'ZOOM' Property to set on zoomed window
property_small '0.1' Property value to set on zoomed window