awesomewm-mirrors
/
awesome-wm-widgets
mirror of https://github.com/streetturtle/awesome-wm-widgets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add table with config to the readme

This commit is contained in:
streetturtle 2019-04-14 20:07:15 -04:00
parent 8e92a8541b
commit d0cbdc1647
4 changed files with 47 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
volumearc-widget/README.md
View File

@ -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
}),

5
volumearc-widget/volumearc.lua
View File

@ -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,

23
volumebar-widget/README.md
View File

@ -9,17 +9,30 @@ Supports
- scroll down - decrease volume,
- left click - mute/unmute.
## Customization
## Customization
It is possible to customize widget by providing a table with all or some of the following config parameters:
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 bar |
| `mute_color` | `beautiful.fg_urgent` | Color of the bar when mute |
| `width` | 50 | The bar width |
| `shape` | `bar` | [gears.shape](https://awesomewm.org/doc/api/libraries/gears.shape.html), could be `octogon`, `hexagon`, `powerline`, etc |
| `margin` | `10` | Top and bottom margin (if your wibar is 22 px high, bar will be 2 px (22 - 2*10)) |
| `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
volumebar_widget({
main_color = '#af13f7',
mute_color = '#ff0000',
width = 80,
shape = 'rounded_bar', -- octogon, hexagon, powerline, etc
-- bar's height = wibar's height minus 2x margins
shape = 'rounded_bar',
margins = 8
})
```
@ -29,7 +42,7 @@ Above config results in following widget:
![custom](./custom.png)
## Installation
## Installation
1. Clone this repo under **~/.config/awesome/**

19
volumebar-widget/volumebar.lua
View File

@ -26,12 +26,17 @@ 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_normal
local mute_color = args.mute_color or beautiful.fg_urgent
local width = args.width or 50
local shape = args.shape or 'bar'
local margins = args.margins or 10
local get_volume_cmd = args.get_volume_cmd or GET_VOLUME_CMD
local inc_volume_cmd = args.inc_volume_cmd or INC_VOLUME_CMD
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 volumebar_widget = wibox.widget {
max_value = 1,
forced_width = width,
@ -59,19 +64,19 @@ local function worker(args)
volumebar_widget:connect_signal("button::press", function(_, _, _, button)
if (button == 4) then
awful.spawn(INC_VOLUME_CMD)
awful.spawn(inc_volume_cmd)
elseif (button == 5) then
awful.spawn(DEC_VOLUME_CMD)
awful.spawn(dec_volume_cmd)
elseif (button == 1) then
awful.spawn(TOG_VOLUME_CMD)
awful.spawn(tog_volume_cmd)
end
spawn.easy_async(GET_VOLUME_CMD, function(stdout, stderr, exitreason, exitcode)
spawn.easy_async(get_volume_cmd, function(stdout, stderr, exitreason, exitcode)
update_graphic(volumebar_widget, stdout, stderr, exitreason, exitcode)
end)
end)
watch(GET_VOLUME_CMD, 1, update_graphic, volumebar_widget)
watch(get_volume_cmd, 1, update_graphic, volumebar_widget)
return volumebar_widget
end