πŸ’» Way-Edges

  • 🀷 What is this
    • πŸ“₯ Installation
      • ⌨️ Command line usage
        • βš™οΈ Configuration
          • 🧱 Widgets
            • Button
              • Slider
                • WrapBox
                  • Ring
                    • Text
                      • Tray
                      • Workspace
                      • Slider

                        Example:

                        {
                          "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"
                            }
                          }
                        }
                        
                        {
                          "edge": "top",
                          "position": "left",
                          "monitor": "HDMI-A-1",
                          "layer": "overlay",
                          "preview_size": "100%",
                          "widget": {
                            "thickness": 50,
                            "length": "25%",
                            "type": "slide",
                            "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"
                              }
                            }
                          }
                        }
                        

                        type*

                        const `slider`
                        

                        thickness*

                        *Thickness* of the widget, from screen edge to the screen center.

                        Support relative value, but don't recommend using relative value for this property.

                        Type: int | string

                        length*

                        Length of the widget.

                        Support relative value.

                        Type: int | string

                        border_width

                        Type: int

                        redraw_only_on_internal_update

                        Saves resources, recommend to turn on for speaker and microphone.

                        Type: bool

                        bg_color

                        Color of the background of widget.

                        Support: #rgb/#rrggbb/#rrrgggbbb/rgb(r, g, b)/rgba(r, g, b, a)...
                        For full info, check RGBA

                        Type: string
                        Default: #808080

                        fg_color

                        Color of the foreground of widget.

                        Support: #rgb/#rrggbb/#rrrgggbbb/rgb(r, g, b)/rgba(r, g, b, a)...
                        For full info, check RGBA

                        Type: string
                        Default: #FFB847

                        border_color

                        Color of the border of widget.

                        Support: #rgb/#rrggbb/#rrrgggbbb/rgb(r, g, b)/rgba(r, g, b, a)...
                        For full info, check RGBA

                        Type: string
                        Default: #646464

                        text_color

                        Color of the text of widget.

                        For full info, check RGBA

                        Support: #rgb/#rrggbb/#rrrgggbbb/rgb(r, g, b)/rgba(r, g, b, a)...
                        For full info, check RGBA

                        Type: string
                        Default: #000000

                        obtuse_angle

                        The 2 obtuse angle in trapezoid, set it within [90, 180), when 90, you'll get a square.

                        Type: int
                        Default: 120

                        radius

                        Radius of the rounded corners for 2 obtuse angle in trapezoid.

                        Type: int
                        Default: 20

                        preset

                        Speaker | Microphone

                        PulseAudio Sink and Source.

                        type*

                        speaker | microphone

                        mute_color

                        string

                        default black

                        animation_curve

                        string

                        enum: ["ease-expo", "ease-cubic", "ease-quat", "linear"]

                        default "ease-cubic"

                        device

                        string | null

                        null means default device

                        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: {}

                        "'Star⭐' true as the ten" β€”β€”β€”β€” Someone from tenakth