awesome-workspace-grid/README.md

35 lines
1.1 KiB
Markdown

# awesome-workspace-grid
Installation: just clone this repository into your `awesome` configuration
directory:
```
cd ~/.config/awesome
git clone https://github.com/lmanul/awesome-workspace-grid.git
```
Sample usage in `rc.lua`:
```
local workspace_grid = require("awesome-workspace-grid")
grid = workspace_grid({
rows = 2, -- supported: 1 to 9
columns = 3, -- supported: 1 to 9
visual = true, -- whether to show workspace changes
})
-- Insert after 'globalkeys' is defined but before it is passed to 'root':
tag_nav_mod_keys = { "Control" }
globalkeys = gears.table.join(globalkeys,
awful.key(tag_nav_mod_keys, "Up",
function () grid:navigate("up") end, {description = "Up", group="Tag"}),
awful.key(tag_nav_mod_keys, "Down",
function () grid:navigate("down") end, {description = "Down", group="Tag"}),
awful.key(tag_nav_mod_keys, "Left",
function () grid:navigate("left") end, {description = "Left", group="Tag"}),
awful.key(tag_nav_mod_keys, "Right",
function () grid:navigate("right") end, {description = "Right", group="Tag"}),
)
```