zedfrigg/ironbar
1
0
Fork 0
mirror of https://github.com/Zedfrigg/ironbar.git synced 2025-07-02 03:01:04 +02:00
Code Activity

docs: add networkmanager module documentation

Browse source
This commit is contained in:
Reinout Meliesie 2024-02-15 15:21:58 +01:00
parent b92c8d65ce
commit b96d696a74
Signed by: zedfrigg
GPG key ID: 3AFCC06481308BC6
1 changed files with 72 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

72
docs/modules/Networkmanager.md Normal file
View file

@ -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. |
<details>
<summary>JSON</summary>
```json
{
"end": [
{
"type": "networkmanager",
"icon_size": 32
}
]
}
```
</details>
<details>
<summary>TOML</summary>
```toml
[[end]]
type = "networkmanager"
icon_size = 32
```
</details>
<details>
<summary>YAML</summary>
```yaml
end:
- type: "networkmanager"
icon_size: 32
```
</details>
<details>
<summary>Corn</summary>
```corn
{
end = [
{
type = "networkmanager"
icon_size = 32
}
]
}
```
</details>
## Styling
| Selector | Description |
|------------------------|----------------------------------|
| `.networkmanager` | NetworkManager widget container. |
| `.networkmanger .icon` | NetworkManager widget icon. |
For more information on styling, please see the [styling guide](styling-guide).