1
0
Fork 0
mirror of https://github.com/Zedfrigg/ironbar.git synced 2025-04-19 19:34:24 +02:00

docs: expand module docs, add note about primary connection limitations

This commit is contained in:
Reinout Meliesie 2024-03-30 17:07:33 +01:00
parent ed9332d854
commit 417a6be0d3
Signed by: zedfrigg
GPG key ID: 3AFCC06481308BC6

View file

@ -1,4 +1,10 @@
Displays network connectivity information. Requires NetworkManager.
Displays the current network connection state of NetworkManager. Supports wired ethernet, wifi,
cellular data and VPN connections among others.
This module uses NetworkManager's so-called primary connection, and therefore inherits its
limitation of only being able to display the "top-level" connection. For example, if we have a VPN
connection over a wifi connection it will only display the former, until it is disconnected, at
which point it will display the latter. A solution to this is currently in the works.
## Configuration
@ -9,57 +15,53 @@ Displays network connectivity information. Requires NetworkManager.
| `icon_size` | `integer` | `24` | Size to render icon at. |
<details>
<summary>JSON</summary>
```json
{
"end": [
{
"type": "networkmanager",
"icon_size": 32
}
]
}
```
<summary>JSON</summary>
```json
{
"end": [
{
"type": "networkmanager",
"icon_size": 32
}
]
}
```
</details>
<details>
<summary>TOML</summary>
```toml
[[end]]
type = "networkmanager"
icon_size = 32
```
<summary>TOML</summary>
```toml
[[end]]
type = "networkmanager"
icon_size = 32
```
</details>
<details>
<summary>YAML</summary>
```yaml
end:
- type: "networkmanager"
icon_size: 32
```
<summary>YAML</summary>
```yaml
end:
- type: "networkmanager"
icon_size: 32
```
</details>
<details>
<summary>Corn</summary>
```corn
{
end = [
{
type = "networkmanager"
icon_size = 32
}
]
}
```
<summary>Corn</summary>
```corn
{
end = [
{
type = "networkmanager"
icon_size = 32
}
]
}
```
</details>
## Styling