Module: awful.popup

An auto-resized, free floating or modal wibox built around a widget.

This type of widget box (wibox) is auto closed when being clicked on and is automatically resized to the size of its main widget.

Note that the widget itself should have a finite size. If something like a wibox.layout.flex is used, then the size would be unlimited and an error will be printed. The wibox.layout.fixed, wibox.container.constraint, forced_width and forced_height are recommended.

Usage example

awful.popup {
    widget = {
        {
            {
                text   = 'foobar',
                widget = wibox.widget.textbox
            },
            {
                {
                    text   = 'foobar',
                    widget = wibox.widget.textbox
                },
                bg     = '#ff00ff',
                clip   = true,
                shape  = gears.shape.rounded_bar,
                widget = wibox.widget.background
            },
            {
                value         = 0.5,
                forced_height = 30,
                forced_width  = 100,
                widget        = wibox.widget.progressbar
            },
            layout = wibox.layout.fixed.vertical,
        },
        margins = 10,
        widget  = wibox.container.margin
    },
    border_color = '#00ff00',
    border_width = 5,
    placement    = awful.placement.top_left,
    shape        = gears.shape.rounded_rect,
    visible      = true,
}

Here is an example of how to create an alt-tab like dialog by leveraging the awful.widget.tasklist.

Usage example

awful.popup {
    widget = awful.widget.tasklist {
        screen   = screen[1],
        filter   = awful.widget.tasklist.filter.allscreen,
        buttons  = tasklist_buttons,
        style    = {
            shape = gears.shape.rounded_rect,
        },
        layout   = {
            spacing = 5,
            forced_num_rows = 2,
            layout = wibox.layout.grid.horizontal
        },
        widget_template = {
            {
                {
                    id     = 'clienticon',
                    widget = awful.widget.clienticon,
                },
                margins = 4,
                widget  = wibox.container.margin,
            },
            id              = 'background_role',
            forced_width    = 48,
            forced_height   = 48,
            widget          = wibox.container.background,
            create_callback = function(self, c, index, objects) --luacheck: no unused
                self:get_children_by_id('clienticon')[1].client = c
            end,
        },
    },
    border_color = '#777777',
    border_width = 2,
    ontop        = true,
    placement    = awful.placement.centered,
    shape        = gears.shape.rounded_rect
}

Info:

  • Copyright: 2016 Emmanuel Lepage Vallee
  • Author: Emmanuel Lepage Vallee

Constructors

awful.popup {[args]} Create a new popup build around a passed in widget.

Object properties

preferred_positions table or string Set the preferred popup position relative to its parent.
preferred_anchors table or string Set the preferred popup anchors relative to the parent.
current_position string The current position relative to the parent object.
current_anchor string Get the current anchor relative to the parent object.
hide_on_right_click boolean Hide the popup when right clicked.
minimum_width number The popup minimum width.
minimum_height number The popup minimum height.
maximum_width number The popup maximum width.
maximum_height number The popup maximum height.
offset table or number The distance between the popup and its parent (if any).
placement function or string or boolean Set the placement function.
border_width integer Border width.
border_color string Border color.
ontop boolean On top of other windows.
cursor string The mouse cursor.
visible boolean Visibility.
opacity number The opacity of the wibox, between 0 and 1.
type string The window type (desktop, normal, dock, …).
x integer The x coordinates.
y integer The y coordinates.
width width The width of the wibox.
height height The height of the wibox.
screen screen The wibox screen.
drawable drawable The wibox’s drawable.
widget widget The widget that the wibox displays.
window string The X window id.
shape_bounding N/A The wibox’s bounding shape as a (native) cairo surface.
shape_clip N/A The wibox’s clip shape as a (native) cairo surface.
shape_input N/A The wibox’s input shape as a (native) cairo surface.
shape gears.shape The wibar’s shape.
input_passthrough boolean Forward the inputs to the client below the wibox.
bg c The background of the wibox.
bgimage image The background image of the drawable.
fg c The foreground (text) of the wibox.

Object methods

:move_next_to ([obj=mouse]) Move the wibox to a position relative to geo.
:bind_to_widget (widget[, button=1]) Bind the popup to a widget button press.
:unbind_to_widget (widget) Unbind the popup from a widget button.
:buttons (buttons_table) Get or set mouse buttons bindings to a wibox.
:geometry (A) Get or set wibox geometry.
:struts (strut) Get or set wibox struts.
:setup {[args]} Set a declarative widget hierarchy description.
:find_widgets (x, y) Find a widget by a point.

Theme variables

beautiful.bg_normal color The default background color.
beautiful.fg_normal color The default foreground (text) color.


Constructors

awful.popup {[args]}
Create a new popup build around a passed in widget.

