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:
parent
ed9332d854
commit
417a6be0d3
1 changed files with 41 additions and 39 deletions
|
@ -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
|
## Configuration
|
||||||
|
|
||||||
|
@ -9,57 +15,53 @@ Displays network connectivity information. Requires NetworkManager.
|
||||||
| `icon_size` | `integer` | `24` | Size to render icon at. |
|
| `icon_size` | `integer` | `24` | Size to render icon at. |
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>JSON</summary>
|
<summary>JSON</summary>
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"end": [
|
|
||||||
{
|
|
||||||
"type": "networkmanager",
|
|
||||||
"icon_size": 32
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"end": [
|
||||||
|
{
|
||||||
|
"type": "networkmanager",
|
||||||
|
"icon_size": 32
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>TOML</summary>
|
<summary>TOML</summary>
|
||||||
|
|
||||||
```toml
|
|
||||||
[[end]]
|
|
||||||
type = "networkmanager"
|
|
||||||
icon_size = 32
|
|
||||||
```
|
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[[end]]
|
||||||
|
type = "networkmanager"
|
||||||
|
icon_size = 32
|
||||||
|
```
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>YAML</summary>
|
<summary>YAML</summary>
|
||||||
|
|
||||||
```yaml
|
|
||||||
end:
|
|
||||||
- type: "networkmanager"
|
|
||||||
icon_size: 32
|
|
||||||
```
|
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
end:
|
||||||
|
- type: "networkmanager"
|
||||||
|
icon_size: 32
|
||||||
|
```
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Corn</summary>
|
<summary>Corn</summary>
|
||||||
|
|
||||||
```corn
|
|
||||||
{
|
|
||||||
end = [
|
|
||||||
{
|
|
||||||
type = "networkmanager"
|
|
||||||
icon_size = 32
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
```corn
|
||||||
|
{
|
||||||
|
end = [
|
||||||
|
{
|
||||||
|
type = "networkmanager"
|
||||||
|
icon_size = 32
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
## Styling
|
## Styling
|
||||||
|
|
Loading…
Add table
Reference in a new issue