mirror of
https://github.com/Zedfrigg/ironbar.git
synced 2025-07-02 03:01:04 +02:00
docs: add networkmanager module documentation
This commit is contained in:
parent
b92c8d65ce
commit
b96d696a74
1 changed files with 72 additions and 0 deletions
72
docs/modules/Networkmanager.md
Normal file
72
docs/modules/Networkmanager.md
Normal 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).
|
Loading…
Add table
Add a link
Reference in a new issue