config.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "numOrPercentage": {
      "$ref": "https://raw.githubusercontent.com/ogios/way-edges/master/config/defs.schema.json#UtilNumOrPercentage"
    },
    "AllWidgets": {
      "$ref": "https://raw.githubusercontent.com/ogios/way-edges/master/config/defs.schema.json#AllWidgets"
    }
  },
  "title": "way-edges config",
  "description": "A configuration for way-edges",
  "type": "object",
  "properties": {
    "groups": {
      "description": "Groups of buttons. you can activate each group by `way-edges [group_name]`.\nDefault empty array",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of the group, can be empty if exist only one group.\nDefault empty string",
            "type": "string"
          },
          "widgets": {
            "description": "Button items: available params:\nedge | position | layer | width | height | margin | monitor_id | monitor_name | widget",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "Name of the widget, can be empty",
                  "type": "string"
                },
                "edge": {
                  "type": "string",
                  "description": "edge of the screen: top/bottom/left/right.\nDefault `left`",
                  "enum": ["top", "bottom", "left", "right"]
                },
                "position": {
                  "type": "string",
                  "description": "position of the edge: top/bottom; left/right; or leave empty string for center.\nDefault `center`",
                  "enum": ["", "top", "bottom", "left", "right", "center"]
                },
                "layer": {
                  "type": "string",
                  "description": "layer of the screen: background/bottom/top/overlay.\nDefault `top`",
                  "enum": ["top", "bottom", "background", "overlay"]
                },
                "margin": {
                  "description": "margin of the button, relative to the `position`.\nDefault all 0.",
                  "type": "object",
                  "properties": {
                    "top": {
                      "description": "top margin of the button\nDefault 0",
                      "$ref": "#/definitions/numOrPercentage"
                    },
                    "bottom": {
                      "description": "bottom margin of the button\nDefault 0",
                      "$ref": "#/definitions/numOrPercentage"
                    },
                    "left": {
                      "description": "left margin of the button\nDefault 0",
                      "$ref": "#/definitions/numOrPercentage"
                    },
                    "right": {
                      "description": "right margin of the button\nDefault 0",
                      "$ref": "#/definitions/numOrPercentage"
                    }
                  }
                },
                "monitor_id": {
                  "description": "Which monitor to show the button, ignored when given `monitor_name`.\nDefault 0",
                  "type": "integer",
                  "minimum": 0
                },
                "monitor_name": {
                  "description": "Which monitor to show the button.\nDefault empty string",
                  "type": "string"
                },
                "widget": {
                  "description": "Select one widget type",
                  "$ref": "#/definitions/AllWidgets"
                }
              }
            }
          }
        }
      }
    }
  }
}