Implement framework for custom modules and out of the box custom modules as well. (#213)

* Create declarative module scaffolding * Added ram module (WIP) * Updates to options, styling and more. * Added function for styling custom modules. * Added utility functions and cleaned up code * Type and fn name updates. * Update module utils to handle absent values. * Added icon color in style2 that was missing. * Linted utils.ts * Add CPU module and update RAM module to use /proc/meminfo. * Added disk storage module. * Consolidate code * Added netstat module and removed elements from systray default ignore list. * Added keyboard layout module. * Fix hook types and move module to customModules directory * Added updates modules. * Spacing updates * Added weather module. * Added power menu and power module in bar. Increased update default interval to 6 ours. * Updated styling of bar buttons, made power menu label toggleable, etc. * Consolidate code and add dynamic tooltips based on data being used. * Make default custom mogules matugen compatible * Update base theme * Fix custom module background coloring * Remove testing opacity. * Update themes to account for new modules * Update nix stuff for libgtop (Need someone to test this) * Update nix * Update fractions to multiplications * Move styling in style directory * Implement a polling framework for variables that can dynamically adjust polling intervals. * Netstat module updates when interface name is changed. * Readme update
2024-09-02 21:10:59 -07:00
parent 4f009b9978
commit 4cdda38604
107 changed files with 6444 additions and 1482 deletions
--- a/customModules/module.ts
+++ b/customModules/module.ts
@@ -0,0 +1,82 @@
+import { Module } from "lib/types/bar";
+import options from "options";
+import Gtk from "types/@girs/gtk-3.0/gtk-3.0";
+import { Binding } from "types/service";
+import { Variable as VariableType } from "types/variable";
+
+const { style } = options.theme.bar.buttons;
+
+const undefinedVar = Variable(undefined);
+
+export const module = ({
+    icon,
+    textIcon,
+    label,
+    tooltipText,
+    boxClass,
+    props = {},
+    showLabelBinding = undefinedVar.bind("value"),
+    showLabel,
+    labelHook,
+    hook
+}: Module) => {
+    const getIconWidget = () => {
+        let iconWidget: Gtk.Widget | undefined;
+
+        if (icon !== undefined) {
+            iconWidget = Widget.Icon({
+                class_name: `txt-icon bar-button-icon module-icon ${boxClass}`,
+                icon: icon
+            }) as unknown as Gtk.Widget;
+        } else if (textIcon !== undefined) {
+            iconWidget = Widget.Label({
+                class_name: `txt-icon bar-button-icon module-icon ${boxClass}`,
+                label: textIcon
+            }) as unknown as Gtk.Widget;
+        }
+
+        return iconWidget;
+    }
+
+    return {
+        component: Widget.Box({
+            className: Utils.merge([style.bind("value"), showLabelBinding], (style: string, shwLabel: boolean) => {
+                const shouldShowLabel = shwLabel || showLabel;
+                const styleMap = {
+                    default: "style1",
+                    split: "style2",
+                    wave: "style3",
+                };
+                return `${boxClass} ${styleMap[style]} ${!shouldShowLabel ? "no-label" : ""}`;
+            }),
+            tooltip_text: tooltipText,
+            children: Utils.merge(
+                [showLabelBinding],
+                (showLabelBinding): Gtk.Widget[] => {
+                    const childrenArray: Gtk.Widget[] = [];
+                    const iconWidget = getIconWidget();
+
+                    if (iconWidget !== undefined) {
+                        childrenArray.push(iconWidget);
+                    }
+
+                    if (showLabelBinding) {
+                        childrenArray.push(
+                            Widget.Label({
+                                class_name: `bar-button-label module-label ${boxClass}`,
+                                label: label,
+                                setup: labelHook,
+                            }) as unknown as Gtk.Widget
+                        );
+                    }
+                    return childrenArray;
+                }
+            ) as Binding<VariableType<Gtk.Widget[]>, any, Gtk.Widget[]>,
+            setup: hook,
+        }),
+        tooltip_text: tooltipText,
+        isVisible: true,
+        boxClass,
+        props
+    };
+};