base config

Author: ogios

data/doc/3.basic_config.md

@@ -17,23 +17,28 @@ Add it to your file:
 
 ```json
 {
-  "groups": {
-    "type": "array",
-    "items": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string"
-        },
-        "widgets": {
-          "type": "array",
-          "items": {
-            ...
+  "groups": [
+    {
+      "name": "hyprland",
+      "widgets": [
+        {
+          "edge": "top",
+          "position": "right",
+          "layer": "overlay",
+          "monitor": "HDMI-A-1",
+          "widget": {
+            "type": "hypr-workspace",
+            "thickness": 25,
+            "length": "25%",
+            "hover_color": "#ffffff22",
+            "active_increase": 0.2,
+            "active_color": "#6B8EF0",
+            "deactive_color": "#000"
           }
         }
-      }
+      ]
     }
-  }
+  ]
 }
 ```
 
@@ -44,47 +49,46 @@ Array of group objects, each group object contains `group name` and `widgets` ar
 | name    | name of the group                                               |
 | widgets | group of widget items, please check [Widget item](#widget-item) |
 
-_Example:_
-
-```json
-{
-  "groups": [
-    {
-      "name": "example",
-      "widgets": []
-    }
-  ]
-}
-```
-
 ## 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.                               |
-| widget          | the actual widget, goto `widgets`                                       |
+| 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.                                                        |
+| frame_rate          | default to your monitor refresh rate, you should not change it normally.       |
+| 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:_
 
-```json
+```jsonc
 {
   "edge": "top",
-  "position": "left",
-  // "monitor": "eDP-1",
-  "layer": "overlay",
+  "position": "left", // or bottom, top, right
+  "monitor": 0, // or "eDP-1"
+  "layer": "overlay", // top bottom background overlay
   "margins": {
-    "left": "25%"
+    "left": "25%",
+    "right": "25%",
+    "top": "25%",
+    "bottom": "25%",
   },
+  "ignore_exlusive": true,
+  "transition_duration": 200,
+  "frame_rate": 144,
+  "extra_trigger_size": 5,
+  "preview_size": 20, // or "100%"
   "widget": {
     // check `Widgets` config
-  }
+  },
 }
 ```