From f617889ccec586b5a2feabafc6e1f2ca1f1533ac Mon Sep 17 00:00:00 2001 From: Nooo37 Date: Tue, 14 Sep 2021 20:25:07 +0200 Subject: [PATCH] add window switcher docs --- docs/_sidebar.md | 1 + docs/widgets/window_switcher.md | 36 +++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 docs/widgets/window_switcher.md diff --git a/docs/_sidebar.md b/docs/_sidebar.md index c7fc2b1..9216d34 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -17,6 +17,7 @@ - [Tag Preview](widgets/tag_preview.md) - [Task Preview](widgets/task_preview.md) - [Tabbed Misc](widgets/tabbed_misc.md) + - [Window Switcher](widgets/window_switcher.md) - Extra - [Theme Variable Template](theme.md) diff --git a/docs/widgets/window_switcher.md b/docs/widgets/window_switcher.md new file mode 100644 index 0000000..c14a355 --- /dev/null +++ b/docs/widgets/window_switcher.md @@ -0,0 +1,36 @@ +## 🎨 Window Switcher + +A popup that allows you to switch clients similar to what is known from MacOS or GNOME. + +![](https://user-images.githubusercontent.com/70270606/133311802-8aef1012-346f-4f4c-843d-10d9de54ffeb.png) + +*image by [No37](https://github.com/Nooo37)* + +### Usage + +To enable: + +```lua +bling.widget.window_switcher.enable { + type = "thumbnail", -- set to anything other than "thumbnail" to disable client previews + + -- keybindings (the examples provided are also the default if kept unset) + hide_window_switcher_key = "Escape", -- The key on which to close the popup + minimize_key = "n", -- The key on which to minimize the selected client + unminimize_key = "N", -- The key on which to unminimize all clients + kill_client_key = "q", -- The key on which to close the selected client + cycle_key = "Tab", -- The key on which to cycle through all clients + previous_key = "Left", -- The key on which to select the previous client + next_key = "Right", -- The key on which to select the next client + vim_previous_key = "h", -- Alternative key on which to select the previous client + vim_next_key = "l", -- Alternative key on which to select the next client +} +``` + +To run the window swicher you have to run: + +```lua +awesome.emit_signal("bling::window_switcher::turn_on") +``` +from within your configuration (usually using a keybind). +