slider

Author: ogios

data/doc/4.widgets/1.slide.md

@@ -1,25 +1,53 @@
 # Slide
 
-A slider, with `on_change` property which will be executing a shell command when value changes.
-
-You can use `Slider` as status bar with `update_with_interval_ms` to update the progress on a regular interval.
-
 _Example:_
 
 ```json
 {
   "edge": "top",
+  "monitor": "HDMI-A-1",
+  "position": "left",
+  "layer": "overlay",
+  "margins": {
+    "left": "12.5%"
+  },
+  "widget": {
+    "type": "slider",
+    "thickness": 40,
+    "border_width": 6,
+    "length": "12.5%",
+    "fg_color": "#BD93F9",
+    "redraw_only_on_internal_update": true,
+    "preset": {
+      "type": "microphone"
+    }
+  }
+}
+```
+
+```json
+{
+  "edge": "top",
+  "position": "left",
+  "monitor": "HDMI-A-1",
+  "layer": "overlay",
+  "preview_size": "100%",
   "widget": {
+    "thickness": 50,
+    "length": "25%",
     "type": "slide",
-    "thickness": 20,
-    "length": 400,
-    "transition_duration": 100,
-    "frame_rate": 120,
-    "bg_color": "#0D47A1",
-    "fg_color": "#29B6F6",
-    "text_color": "#fff",
-    "border_color": "#000",
-    "on_change": "notify-send {progress}"
+    "border_width": 9,
+    "preset": {
+      "type": "custom",
+      "interval_update": [100, "seq 0 .01 1 | shuf | head -n1"],
+      "on_change": "notify-send {float:0, 100}",
+      "event_map": {
+        "1": "notify-send 1",
+        "2": "notify-send 2",
+        "3": "notify-send 3"
+        "4": "notify-send 4"
+      }
+    }
   }
 }
 ```
@@ -46,70 +74,15 @@ Support relative value.
 
 _Type: `int | string`_
 
-## `frame_rate`
+## `border_width`
 
-Frame rate per second, won't hurt if over screen refresh rate.
+_Type: `int`_
 
-_Type: `int`_  
-_Default: `60`_
+## `redraw_only_on_internal_update`
 
-## `transition_duration`
-
-Time cost of showing the widget from the edge.  
-Millisecond.
-
-_Type: `int`_  
-_Default: `100`_
+Saves resources, recommend to turn on for speaker and microphone.
 
-## `extra_trigger_size`
-
-Extra mouse event input region of the widget, if `0` then the widget won't be shown by mouse hover.
-
-_Type: `int | string`_  
-_Default: `5`_
-
-## `event_map`
-
-Array of tuples. each tuple contains `mouse key ID` and `shell command`:  
-`[<mouse_key_id>, <shell_command>]`
-
-This event map does not support `long press`/`doule press`/`hover event`... only support single click.
-
-Default mouse keys:
-
-- `1` - Left button
-- `2` - Middle button
-- `3` - Right button
-- ...others you need to test on your self by passing `--mouse-debug`: `way-edges daemon --mouse-debug`
-
-_Type: `[[int, string]...]`_  
-_Default: `[]`_
-
-## `on_change`
-
-Command to execute, replace '{progress}' with the progress from 0-1.  
-Example: `notify-send {progress}`
-
-_Type: `null | string`_  
-_Default: `null`_
-
-## `draggable`
-
-Is progress in slide changeable by mouse left click drag.
-
-_Type: `bool`_  
-_Default: `true`_
-
-## `update_with_interval_ms`
-
-Array of tuples. each tuple contains `millisecond` and `shell command`:  
-`[<millisecond>, <shell_command>]`  
-Example: `[1000, \"echo 0.2333\"]`
-
-For `shell command`, the returned value must be a number within `[0, 1]`.
-
-_Type: `[[int, string]...]`_  
-_Default: `[]`_
+_Type: `bool`_
 
 ## `bg_color`
 
@@ -153,37 +126,93 @@ For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gd
 _Type: `string`_  
 _Default: `#000000`_
 
-## `preview_size`
+## `obtuse_angle`
+
+The 2 obtuse angle in trapezoid, set it within `[90, 180)`, when `90`, you'll get a square.
+
+_Type: `int`_  
+_Default: `120`_
 
-How much area should the widget reveal when hidden
+## `radius`
+
+Radius of the rounded corners for 2 obtuse angle in trapezoid.
 
 _Type: `int`_  
-_Default: `3`_
+_Default: `20`_
 
-## `progress_direction`
+## `preset`
 
-Progress bar: `Forward/Backward`
+### Speaker | Microphone
 
-_Type: `string`_  
-_Default: `Forward`_
+PulseAudio Sink and Source.
 
-## `is_text_position_start`
+#### `type*`
 
-Which side percentage info at, start or end of the widget
+`speaker | microphone`
 
-_Type: `bool`_  
-_Default: `true`_
+#### `mute_color`
 
-## `obtuse_angle`
+`string`
 
-The 2 obtuse angle in trapezoid, set it within `[90, 180)`, when `90`, you'll get a square.
+default black
 
-_Type: `int`_  
-_Default: `120`_
+#### `device`
 
-## `radius`
+`string | null`
 
-Radius of the rounded corners for 2 obtuse angle in trapezoid.
+`null` means default device
 
-_Type: `int`_  
-_Default: `20`_
+### Backlight
+
+Monitor brightness
+
+#### `type*`
+
+`backlight`
+
+#### `device`
+
+`string | null`
+
+`null` means the first one we can find
+
+### Custom
+
+#### `type*`
+
+`custom`
+
+## `interval_update`
+
+Array of tuples. each tuple contains `millisecond` and `shell command`:  
+`[<millisecond>, <shell_command>]`  
+Example: `[1000, \"echo 0.2333\"]`
+
+For `shell command`, the returned value must be a number within `[0, 1]`.
+
+_Type: `[[int, string]...]`_  
+_Default: `[]`_
+
+## `on_change`
+
+Command to execute when progress changed.
+
+Template support.
+
+Example: `notify-send {progress}`
+
+_Type: `null | string`_  
+_Default: `null`_
+
+## `event_map`
+
+`mouse_key_ID : shell_command`
+
+Default mouse keys:
+
+- `1` - Left button
+- `2` - Middle button
+- `3` - Right button
+
+_Type: `object`_  
+_Default: `{}`_