ring

Author: ogios

data/doc/4.widgets/5.box/0.ring.md

@@ -8,10 +8,38 @@ Ring provide some basic presets for system info.
 
 ```json
 {
-  "frame_rate": 144,
-  "type": "ring",
-  "preset": "disk",
-  "prefix": "Disk "
+  "index": [-1, -1],
+  "widget": {
+    "font_family": "JetBrainsMono Nerd Font",
+    "fg_color": "#BEAFD9",
+    "bg_color": "#00000044",
+    "type": "ring",
+    "prefix": "󰾶 ",
+    "suffix": " {float:4,100}%",
+    "suffix_hide": true,
+    "preset": {
+      "type": "custom",
+      "update_interval": 100,
+      "cmd": "seq 0 .01 1 | shuf | head -n1"
+    }
+  }
+}
+```
+
+```json
+{
+  "index": [-1, -1],
+  "widget": {
+    "font_family": "JetBrainsMono Nerd Font",
+    "bg_color": "#00000044",
+    "type": "ring",
+    "prefix": " ",
+    "suffix": " {preset} {progress:2,100}%",
+    "suffix_hide": true,
+    "preset": {
+      "type": "ram"
+    }
+  }
 }
 ```
 
@@ -35,14 +63,7 @@ For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gd
 _Type: `string`_  
 _Default: `#FFB847`_
 
-## `frame_rate`
-
-Frame rate per second, won't hurt if over screen refresh rate.
-
-_Type: `int`_  
-_Default: `60`_
-
-## `transition_duration`
+## `text_transition_ms`
 
 Time cost of showing the widget from the edge.  
 Millisecond.
@@ -113,6 +134,11 @@ Font family of all text within ring widget.
 _Type: `null | string`_  
 _Default: `null` for default font_
 
+## `font_size`
+
+_Type: `int`_  
+Default: radius \* 2
+
 ## `preset`
 
 Preset update function of the ring:  
@@ -128,6 +154,10 @@ _Type: `string | object`_
 const `ram`
 ```
 
+#### `update_interval`
+
+`u64`
+
 ### `swap`
 
 #### `type*`
@@ -136,6 +166,10 @@ const `ram`
 const `swap`
 ```
 
+#### `update_interval`
+
+`u64`
+
 ### `cpu`
 
 #### `type*`
@@ -144,6 +178,14 @@ const `swap`
 const `cpu`
 ```
 
+#### `update_interval`
+
+`u64`
+
+#### `core`
+
+which core to should. leave empty to show global usage.
+
 ### `battery`
 
 #### `type*`
@@ -152,6 +194,10 @@ const `cpu`
 const `battery`
 ```
 
+#### `update_interval`
+
+`u64`
+
 ### `disk`
 
 #### `type*`
@@ -167,6 +213,10 @@ Disk partition.
 _Type: `string`_  
 _Default: `/`_
 
+#### `update_interval`
+
+`u64`
+
 ### `custom`
 
 #### `type*`
@@ -175,13 +225,10 @@ _Default: `/`_
 const `custom`
 ```
 
-#### `update_with_interval_ms`
+#### `update_interval`
 
-Update progress with command given milliseconds.  
-Progress must be between 0 and 1.  
-You can disable template by not providing text.
+`u64`
 
-Example: `[1000, "printf \"0.2333\\n23.33%\""]`
+#### `cmd`
 
-_Type: `[[int, string]...]`_  
-_Default: `[]`_
+`string`