feat: new clipboard manager module

JakeStanger · Feb 26, 2023 · 575d6cc · 575d6cc
1 parent 5bbe64b
commit 575d6cc
Show file tree

Hide file tree

Showing 26 changed files with 1,809 additions and 149 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -9,6 +9,7 @@ description = "Customisable GTK Layer Shell wlroots/sway bar"
 default = [
     "http",
     "config+all",
+    "clipboard",
     "clock",
     "music+all",
     "sys_info",
@@ -24,6 +25,8 @@ http = ["dep:reqwest"]
 "config+toml" = ["toml"]
 "config+corn" = ["libcorn"]
 
+clipboard = ["nix"]
+
 clock = ["chrono"]
 
 music = ["regex"]
@@ -60,6 +63,7 @@ notify = { version = "5.0.0", default-features = false }
 wayland-client = "0.29.5"
 wayland-protocols = { version = "0.29.5", features = ["unstable_protocols", "client"] }
 smithay-client-toolkit = { version = "0.16.0", default-features = false, features = ["calloop"] }
+
 lazy_static = "1.4.0"
 async_once = "0.2.6"
 cfg-if = "1.0.0"
@@ -73,6 +77,9 @@ serde_yaml = { version = "0.9.4", optional = true }
 toml = { version = "0.7.0", optional = true }
 libcorn = { version = "0.6.1", optional = true }
 
+# clipboard
+nix = { version = "0.26.2", optional = true }
+
 # clock
 chrono = { version = "0.4.19", optional = true }
 
@@ -92,4 +99,4 @@ hyprland = { version = "0.3.0", optional = true }
 futures-util = { version = "0.3.21", optional = true }
 
 # shared
-regex = { version = "1.6.0", default-features = false, features = ["std"], optional = true } # music, sys_info
+regex = { version = "1.6.0", default-features = false, features = ["std"], optional = true } # music, sys_info
diff --git a/docs/Compiling.md b/docs/Compiling.md
@@ -61,6 +61,7 @@ cargo build --release --no-default-features \
 | config+toml         | Enables configuration support for TOML.                                           |
 | config+corn         | Enables configuration support for [Corn](https://github.com/jakestanger.corn).    |
 | **Modules**         |                                                                                   |
+| clipboard           | Enables the `clipboard` module.                                                   |
 | clock               | Enables the `clock` module.                                                       |
 | music+all           | Enables the `music` module with support for all player types.                     |
 | music+mpris         | Enables the `music` module with MPRIS support.                                    |

diff --git a/docs/modules/Clipboard.md b/docs/modules/Clipboard.md
@@ -0,0 +1,93 @@
+Shows recent clipboard items, allowing you to switch between them to re-copy previous values.
+Clicking the icon button opens the popup containing all functionality.
+
+Supports plain text and images.
+
+![Screenshot of clipboard popup open, with two textual values and an image copied. Several other unrelated widgets are visible on the bar.](https://f.jstanger.dev/github/ironbar/clipboard.png?raw)
+
+## Configuration
+
+> Type: `clipboard`
+
+| Name                  | Type                                  | Default | Description                                                                                                                                           |
+|-----------------------|---------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `icon`                | `string/image`                        | `󰨸`    | Icon to show on the widget button.                                                                                                                    |
+| `max_items`           | `integer`                             | `10`    | Maximum number of items to show on the bar.                                                                                                           |
+| `truncate`            | `start` or `middle` or `end` or `Map` | `null`  | The location of the ellipses and where to truncate text from. Leave null to avoid truncating. Use the long-hand `Map` version if specifying a length. |
+| `truncate.mode`       | `start` or `middle` or `end`          | `null`  | The location of the ellipses and where to truncate text from. Leave null to avoid truncating.                                                         |
+| `truncate.length`     | `integer`                             | `null`  | The fixed width (in chars) of the widget. Leave blank to let GTK automatically handle.                                                                |
+| `truncate.max_length` | `integer`                             | `null`  | The maximum number of characters before truncating. Leave blank to let GTK automatically handle.                                                      |
+
+See [here](images) for information on images.
+
+<details>
+<summary>JSON</summary>
+
+```json
+{
+  "end": {
+    "type": "clipboard",
+    "max_items": 3,
+    "truncate": {
+      "mode": "end",
+      "length": 50
+    }
+  }
+}
+```
+</details>
+
+<details>
+<summary>TOML</summary>
+
+```toml
+[[end]]
+type = "clipboard"
+max_items = 3
+
+[[end.truncate]]
+mode = "end"
+length = 50
+```
+</details>
+
+<details>
+<summary>YAML</summary>
+
+```yaml
+end:
+  - type: 'clipboard'
+    max_items: 3
+    truncate:
+      mode: 'end'
+      length: 50
+```
+</details>
+
+<details>
+<summary>Corn</summary>
+
+```corn
+{
+    end = [ { 
+        type = "clipboard" 
+        max_items = 3 
+        truncate.mode = "end" 
+        truncate.length = 50 
+    } ] 
+}
+```
+</details>
+
+## Styling
+
+| Selector                             | Description                                          |
+|--------------------------------------|------------------------------------------------------|
+| `#clipboard`                         | Clipboard widget.                                    |
+| `#clipboard .btn`                    | Clipboard widget button.                             |
+| `#popup-clipboard`                   | Clipboard popup box.                                 |
+| `#popup-clipboard .item`             | Clipboard row item inside the popup.                 |
+| `#popup-clipboard .item .btn`        | Clipboard row item radio button.                     |
+| `#popup-clipboard .item .btn.text`   | Clipboard row item radio button (text values only).  |
+| `#popup-clipboard .item .btn.image`  | Clipboard row item radio button (image values only). |
+| `#popup-clipboard .item .btn-remove` | Clipboard row item remove button.                    |
diff --git a/examples/config.corn b/examples/config.corn
@@ -20,8 +20,18 @@ let {
         show_icons = true
     }
 
-    $mpd_local = { type = "mpd" music_dir = "/home/jake/Music" }
-    $mpd_server = { type = "mpd" host = "chloe:6600" }
+    $mpris = {
+        type = "music"
+        player_type = "mpris"
+
+        on_click_middle = "playerctl play-pause"
+        on_scroll_up = "playerctl volume +5"
+        on_scroll_down = "playerctl volume -5"
+
+    }
+
+    $mpd_local = { type = "music" player_type = "mpd" music_dir = "/home/jake/Music" truncate.mode = "end" truncate.max_length = 100 }
+    $mpd_server = { type = "music" player_type = "mpd" host = "chloe:6600" truncate = "end" }
 
     $sys_info = {
         type = "sys_info"
@@ -55,6 +65,8 @@ let {
         show_if.interval = 500
     }
 
+    $clipboard = { type = "clipboard" max_items = 3 truncate.mode = "end" truncate.length = 50 }
+
     // -- begin custom --
     $button = { type = "button" name="power-btn" label = "" on_click = "popup:toggle" }
 
@@ -86,10 +98,13 @@ let {
     // -- end custom --
 
     $left = [ $workspaces $launcher ]
-    $right = [ $mpd_local $mpd_server $phone_battery $sys_info $power_menu $clock ]
+    $right = [ $mpd_local $mpd_server $phone_battery $sys_info $clipboard $power_menu $clock ]
 }
 in {
     anchor_to_edges = true
-    position = "top"
-    start = $left end = $right
+    position = "bottom"
+    icon_theme = "Paper"
+
+    start = $left
+    end = $right
 }
diff --git a/examples/config.json b/examples/config.json
@@ -5,7 +5,7 @@
       "music_dir": "/home/jake/Music",
       "player_type": "mpd",
       "truncate": {
-        "length": 100,
+        "max_length": 100,
         "mode": "end"
       },
       "type": "music"
@@ -43,6 +43,14 @@
       },
       "type": "sys_info"
     },
+    {
+      "max_items": 3,
+      "truncate": {
+        "length": 50,
+        "mode": "end"
+      },
+      "type": "clipboard"
+    },
     {
       "bar": [
         {
@@ -98,16 +106,6 @@
   "icon_theme": "Paper",
   "position": "bottom",
   "start": [
-    {
-      "bar": [
-        {
-          "size": 32,
-          "src": "file:///path/to/image.jpg",
-          "type": "image"
-        }
-      ],
-      "type": "custom"
-    },
     {
       "all_monitors": false,
       "name_map": {

diff --git a/examples/config.toml b/examples/config.toml
@@ -8,7 +8,7 @@ player_type = 'mpd'
 type = 'music'
 
 [end.truncate]
-length = 100
+max_length = 100
 mode = 'end'
 
 [[end]]
@@ -44,6 +44,14 @@ memory = 30
 networks = 3
 temps = 5
 
+[[end]]
+max_items = 3
+type = 'clipboard'
+
+[end.truncate]
+length = 50
+mode = 'end'
+
 [[end]]
 class = 'power-menu'
 tooltip = '''Up: {{30000:uptime -p | cut -d ' ' -f2-}}'''
@@ -87,14 +95,6 @@ type = 'label'
 [[end]]
 type = 'clock'
 
-[[start]]
-type = 'custom'
-
-[[start.bar]]
-size = 32
-src = 'file:///path/to/image.jpg'
-type = 'image'
-
 [[start]]
 all_monitors = false
 type = 'workspaces'