Parameters:

  • args
    • border_width integer Border width.
    • border_color string Border color.
    • ontop boolean On top of other windows. (default false)
    • cursor string The mouse cursor.
    • visible boolean Visibility.
    • opacity number The opacity, between 0 and 1. (default 1)
    • type string The window type (desktop, normal, dock, …).
    • x integer The x coordinates.
    • y integer The y coordinates.
    • width integer The width.
    • height integer The height.
    • screen screen The wibox screen.
    • widget wibox.widget The widget that the wibox displays.
    • shape_bounding The wibox’s bounding shape as a (native) cairo surface.
    • shape_clip The wibox’s clip shape as a (native) cairo surface.
    • shape_input The wibox’s input shape as a (native) cairo surface.
    • bg color The background.
    • bgimage surface The background image of the drawable.
    • fg color The foreground (text) color.
    • shape gears.shape The shape.
    • input_passthrough boolean If the inputs are forward to the element below. (default false)
    • placement function The awful.placement function
    • preferred_positions string or table
    • preferred_anchors string or table
    • offset table or number The X and Y offset compared to the parent object
    • hide_on_right_click boolean Whether or not to hide the popup on right clicks.

Object properties

preferred_positions (table or string)

Set the preferred popup position relative to its parent.

This allows, for example, to have a submenu that goes on the right of the parent menu. If there is no space on the right, it tries on the left and so on.

Valid directions are:

  • left
  • right
  • top
  • bottom

The basic use case for this method is to give it a parent wibox:

Usage example

for _, v in ipairs {'left', 'right', 'bottom', 'top'} do
    local p2 = awful.popup {
        widget = wibox.widget {
            text   = 'On the '..v,
            widget = wibox.widget.textbox
        },
        border_color        = '#777777',
        border_width        = 2,
        preferred_positions = v,
        ontop               = true,
    }
    p2:move_next_to(p)
end

As demonstrated by this second example, it is also possible to use a widget as a parent object:

Usage example

for _, v in ipairs {'left', 'right'} do
    local p2 = awful.popup {
        widget = wibox.widget {
            text = 'On the '..v,
            forced_height = 100,
            widget = wibox.widget.textbox
        },
        border_color  = '#0000ff',
        preferred_positions = v,
        border_width  = 2,
    }
    p2:move_next_to(textboxinstance, v)
end

Type constraints:

  • preferred_positions table or string A position name or an ordered table of positions

See also:

preferred_anchors (table or string)

Set the preferred popup anchors relative to the parent.

The possible values are:

  • front
  • middle
  • back

For details information, see the awful.placement.next_to documentation.

In this example, it is possible to see the effect of having a fallback preferred anchors when the popup would otherwise not fit:

Usage example

 local p2 = awful.popup {
     widget = wibox.widget {
         text   = 'A popup',
         forced_height = 100,
         widget = wibox.widget.textbox
     },
     border_color        = '#777777',
     border_width        = 2,
     preferred_positions = 'right',
     preferred_anchors   = {'front', 'back'},
 }
 local p4 = awful.popup {
     widget = wibox.widget {
         text   = 'A popup2',
         forced_height = 100,
         widget = wibox.widget.textbox
     },
     border_color        = '#777777',
     border_width        = 2,
     preferred_positions = 'right',
     preferred_anchors   = {'front', 'back'},
 }

Type constraints:

  • preferred_anchors table or string Either a single anchor name or a table ordered by priority.

See also:

current_position (string)
The current position relative to the parent object.

If there is a parent object (widget, wibox, wibar, client or the mouse), then this property returns the current position. This is determined using preferred_positions. It is usually the preferred position, but when there isn’t enough space, it can also be one of the fallback.

Type constraints:

  • current_position string Either “left”, “right”, “top” or “bottom”
current_anchor (string)
Get the current anchor relative to the parent object.

If there is a parent object (widget, wibox, wibar, client or the mouse), then this property returns the current anchor. The anchor is the “side” of the parent object on which the popup is based on. It will “grow” in the opposite direction from the anchor.

Type constraints:

  • current_anchor string Either “front”, “middle”, “back”
hide_on_right_click (boolean)
Hide the popup when right clicked.
minimum_width (number)
The popup minimum width.

Type constraints:

  • The number minimum width (default 1)
minimum_height (number)
The popup minimum height.

Type constraints:

  • The number minimum height (default 1)
maximum_width (number)
The popup maximum width.

Type constraints:

  • The number maximum width (default 1)
maximum_height (number)
The popup maximum height.

Type constraints:

  • The number maximum height (default 1)
offset (table or number)

The distance between the popup and its parent (if any).

Here is an example of 5 popups stacked one below the other with an y axis offset (spacing).

Usage example

local previous = nil
for i=1, 5 do
    local p2 = awful.popup {
        widget = wibox.widget {
            text   = 'Hello world!  '..i..'  aaaa.',
            widget = wibox.widget.textbox
        },
        border_color        = beautiful.border_color,
        preferred_positions = 'bottom',
        border_width        = 2,
        preferred_anchors   = 'back',
        placement           = (not previous) and awful.placement.top or nil,
        offset = {
             y = 10,
        },
    }
    p2:move_next_to(previous)
    previous = p2
