⚙️ Configuration

We use jsonc for configuration.
Configuration file should be ~/.config/way-edges/config.jsonc.

We also have schema for the configurations: config.schema.json.
Add it to your file:

Example: https://github.com/ogios/dots/tree/master/way-edges

// ~/.config/way-edges/config.jsonc
{
  "$schema": "https://raw.githubusercontent.com/way-edges/way-edges/master/config/config.schema.json"
}

Groups & Group

{
  "groups": [
    {
      "name": "hyprland",
      "widgets": [
        {
          "edge": "top",
          "position": "right",
          "layer": "overlay",
          "monitor": "HDMI-A-1",
          "widget": {
            "type": "workspace",
            "thickness": 25,
            "length": "25%",
            "hover_color": "#ffffff22",
            "active_increase": 0.2,
            "active_color": "#6B8EF0",
            "deactive_color": "#000"
          }
        }
      ]
    }
  ]
}

Array of group objects, each group object contains group name and widgets array.

| Key | Description | | ------- | --------------------------------------------------------------- | | name | name of the group | | widgets | group of widget items, please check Widget item |

Widget item

Array of widget items. If multiple widgets pile up, the last one in array gets to be on the top.

| Name | Description | | ------------------- | ------------------------------------------------------------------------------ | | name | Name of the widget, needed with togglepin | | edge | Edge of the screen, top/bottom/left/right | | position | Ancher of the edge, top/bottom \|\| left/right | | layer | Layer of the shell (window), top/bottom/background/overlay | | margins | Support relative number ("24%"), top/bottom/left/right | | monitor | Monitor index, or the connector name of the monitor, index start from 0 | | ignore_exlusive | whether to overlap with other layershell. | | transition_duration | widget pop up duration. | | animation_curve | Animation of widget popping. | | extra_trigger_size | the extra size for trigger popup, default 1, this does not need to be changed. | | preview_size | reveal some part of the widget, default 0. | | widget | the actual widget, goto widgets |

Example:

{
  "edge": "top",
  "position": "left", // or bottom, top, right
  "monitor": 0, // or "eDP-1"
  "layer": "overlay", // top bottom background overlay
  "margins": {
    "left": "25%",
    "right": "25%",
    "top": "25%",
    "bottom": "25%",
  },
  "ignore_exlusive": true,
  "transition_duration": 200,
  "extra_trigger_size": 5,
  "preview_size": 20, // or "100%"
  "widget": {
    // check `Widgets` config
  },
}