]> git.madduck.net Git - etc/awesome.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Created borderbox (markdown)
authorLuke Bonham <dadasignificanulla@gmail.com>
Sat, 7 Sep 2013 10:33:28 +0000 (03:33 -0700)
committercopycat-killer <dada@archlinux.info>
Wed, 5 Aug 2015 11:30:32 +0000 (13:30 +0200)
borderbox.md [new file with mode: 0644]

diff --git a/borderbox.md b/borderbox.md
new file mode 100644 (file)
index 0000000..cdeece2
--- /dev/null
@@ -0,0 +1,47 @@
+Creates a thin wibox at a position relative to another wibox.
+
+This allows to create "borders" for your wiboxes.
+
+       lain.widget.borderbox(relbox, s, args)
+
+`relbox` and `s` (an integer being screen number) are required arguments, `args` is an optional table
+which can contain:
+
+Variable | Meaning | Type | Default
+--- | --- | --- | ---
+`position` | Position of the additional box | string | "above"
+`color` | Color of the additional box | string | `#FFFFFF`
+`size` | Size in pixels of the additional box | int | 1
+
+Possible values for `.position`: `above`, `below`, `left` and `right`.
+
+### Example usage
+
+Think of this as a wibox:
+
+       [======================]
+
+If `args.position = "above"`, then you'll get an additional wibox below
+the existing one:
+
+       ________________________
+       [======================]
+
+It'll match position and size of the existing wibox.
+
+If your main wiboxes are stored in a table called `mywibox` (one wibox
+for each screen) and are located at the bottom of your screen, then this
+adds a borderbox on top of them:
+
+    -- Layout section
+       for s = 1, screen.count() do
+        ...
+
+           -- Most likely, you'll want to do this as well:
+           awful.screen.padding(screen[s], { bottom = 1 })
+
+           -- Create the box and place it above the existing box.
+           lain.widgets.borderbox(mywibox[s], s, { position = "above" } )
+
+        ...
+       end
\ No newline at end of file