From d0cbdc1647f793ea9b2922970022794e92202d4a Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Sun, 14 Apr 2019 20:07:15 -0400
Subject: Add table with config to the readme
---
volumearc-widget/README.md | 16 ++++++++++++++--
volumearc-widget/volumearc.lua | 5 ++---
2 files changed, 16 insertions(+), 5 deletions(-)
(limited to 'volumearc-widget')
diff --git a/volumearc-widget/README.md b/volumearc-widget/README.md
index f791d3a..aac7e90 100644
--- a/volumearc-widget/README.md
+++ b/volumearc-widget/README.md
@@ -13,11 +13,24 @@ Supports
It is possible to customize widget by providing a table with all or some of the following config parameters:
+| Name | Default | Description |
+|---|---|---|
+| `main_color` | `beautiful.fg_normal` | Color of the arc |
+| `mute_color` | `beautiful.fg_urgent` | Color of the arc when mute |
+| `path_to_icon` | /usr/share/icons/Arc/status/symbolic/audio-volume-muted-symbolic.svg | Path to the icon |
+| `thickness` | 2 | The arc thickness |
+| `height` | `beautiful.fg_normal` | Widget height |
+| `get_volume_cmd` | `amixer -D pulse sget Master` | Get current volume level |
+| `inc_volume_cmd` | `amixer -D pulse sset Master 5%+` | Increase volume level |
+| `dec_volume_cmd` | `amixer -D pulse sset Master 5%-` | Descrease volume level |
+| `tog_volume_cmd` | `amixer -D pulse sset Master toggle` | Mute / unmute |
+
+### Example:
+
```lua
volumearc_widget({
main_color = '#af13f7',
mute_color = '#ff0000',
- path_to_icon = '/usr/share/icons/Papirus-Dark/symbolic/status/audio-volume-high-symbolic.svg',
thickness = 5,
height = 25
})
@@ -54,7 +67,6 @@ Above config results in following widget:
volumearc_widget({
main_color = '#af13f7',
mute_color = '#ff0000',
- path_to_icon = '/usr/share/icons/Papirus-Dark/symbolic/status/audio-volume-high-symbolic.svg',
thickness = 5,
height = 25
}),
diff --git a/volumearc-widget/volumearc.lua b/volumearc-widget/volumearc.lua
index 5fbf3dd..62b18ab 100644
--- a/volumearc-widget/volumearc.lua
+++ b/volumearc-widget/volumearc.lua
@@ -27,8 +27,8 @@ local function worker(args)
local args = args or {}
- local main_color = args.main_color or beautiful.widget_main_color
- local mute_color = args.mute_color or beautiful.widget_red
+ local main_color = args.main_color or beautiful.fg_color
+ local mute_color = args.mute_color or beautiful.fg_urgent
local path_to_icon = args.path_to_icon or PATH_TO_ICON
local thickness = args.thickness or 2
local height = args.height or 18
@@ -38,7 +38,6 @@ local function worker(args)
local dec_volume_cmd = args.dec_volume_cmd or DEC_VOLUME_CMD
local tog_volume_cmd = args.tog_volume_cmd or TOG_VOLUME_CMD
-
local icon = {
id = "icon",
image = path_to_icon,
--
cgit v1.2.3