From 65654282a98cb0590d498e4ed9c924f97646f1dc Mon Sep 17 00:00:00 2001 From: Aylur Date: Wed, 25 Sep 2024 23:22:01 +0000 Subject: docs: restructure --- docs/libraries/tray.md | 97 -------------------------------------------------- 1 file changed, 97 deletions(-) delete mode 100644 docs/libraries/tray.md (limited to 'docs/libraries/tray.md') diff --git a/docs/libraries/tray.md b/docs/libraries/tray.md deleted file mode 100644 index c8d093b..0000000 --- a/docs/libraries/tray.md +++ /dev/null @@ -1,97 +0,0 @@ -# Tray - -Library for managing the systemtray by implementing the [StatusNotifierItem](https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/) protocol. - -## Installation - -1. install dependencies - -:::code-group - -```sh [ Arch] -sudo pacman -Syu meson gtk3 gobject-introspection libdbusmenu-gtk3 -``` - -```sh [ Fedora] -sudo dnf install meson gcc gtk3-devel libdbusmenu-gtk3 gobject-introspection-devel -``` - -```sh [ Ubuntu] -sudo apt install meson libgtk-3-dev libdbusmenu-gtk3-dev gobject-introspection -``` - -::: - -2. clone repo - -```sh -git clone https://github.com/aylur/astal.git -cd astal/lib/tray -``` - -3. install - -```sh -meson setup build -meson install -C build -``` - -:::tip -Most distros recommend manual installs in `/usr/local`, -which is what `meson` defaults to. If you want to install to `/usr` -instead which most package managers do, set the `prefix` option: - -```sh -meson setup --prefix /usr build -``` - -::: - -## Usage - -You can browse the [Tray reference](https://aylur.github.io/libastal/tray). - -### CLI - -```sh -astal-tray --help -``` - -### Library - -:::code-group - -```js [ JavaScript] -import Tray from "gi://AstalTray" - -const tray = Tray.get_default() - -for (const item of tray.get_items()) { - print(item.title) -} -``` - -```py [ Python] -from gi.repository import AstalTray as Tray - -tray = Tray.get_default() - -for item in tray.get_items(): - print(item.title) -``` - -```lua [ Lua] -local Tray = require("lgi").require("AstalTray") - -local tray = Tray.get_default() - -for _, i in ipairs(tray.items) do - print(i.title) -end -``` - -```vala [ Vala] -// Not yet documented -``` - -::: -- cgit v1.2.3