wf‐panel

wf-panel

wf-panel provides a multifunctional panel with several available widgets (see the list of them below). The panel can place widgets on the left, in the center and on the right.

On the screenshot:

widgets_left = menu window-list
widgets_center = launchers
widgets_right = notifications tray volume battery clock

General configuration

css_path

Sets custom styles.

widgets_left

A space-separated list of widgets on the left side of the panel. The default value is menu spacing4 launchers window-list.

widgets_center

Same as widgets_left, but in the center. The default value is none.

widget_right

Same as widgets_left, but on the right side. The default value is volume network battery clock.

minimal_height

Sets the minimal height of the panel. The default value is 24.

autohide

Enables autohide mode. If enabled, the panel automatically hides and shows when mouse cursor approaches the corresponding edge of screen. Disabled by default.

autohide_duration

Sets the autohide/show duration.

position

Sets the position of the panel. Currently only values top and bottom (edges) are available. The default value is top.

edge_offset

Sets the distance between cursor and the edge of the screen that causes the panel to show if it's hidden. The default value is 20.

layer

Sets the z-depth of the panel. Available values are:

• background
• bottom
• top
• overlay

Applications windows typically are on the top layer. The default value is top.

background_color

Sets the panel's background color. Has a special gtk_headerbar value which sets the background color to the headerbar color from the current theme. The default value is gtk_headerbar.

Available widgets

battery

Shows battery information.

battery_status

Specify what information is displayed. Possible values:

• 0 — only icon
• 1 — icon and battery percentage
• 2 — icon, percentage and remaining (dis)charging time

The default value is 1.

battery_icon_size

Sets the icon size. The default value is 32.

battery_icon_invert

Inverts the battery icon colors if enabled. Enabled by default.

battery_font

Sets the font for battery information label. default value means that the font from the current GTK theme is used. The default value is default.

clock

Displays the current datetime. Shows a popup with a simple calendar widget on click.

clock_format

Clock format to be displayed. See the full list of available format modifiers here. The default value is %e %A %H:%M.

clock_font

Sets the font for the clock's label. default value means that default font from the current GTK theme is used. The default value is default.

command-output

Displays several items, each containing an icon and a label. The text of the label is set from the output of a command which is launched as a subprocess periodically to update the text. Inspired by this plugin for XFCE panel.

command_output_max_chars

Max characters of the command output to display on the panel. The default value is 10.

commands

Each item has a name and can be configured independently. To add a new item, add command_output_<name> option in the panel's config section. The following options are available for each item:

command_output_<name>

The command which output is used to update the label. To configure the look of the output, use Pango Markup. This option is required to be specified.

command_output_tooltip_<name>

The command which output is used to update the item's tooltip. Supports Pango Markup as well. Leave empty or not specified to disable tooltip.

command_output_period_<name>

Time in seconds, sets how often the command is launched to get a new output and update the label. Set 0 to only update on startup and by clicking the item and -1 to leave the label empty on startup. The default value is 0.

command_output_icon_<name>

The icon name to be shown. Leave empty to hide the icon. The default value is text-x-script.

command_output_icon_size_<name>

Sets the icon size. The default value is 32.

command_output_icon_position_<name>

The position of the icon relatively to the label. Available values are top, bottom, left and right. The default value is left.

launchers

Displays several application launchers. Hovering a launcher icon causes the icon to scale.

launchers_spacing

Sets spacing between launcher's icons. The default value is 4.

launchers_size

Sets size of the icons. The default value is 42.

launchers_animation_duration

Duration of scaling animation. The default value is 200.

Each launcher can be loaded from a .desktop file with launcher_<name> = XXX.desktop option, or configured manually with launcher_icon_<name>, launcher_cmd_<name> and launcher_label_<name> optiotns.

menu

Provides a menu with a list of detected applications, a search bar and logout button.

menu_fuzzy_search

Enable fuzzy search. Enabled by default.

menu_icon

Sets the name of the icon displayed on the panel. Leave empty to use wayfire's icon.

menu_min_content_width

Sets the minimum content width. The default value is 500.

menu_min_content_height

Sets the minimum content height. The default value is 500.

menu_logout_command

Sets the logout command. Leave empty to use the wf-panel's built-in logout interface with six buttons, which can be configured with the corresponding options:

• logout_command — the default value is wayland-logout
• reboot_command — the default value is systemctl reboot
• shutdown_command­ — the default value is systemctl poweroff
• suspend_command — the default value is systemctl suspend
• hibernate_command — the default value is systemctl hibernate
• switchuser_command — the default value is dm-tool switch-to-greeter

notifications

This is a notifications center: it shows and stores desktop notifications. The "Do Not Disturb" mode can be toggled with a middle click.

notifications_autohide_timeout

Sets how long (in seconds) a new notification is being displayed to the user when the notification appears. The default value is 2.5.

notifications_critical_in_dnd

Sets if critical notification are shown in "Do Not Disturb" mode. Enabled by default.

notifications_icon_size

Sets the icon size. The default value is 32.

network

Displays the network connection information: a status icon and a text label.

network_status

Sets the content of the label:

• 0 — no text
• 1 — connection name (e.g. WiFi Network name)
• 2 ­— connection name with IP (displaying IP not implemented currently)

Th default value is 1.

network_status_font

Sets the font of the text. The default value is default.

network_icon_size

Sets the size of the status icon. The default value is 32.

network_icon_invert_color

Sets if the status icon should be inverted. Disabled by default.

network_status_use_color

Sets if the text is colored. Disabled by default.

network_onclick_command

Sets the commend to be launched on click. The default value is default which opens the gnome-control-center's connection section.

spacing

Inserts spacing between widgets. It's a special widget: to use it, just append the amount of pixels you want as a padding to the word "spacing" and use it as a plugin. For example:

# inserts 4px of spacing between menu and launchers
widgets_left = menu spacing4 launchers

tray

System tray: an area with icons provided by applications to interact with them from your panel. Left-click an item's icon to trigger its action, middle-click to trigger its secondary action, right-click to open its context menu. Implements StatusNotifierItem specification.

Hint: add blueman-applet and nm-applet to Wayfire's autostart list to get bluetooth and network indicators in the tray.

tray_smooth_scrolling_threshold

Sets the threshold to be used when for smooth scrolling. A technical thing, probably you don't care about it. The default value is 5.

tray_icon_size

Sets the size of the tray item's icons. The default value is 32.

tray_menu_on_middle_click

"Swaps" middle-click and right-click so that middle-click opens an item's context menu and right-click triggers its secondary action. Disabled by default.

volume

Displays the volume state. Shows a popup with a current volume level when it's changed.

volume_display_timeout

Sets the timeout in seconds for the popup with is displayed when the volume level is changed. The default value is 2.5.

volume_icon_size

Sets the icon size. The default value is 32.

window-list

Displays a list of buttons representing currently open windows. Left click the button to minimize/unminimize the window. Right click activates a basic context menu. Drag-and-move the buttons to rearrange them.