diff options
Diffstat (limited to 'experiments/logout-widget/README.md')
| -rw-r--r-- | experiments/logout-widget/README.md | 43 |
1 files changed, 25 insertions, 18 deletions
diff --git a/experiments/logout-widget/README.md b/experiments/logout-widget/README.md index c1cdf08..232751d 100644 --- a/experiments/logout-widget/README.md +++ b/experiments/logout-widget/README.md @@ -1,12 +1,12 @@ # Logout widget -Widget which allows to perform lock, reboot, log out, power off and sleep actions. If can be called either by a shortcut, or by clicking on a widget in wibar. +Widget which allows to perform lock, reboot, log out, power off and sleep actions. It can be called either by a shortcut, or by clicking on a widget in wibar.  # Installation -Clone this (if not cloned yet) and the Awesome-buttons repos under **./.config/awesome/** +Clone this (if not cloned yet) and the [awesome-buttons](https://github.com/streetturtle/awesome-buttons) repos under **./.config/awesome/** ```bash cd ./.config/awesome/ @@ -15,18 +15,17 @@ git clone https://github.com/streetturtle/awesome-buttons ``` Then -- to show by shortcut: +- to show by a shortcut - define a shortcut in `globalkeys`: ```lua local logout = require("awesome-wm-widgets.experiments.logout-widget.logout") ... globalkeys = gears.table.join( ... - -- define a shorcut in globalkey awful.key({ modkey }, "l", function() logout.launch() end, {description = "Show logout screen", group = "custom"}), ``` -- to show by clicking on a widget in wibar: +- to show by clicking on a widget in wibar - add widget to the wibar: ```lua local logout = require("awesome-wm-widgets.experiments.logout-widget.logout") @@ -35,28 +34,36 @@ Then { -- Right widgets layout = wibox.layout.fixed.horizontal, ... - logout.widget{ - bg_color = "#000000", - accent_color = "#888888", - text_color = '#ffffff', - phrases = {'Yippee ki yay!', 'Hasta la vista, baby', 'See you later, alligator!', 'After a while, crocodile.'}, - onlogout = function() naughty.notify{text = "Logged out!"} end - }, + logout.widget{}, ... ``` # Customisation - | Name | Default | Description | |---|---|---| +| `icon` | `power.svg` | If used as widget - the path to the widget's icon | | `bg_color` | `beautiful.bg_normal` | The color the background of the | -| `accent_color` | `beautiful.bg_focus` | The color of the buttons | -| `text_color` | `beautiful.fg_normal` | The color of text | -| `phrases` | `{'Goodbye!'}` | The table with phrase(s) to show, if more than one provided, the phrase is chosen randomly | +| `accent_color` | `beautiful.bg_focus` | The color of the buttons | +| `text_color` | `beautiful.fg_normal` | The color of text | +| `phrases` | `{'Goodbye!'}` | The table with phrase(s) to show, if more than one provided, the phrase is chosen randomly | | `onlogout` | `function() awesome.quit() end` | Function which is called when the logout button is pressed | -| `onlock` | | Function which is called when the lock button is pressed | -| `onreboot` | | Function which is called when the reboot button is pressed | +| `onlock` | function() awful.spawn.with_shell("systemctl suspend") end | Function which is called when the lock button is pressed | +| `onreboot` | `function() awful.spawn.with_shell("reboot") end` | Function which is called when the reboot button is pressed | | `onsuspend` | `function() awful.spawn.with_shell("systemctl suspend") end` | Function which is called when the suspend button is pressed | | `onpoweroff` | `function() awful.spawn.with_shell("shutdown now") end` | Function which is called when the poweroff button is pressed | +Some color themes for inspiration: + + + + + +```lua +logout.launch{ + bg_color = "#261447", accent_color = "#ff4365", text_color = '#f706cf', -- outrun + -- bg_color = "#0b0c10", accent_color = "#1f2833", text_color = '#66fce1', -- dark + -- bg_color = "#3B4252", accent_color = "#88C0D0", text_color = '#D8DEE9', -- nord + phrases = {"exit(0)", "Don't forget to be awesome.", "Yippee ki yay!"}, +} +```
\ No newline at end of file |