feat: backlight slider

man/waybar-backlight-slider.5.scd

@@ -0,0 +1,88 @@
+waybar-backlight-slider(5)
+
+# NAME
+
+waybar - backlight slider module
+
+# DESCRIPTION
+
+The *backlight slider* module displays and controls the current brightness of the default or preferred device.
+
+The brightness can be controlled by dragging the slider accross the bar, or clicking on a specific position.
+
+# CONFIGURATION
+
+*min*: ++
+    typeof: int ++
+    default: 0 ++
+    The minimum volume value the slider should display and set.
+
+*max*: ++
+    typeof: int ++
+    default: 100 ++
+    The maximum volume value the slider should display and set.
+
+*orientation*: ++
+    typeof: string ++
+    default: horizontal ++
+    The orientation of the slider. Can be either `horizontal` or `vertical`.
+
+*device*: ++
+    typeof: string ++
+    The name of the preferred device to control. If left empty, a device will be chosen automatically.
+
+# EXAMPLES
+
+```
+"modules-right": [
+    "backlight-slider",
+],
+"backlight/slider": {
+    "min": 0,
+    "max": 100,
+    "orientation": "horizontal",
+    "device": "intel_backlight"
+}
+```
+
+# STYLE
+
+The slider is a component with multiple CSS Nodes, of which the following are exposed:
+
+*#backlight-slider*: ++
+    Controls the style of the box *around* the slider and bar.
+
+*#backlight-slider slider*: ++
+    Controls the style of the slider handle.
+
+*#backlight-slider trough*: ++
+    Controls the style of the part of the bar that has not been filled.
+
+*#backlight-slider highlight*: ++
+    Controls the style of the part of the bar that has been filled.
+
+## STYLE EXAMPLE
+
+```
+#backlight-slider slider {
+    min-height: 0px;
+    min-width: 0px;
+    opacity: 0;
+    background-image: none;
+    border: none;
+    box-shadow: none;
+}
+
+#backlight-slider trough {
+    min-height: 80px;
+    min-width: 10px;
+    border-radius: 5px;
+    background-color: black;
+}
+
+#backlight-slider highlight {
+    min-width: 10px;
+    border-radius: 5px;
+    background-color: red;
+}
+```