From 7f17e7bb8b133e8a83696669bc4ab9717fa6d047 Mon Sep 17 00:00:00 2001 From: gokul <33443763+JavaCafe01@users.noreply.github.com> Date: Thu, 30 Sep 2021 12:21:21 -0700 Subject: [PATCH] Update Docs (#118) Clarified a few things in the window switcher documentation and added a keybind example. --- docs/widgets/window_switcher.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/widgets/window_switcher.md b/docs/widgets/window_switcher.md index c14a355..28ed0a4 100644 --- a/docs/widgets/window_switcher.md +++ b/docs/widgets/window_switcher.md @@ -1,6 +1,6 @@ ## 🎨 Window Switcher -A popup that allows you to switch clients similar to what is known from MacOS or GNOME. +A popup with client previews that allows you to switch clients similar to the alt-tab menu in MacOS, GNOME, and Windows. ![](https://user-images.githubusercontent.com/70270606/133311802-8aef1012-346f-4f4c-843d-10d9de54ffeb.png) @@ -27,10 +27,15 @@ bling.widget.window_switcher.enable { } ``` -To run the window swicher you have to run: +To run the window swicher you have to emit this signal from within your configuration (usually using a keybind). ```lua awesome.emit_signal("bling::window_switcher::turn_on") ``` -from within your configuration (usually using a keybind). +For example: +```lua + awful.key({altkey}, "Tab", function() + awesome.emit_signal("bling::window_switcher::turn_on") + end, {description = "Window Switcher", group = "client"}) +```