Giblets

• Index

Contents

• Functions
• Tables

Modules

• giblets
• giblets.gizmos
• giblets.gizmos.diskusage
• giblets.utils
• giblets.utils.leaf
• giblets.widgets
• giblets.widgets.progressbar

Examples

• diskusage.lua
• leaf.lua
• progressbar.lua

Module giblets.utils.leaf

Leaf utility.

TODO: write an actual description

Info:

• Copyright: 2015 Nathan Lundquist
• Author: Nathan Lundquist (atatsu)

Functions

Leaf.new (app[, opts])	Create a new Leaf.
Leaf:toggle ()	Toggle the leaf.

Tables

opts	Leaf options.

Functions

Leaf.new (app[, opts])

Create a new Leaf.

Parameters:

• app string Application to execute.
• opts table Options for controlling the look and behavior of the Leaf. For a break down of all available options and their defaults see opts. (optional)

Returns:

Leaf A new Leaf instance.

See also:

leaf.lua

Usage:

local termleaf = giblets.utils.leaf("urxvt")
termleaf:toggle()

Leaf:toggle ()

Toggle the leaf. Show the leaf on the active screen/tag. If it is already shown, hide it. If the leaf is already visible, and this is called from a tag the leaf is not currently on, will simply move the leaf to the new active tag.

Returns:

The leaf instance.

See also:

leaf.lua

Tables

opts

Leaf options.

Fields:

• position string Position of the leaf. Can be one of "top", "bottom", "left", or "right". (default "bottom")
• height number Height of the Leaf application. Can be an absolute pixel size or a percentage of the screen if between 0 and 1. (default 0.3)
• width number Width of the Leaf application. Can be an absolute pixel size or a percentage of the screen if between 0 and 1. (default 0.5)
• sticky bool Whether the leaf should show up on all tags or not. (default false)