mirror of
https://github.com/Zedfrigg/ironbar.git
synced 2025-04-19 19:34:24 +02:00
Jake Stanger
dea66415c2
BREAKING CHANGE: To allow for the `name` property, any widgets that were previously targeted by name should be targeted by class instead. This affects **all modules and all popups**, as well as several widgets inside modules. **This will break a lot of rules in your stylesheet**. To attempt to mitigate the damage, a migration script can be found [here](https://raw.githubusercontent.com/JakeStanger/ironbar/master/scripts/migrate-styles.sh) that should get you most of the way. Resolves #75.
98 lines
No EOL
3 KiB
Markdown
98 lines
No EOL
3 KiB
Markdown
> ⚠ **This module is currently only supported on Sway and Hyprland**
|
|
|
|
Shows all current workspaces. Clicking a workspace changes focus to it.
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
> Type: `workspaces`
|
|
|
|
| Name | Type | Default | Description |
|
|
|----------------|-----------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `name_map` | `Map<string, string/image>` | `{}` | A map of actual workspace names to their display labels/images. Workspaces use their actual name if not present in the map. See [here](images) for information on images. |
|
|
| `icon_size` | `integer` | `32` | Size to render icon at (image icons only). |
|
|
| `all_monitors` | `boolean` | `false` | Whether to display workspaces from all monitors. When `false`, only shows workspaces on the current monitor. |
|
|
| `sort` | `added` or `alphanumeric` | `alphanumeric` | The method used for sorting workspaces. `added` always appends to the end, `alphanumeric` sorts by number/name. |
|
|
|
|
<details>
|
|
<summary>JSON</summary>
|
|
|
|
```json
|
|
{
|
|
"end": [
|
|
{
|
|
"type": "workspaces",
|
|
"name_map": {
|
|
"1": "",
|
|
"2": "",
|
|
"3": ""
|
|
},
|
|
"all_monitors": false
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>TOML</summary>
|
|
|
|
```toml
|
|
[[end]]
|
|
type = "workspaces"
|
|
all_monitors = false
|
|
|
|
[[end.name_map]]
|
|
1 = ""
|
|
2 = ""
|
|
3 = ""
|
|
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>YAML</summary>
|
|
|
|
```yaml
|
|
end:
|
|
- type: "workspaces"
|
|
name_map:
|
|
1: ""
|
|
2: ""
|
|
3: ""
|
|
all_monitors: false
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Corn</summary>
|
|
|
|
```corn
|
|
{
|
|
end = [
|
|
{
|
|
type = "workspaces",
|
|
name_map.1 = ""
|
|
name_map.2 = ""
|
|
name_map.3 = ""
|
|
all_monitors = false
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
</details>
|
|
|
|
## Styling
|
|
|
|
| Selector | Description |
|
|
|-----------------------------|--------------------------------------|
|
|
| `.workspaces` | Workspaces widget box |
|
|
| `.workspaces .item` | Workspace button |
|
|
| `.workspaces .item.focused` | Workspace button (workspace focused) |
|
|
|
|
For more information on styling, please see the [styling guide](styling-guide). |