diff --git a/_widgets/batteryarc-widget.md b/_widgets/batteryarc-widget.md index b7ab3c7..d572462 100644 --- a/_widgets/batteryarc-widget.md +++ b/_widgets/batteryarc-widget.md @@ -41,6 +41,7 @@ It is possible to customize widget by providing a table with all or some of the | `warning_msg_position` | `bottom_right` | Position of the warning popup | | `warning_msg_icon` | ~/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg | Icon of the warning popup | | `enable_battery_warning` | `true` | Display low battery warning | +| `show_notification_mode` | `on_hover` | How to trigger a notification with the battery status: `on_hover`, `on_click` or `off` | ## Requirements diff --git a/_widgets/bitbucket-widget.md b/_widgets/bitbucket-widget.md index 7a1126e..f22f4f3 100644 --- a/_widgets/bitbucket-widget.md +++ b/_widgets/bitbucket-widget.md @@ -7,9 +7,9 @@ The widget shows the number of pull requests assigned to the user and when click ## How it works -Widget uses cURL to query Bitbucket's [REST API](https://developer.atlassian.com/bitbucket/api/2/reference/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder. +Widget uses cURL to query Bitbucket's [REST API](https://developer.atlassian.com/bitbucket/api/2/reference/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of the cURL, which is basically allows storing basic auth credentials in a **.netrc** file in home folder. -Bitbucket allows using [App Passwords](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) (available in the account settings) - simply generate one for the widget and use it as password in .netrc file. +Bitbucket allows using [App Passwords](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) (available in the account settings) - simply generate one for the widget and use it as password in **.netrc** file. ## Customization @@ -18,15 +18,19 @@ It is possible to customize widget by providing a table with all or some of the | Name | Default | Description | |---|---|---| | `icon` | `~/.config/awesome/awesome-wm-widgets/bitbucket-widget/bitbucket-icon-gradient-blue.svg` | Path to the icon | -| `host` | Required | Ex: _http://api.bitbucket.org_ | -| `uuid` | Required | UUID | +| `host` | Required | e.g _http://api.bitbucket.org_ | +| `uuid` | Required | e.g _{123e4567-e89b-12d3-a456-426614174000}_ | | `workspace` | Required | Workspace ID| | `repo_slug` | Required | Repository slug | | `timeout` | 60 | How often in seconds the widget refreshes | +Note: + - host most likely should start with _api._ + - to get your UUID you may call `curl -s -n 'https://api.bitbucket.org/2.0/user'` + ## Installation -Create a .netrc file in you home directory with following content: +Create a **.netrc** file in you home directory with following content: ```bash machine api.bitbucket.org @@ -59,7 +63,7 @@ s.mytasklist, -- Middle widget -- default bitbucket_widget({ host = 'https://api.bitbucket.org', - uuid = 'your-uuid', + uuid = '{123e4567-e89b-12d3-a456-426614174000}', workspace = 'workspace', repo_slug = 'slug' diff --git a/_widgets/calendar-widget.md b/_widgets/calendar-widget.md index c796fd1..d560b74 100644 --- a/_widgets/calendar-widget.md +++ b/_widgets/calendar-widget.md @@ -12,10 +12,11 @@ Calendar widget for Awesome WM - slightly improved version of the `wibox.widget. | Name | Screenshot | |---|---| - |nord (default) | ![nord_theme](../awesome-wm-widgets/assets/img/screenshots/calendar-widget/nord.png) | + | nord (default) | ![nord_theme](../awesome-wm-widgets/assets/img/screenshots/calendar-widget/nord.png) | | outrun | ![outrun_theme](../awesome-wm-widgets/assets/img/screenshots/calendar-widget/outrun.png) | | light | ![outrun_theme](../awesome-wm-widgets/assets/img/screenshots/calendar-widget/light.png) | | dark | ![outrun_theme](../awesome-wm-widgets/assets/img/screenshots/calendar-widget/dark.png) | + | naughty (default) | from local theme | - setup widget placement @@ -48,6 +49,7 @@ local cw = calendar_widget() local cw = calendar_widget({ theme = 'outrun', placement = 'bottom_right' + radius = 8 }) mytextclock:connect_signal("button::press", function(_, _, _, button) diff --git a/_widgets/fs-widget.md b/_widgets/fs-widget.md index 00ceb6a..681fd35 100644 --- a/_widgets/fs-widget.md +++ b/_widgets/fs-widget.md @@ -3,11 +3,22 @@ layout: page --- # Filesystem Widget -This widget shows disk usage. When clicked another widget appears with more detailed information. By default it monitors the "/" mount. It can be configured with a -list of mounts to monitor though only the first will show in the wibar. To have -multiple mounts displayed on the wibar simply define multiple `fs_widgets` -with different mounts as arguments. +This widget shows file system disk space usage which is based on the `df` output. When clicked another widget appears with more detailed information. By default it monitors the "/" mount. It can be configured with a list of mounts to monitor though only the first will show in the wibar. To have multiple mounts displayed on the wibar simply define multiple `fs_widgets` with different mounts as arguments. +![](../awesome-wm-widgets/assets/img/screenshots/fs-widget/screenshot.png) + +## Cusomizations + +It is possible to customize widget by providing a table with all or some of the following config parameters: + +| Name | Default | Description | +|---|---|---| +| `mounts` | `{'/'}` | Table with mounts to monitor, check the output from a `df` command for available options (column 'Mounted on') | +| `timeout` | 60 | How often in seconds the widget refreshes | + +## Installation + +Clone/download repo and use the widget in **rc.lua**: ```lua local fs_widget = require("awesome-wm-widgets.fs-widget.fs-widget") @@ -16,12 +27,6 @@ with different mounts as arguments. s.mytasklist, -- Middle widget { -- Right widgets fs_widget(), --default - wibox.widget.textbox(':'), - fs_widget({ mounts = { '/', '/mnt/musicj' } }), -- multiple mounts + fs_widget({ mounts = { '/', '/mnt/music' } }), -- multiple mounts ... - ``` - -## Installation - -Please refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo. diff --git a/_widgets/mpris-widget.md b/_widgets/mpris-widget.md new file mode 100644 index 0000000..e820b07 --- /dev/null +++ b/_widgets/mpris-widget.md @@ -0,0 +1,29 @@ +--- +layout: page +--- +# MPRIS Widget (In progress) + +Music Player Info widget cy @mgabs + +# Prerequisite + +Install `playerctl` (mpris implementation), should be available in repo, e.g for Ubuntu: + +```bash +sudo apt-get install playerctl +``` + +## Installation + +To use this widget clone repo under **~/.config/awesome/** and then add it in **rc.lua**: + +```lua +local mpris_widget = require("awesome-wm-widgets.mpris-widget") +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + mpris_widget, + ... +``` diff --git a/_widgets/word-clock-widget.md b/_widgets/word-clock-widget.md new file mode 100644 index 0000000..8d35185 --- /dev/null +++ b/_widgets/word-clock-widget.md @@ -0,0 +1,77 @@ +--- +layout: page +--- +# word clock widget + +Widget displaying current time using words: + +![screenshot](../awesome-wm-widgets/assets/img/screenshots/word-clock-widget/halfpastthree.png) + +## Customization + +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 word on odd position | +| accent_color | `beautiful.fg_urgent` | Color of the word on even position | +| font | `beautiful.font` | Font (`Play 20`) | +| is_human_readable | `false` | _nine fifteen_ or _fifteen past nine_ | +| military_time | `false` | 12 or 24 time format | +| with_spaces | `false` | Separate words with spaces | + +## Installation + +Clone repo, include widget and use it in **rc.lua**: + +```lua +local word_clock = require("awesome-wm-widgets.word-clock-widget.word-clock") +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + word_clock(), + ... +``` + +# Screenshots + +```lua + word_clock{ + font = 'Carter One 12', + accent_color = '#ff79c6', + main_color = '#8be9fd', + is_human_readable = true, +} +``` +![](../awesome-wm-widgets/assets/img/screenshots/word-clock-widget/halfpastthree_color.png) + + +```lua +word_clock{ + font = 'Carter One 12', + is_human_readable = true, +} +``` +![](../awesome-wm-widgets/assets/img/screenshots/word-clock-widget/twentythreepastnine.png) + + +```lua +word_clock{ + font = 'Carter One 12', + is_human_readable = true, + military_time = true +} +``` +![](../awesome-wm-widgets/assets/img/screenshots/word-clock-widget/twentythreepasttwentyone.png) + + +```lua +word_clock{ + font = 'Carter One 12', + accent_color = '#f00', + main_color = '#0f0', +} +``` +![](../awesome-wm-widgets/assets/img/screenshots/word-clock-widget/onetwentyseven.png) diff --git a/assets/img/screenshots/fs-widget/screenshot.png b/assets/img/screenshots/fs-widget/screenshot.png new file mode 100644 index 0000000..41e6ccc Binary files /dev/null and b/assets/img/screenshots/fs-widget/screenshot.png differ diff --git a/assets/img/screenshots/word-clock-widget/halfpastthree.png b/assets/img/screenshots/word-clock-widget/halfpastthree.png new file mode 100644 index 0000000..af9e0d9 Binary files /dev/null and b/assets/img/screenshots/word-clock-widget/halfpastthree.png differ diff --git a/assets/img/screenshots/word-clock-widget/halfpastthree_color.png b/assets/img/screenshots/word-clock-widget/halfpastthree_color.png new file mode 100644 index 0000000..3c2cdd7 Binary files /dev/null and b/assets/img/screenshots/word-clock-widget/halfpastthree_color.png differ diff --git a/assets/img/screenshots/word-clock-widget/onetwentyseven.png b/assets/img/screenshots/word-clock-widget/onetwentyseven.png new file mode 100644 index 0000000..08e852c Binary files /dev/null and b/assets/img/screenshots/word-clock-widget/onetwentyseven.png differ diff --git a/assets/img/screenshots/word-clock-widget/testpasttwentyone.png b/assets/img/screenshots/word-clock-widget/testpasttwentyone.png new file mode 100644 index 0000000..41d266f Binary files /dev/null and b/assets/img/screenshots/word-clock-widget/testpasttwentyone.png differ diff --git a/assets/img/screenshots/word-clock-widget/twentythreepastnine.png b/assets/img/screenshots/word-clock-widget/twentythreepastnine.png new file mode 100644 index 0000000..7d18e22 Binary files /dev/null and b/assets/img/screenshots/word-clock-widget/twentythreepastnine.png differ diff --git a/assets/img/screenshots/word-clock-widget/twentythreepasttwentyone.png b/assets/img/screenshots/word-clock-widget/twentythreepasttwentyone.png new file mode 100644 index 0000000..8a8218f Binary files /dev/null and b/assets/img/screenshots/word-clock-widget/twentythreepasttwentyone.png differ