From b96d696a74ad8145f0dee6cf3e2a11fc86ce9f27 Mon Sep 17 00:00:00 2001 From: Reinout Meliesie Date: Thu, 15 Feb 2024 15:21:58 +0100 Subject: [PATCH] docs: add networkmanager module documentation --- docs/modules/Networkmanager.md | 72 ++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 docs/modules/Networkmanager.md diff --git a/docs/modules/Networkmanager.md b/docs/modules/Networkmanager.md new file mode 100644 index 0000000..1c09ad8 --- /dev/null +++ b/docs/modules/Networkmanager.md @@ -0,0 +1,72 @@ +Displays network connectivity information. Requires NetworkManager. + +## Configuration + +> Type: `networkmanager` + +| Name | Type | Default | Description | +|-------------|-----------|---------|-------------------------| +| `icon_size` | `integer` | `24` | Size to render icon at. | + +
+JSON + +```json +{ + "end": [ + { + "type": "networkmanager", + "icon_size": 32 + } + ] +} +``` + +
+ +
+TOML + +```toml +[[end]] +type = "networkmanager" +icon_size = 32 +``` + +
+ +
+YAML + +```yaml +end: + - type: "networkmanager" + icon_size: 32 +``` + +
+ +
+Corn + +```corn +{ + end = [ + { + type = "networkmanager" + icon_size = 32 + } + ] +} +``` + +
+ +## Styling + +| Selector | Description | +|------------------------|----------------------------------| +| `.networkmanager` | NetworkManager widget container. | +| `.networkmanger .icon` | NetworkManager widget icon. | + +For more information on styling, please see the [styling guide](styling-guide).