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/netstat/index.ts
+++ b/customModules/netstat/index.ts
@@ -0,0 +1,113 @@
+import options from 'options';
+import { module } from '../module';
+import { inputHandler } from 'customModules/utils';
+import { computeNetwork } from './computeNetwork';
+import { NetstatLabelType } from 'lib/types/bar';
+import Gtk from 'types/@girs/gtk-3.0/gtk-3.0';
+import Button from 'types/widgets/button';
+import { NetworkResourceData } from 'lib/types/customModules/network';
+import { NETWORK_LABEL_TYPES } from 'lib/types/defaults/bar';
+import { GET_DEFAULT_NETSTAT_DATA } from 'lib/types/defaults/netstat';
+import { pollVariable } from 'customModules/PollVar';
+
+const {
+    label,
+    labelType,
+    networkInterface,
+    rateUnit,
+    icon,
+    round,
+    leftClick,
+    rightClick,
+    middleClick,
+    pollingInterval,
+} = options.bar.customModules.netstat;
+
+export const networkUsage = Variable<NetworkResourceData>(
+    GET_DEFAULT_NETSTAT_DATA(rateUnit.value),
+);
+
+pollVariable(
+    // Variable to poll and update with the result of the function passed in
+    networkUsage,
+    // Variables that should trigger the polling function to update when they change
+    [rateUnit.bind('value'), networkInterface.bind('value'), round.bind('value')],
+    // Interval at which to poll
+    pollingInterval.bind('value'),
+    // Function to execute to get the network data
+    computeNetwork,
+    // Optional parameters to pass to the function
+    // round is a boolean that determines whether to round the values
+    round,
+    // Optional parameters to pass to the function
+    // networkInterface is the interface name to filter the data
+    networkInterface,
+    // Optional parameters to pass to the function
+    // rateUnit is the unit to display the data in
+    // e.g. KiB, MiB, GiB, etc.
+    rateUnit,
+);
+
+export const Netstat = () => {
+    const renderNetworkLabel = (
+        lblType: NetstatLabelType,
+        network: NetworkResourceData,
+    ): string => {
+        switch (lblType) {
+            case 'in':
+                return `↓ ${network.in}`;
+            case 'out':
+                return `↑ ${network.out}`;
+            default:
+                return `↓ ${network.in} ↑ ${network.out}`;
+        }
+    };
+
+    const netstatModule = module({
+        textIcon: icon.bind('value'),
+        label: Utils.merge(
+            [networkUsage.bind('value'), labelType.bind('value')],
+            (network: NetworkResourceData, lblTyp: NetstatLabelType) => renderNetworkLabel(lblTyp, network),
+        ),
+        tooltipText: labelType.bind('value').as((lblTyp) => {
+            return lblTyp === 'full' ? 'Ingress / Egress' : lblTyp === 'in' ? 'Ingress' : 'Egress';
+        }),
+        boxClass: 'netstat',
+        showLabelBinding: label.bind('value'),
+        props: {
+            setup: (self: Button<Gtk.Widget, Gtk.Widget>) => {
+                inputHandler(self, {
+                    onPrimaryClick: {
+                        cmd: leftClick,
+                    },
+                    onSecondaryClick: {
+                        cmd: rightClick,
+                    },
+                    onMiddleClick: {
+                        cmd: middleClick,
+                    },
+                    onScrollUp: {
+                        fn: () => {
+                            labelType.value =
+                                NETWORK_LABEL_TYPES[
+                                (NETWORK_LABEL_TYPES.indexOf(labelType.value) + 1) % NETWORK_LABEL_TYPES.length
+                                ] as NetstatLabelType;
+                        },
+                    },
+                    onScrollDown: {
+                        fn: () => {
+                            labelType.value =
+                                NETWORK_LABEL_TYPES[
+                                (NETWORK_LABEL_TYPES.indexOf(labelType.value) - 1 + NETWORK_LABEL_TYPES.length) %
+                                NETWORK_LABEL_TYPES.length
+                                ] as NetstatLabelType;
+                        },
+                    },
+                });
+            },
+        },
+    });
+
+    return netstatModule;
+};
+