Workspace

Library for monitoring and manipulating the compositor's workspaces, based on the ext-workspace-v1 protocol.

Usage

You can browse the Workspace reference.

CLI

astal-workspace --help

Library

The AstalWorkspace library is initialized asynchronously; therefore, all lists (e.g. workspaces) are initially empty. This is usually not an issue. When you bind to these values, your widget will receive updates as soon as the compositor finishes sending the data. However, this means that you won't get the correct data when accessing the library's properties at the top level. You can listen for the "updated" signal to accomodate this.

JavaScript

import Workspace from "gi://AstalWorkspace"

const ws = Workspace.get_default()

for (const workspace of ws.workspaces) {
    print(workspace.name)
}

Python

from gi.repository import AstalWorkspace as Workspace

ws = Workspace.get_default()

for workspace in ws.get_workspaces():
    print(workspace.get_name())

Lua

local Workspace = require("lgi").require("AstalWorkspace")

local ws = Workspace.get_default()

for _, workspace in ipairs(ws.workspaces) do
    print(workspace.name)
end

Vala

var ws = AstalWorkspace.get_default();

foreach (var workspace in ws.workspaces) {
    print(workspace.name);
}

Installation

1. install dependencies

   Note that the library depends on AstalWl, which must be installed before this one. In addition, the AstalWl4 helper library is useful if you want to filter workspaces per GDK monitor.

   Arch

   sudo pacman -Syu meson vala valadoc json-glib gobject-introspection

   Fedora

   sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel

   Ubuntu

   sudo apt install meson valac valadoc libjson-glib-dev gobject-introspection

2. clone repo

   git clone https://github.com/aylur/astal.git
   cd astal/lib/workspace

3. install

   meson setup build
   meson install -C build