end

Type constraints:

  • offset An integer value or a {x=, y=} table.
    • x number The horizontal distance. (default offset)
    • y number The vertical distance. (default offset)
placement (function or string or boolean)
Set the placement function.

Type constraints:

  • The function, string or boolean placement function or name (or false to disable placement) (default next_to)
  • function
border_width (integer)

Border width.

Signal:

  • property::border_width
border_color (string)

Border color.

Please note that this property only support string based 24 bit or 32 bit colors:

Red Blue
 _|  _|
#FF00FF
   T‾
 Green


Red Blue
 _|  _|
#FF00FF00
   T‾  ‾T
Green   Alpha

Signal:

  • property::border_color
ontop (boolean)

On top of other windows.

Signal:

  • property::ontop
cursor (string)

The mouse cursor.

Signal:

  • property::cursor

See also:

visible (boolean)

Visibility.

Signal:

  • property::visible
opacity (number)

The opacity of the wibox, between 0 and 1.

Signal:

  • property::opacity

Type constraints:

  • opacity number (between 0 and 1)
type (string)

The window type (desktop, normal, dock, …).

Signal:

  • property::type

See also:

x (integer)

The x coordinates.

Signal:

  • property::x
y (integer)

The y coordinates.

Signal:

  • property::y
width (width)

The width of the wibox.

Signal:

  • property::width
height (height)

The height of the wibox.

Signal:

  • property::height
screen (screen)
The wibox screen.
drawable (drawable)

The wibox’s drawable.

Signal:

  • property::drawable
widget (widget)
The widget that the wibox displays.
window (string)

The X window id.

Signal:

  • property::window

See also:

shape_bounding (N/A)

The wibox’s bounding shape as a (native) cairo surface.

Signal:

  • property::shape_bounding
shape_clip (N/A)

The wibox’s clip shape as a (native) cairo surface.

Signal:

  • property::shape_clip
shape_input (N/A)

The wibox’s input shape as a (native) cairo surface.

Signal:

  • property::shape_input
shape (gears.shape)

The wibar’s shape.

Signal:

  • property::shape
input_passthrough (boolean)

Forward the inputs to the client below the wibox.

This replace the shape_input mask with an empty area. All mouse and keyboard events are sent to the object (such as a client) positioned below this wibox. When used alongside compositing, it allows, for example, to have a subtle transparent wibox on top a fullscreen client to display important data such as a low battery warning.

Signal:

  • property::input_passthrough

See also:

bg (c)
The background of the wibox.

Type constraints:

  • c The background to use. This must either be a cairo pattern object, nil or a string that gears.color() understands.
  • color

See also:

bgimage (image)
The background image of the drawable. If image is a function, it will be called with (context, cr, width, height) as arguments. Any other arguments passed to this method will be appended.

Type constraints:

  • image A background image or a function

See also:

fg (c)
The foreground (text) of the wibox.

Type constraints:

  • c The foreground to use. This must either be a cairo pattern object, nil or a string that gears.color() understands.
  • color

See also:

Object methods

:move_next_to ([obj=mouse])
Move the wibox to a position relative to geo. This will try to avoid overlapping the source wibox and auto-detect the right direction to avoid going off-screen.

Parameters:

  • obj An object such as a wibox, client or a table entry returned by wibox:find_widgets(). (default mouse)

Returns:

    table The new geometry

See also:

:bind_to_widget (widget[, button=1])
Bind the popup to a widget button press.

Parameters:

  • widget widget The widget
  • button number The button index (default 1)
:unbind_to_widget (widget)
Unbind the popup from a widget button.

Parameters:

:buttons (buttons_table)
Get or set mouse buttons bindings to a wibox.

Parameters:

  • buttons_table A table of buttons objects, or nothing.
:geometry (A)
Get or set wibox geometry. That’s the same as accessing or setting the x, y, width or height properties of a wibox.

Parameters:

  • A table with coordinates to modify.

Returns:

    A table with wibox coordinates and geometry.
:struts (strut)
Get or set wibox struts.

Parameters:

  • strut A table with new strut, or nothing

Returns:

    The wibox strut in a table.

See also:

:setup {[args]}
Set a declarative widget hierarchy description. See The declarative layout system

Parameters:

  • args An array containing the widgets disposition
:find_widgets (x, y)
Find a widget by a point. The wibox must have drawn itself at least once for this to work.

Parameters:

  • x number X coordinate of the point
  • y number Y coordinate of the point

Returns:

    table A sorted table of widgets positions. The first element is the biggest container while the last is the topmost widget. The table contains x, y, width, height and widget.

Theme variables

beautiful.bg_normal (color)
The default background color.

See also:

beautiful.fg_normal (color)
The default foreground (text) color.

See also:

generated by LDoc 1.4.6 Last updated 2030-01-01 00:00:00