wibox.container.scroll: Also mention some caveats

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2017-02-25 17:05:33 +01:00
parent 3b40954223
commit d8a272d2dd
1 changed files with 4 additions and 0 deletions

View File

@ -2,6 +2,10 @@
-- This container scrolls its inner widget inside of the available space. An -- This container scrolls its inner widget inside of the available space. An
-- example usage would be a text widget that displays information about the -- example usage would be a text widget that displays information about the
-- currently playing song without using too much space for long song titles. -- currently playing song without using too much space for long song titles.
--
-- Please note that mouse events do not propagate to widgets inside of the
-- scroll container. Also, if this widget is causing too high CPU usage, you can
-- use @{set_fps} to make it update less often.
-- @usage -- @usage
-- wibox.widget { -- wibox.widget {
-- layout = wibox.container.scroll.horizontal, -- layout = wibox.container.scroll.horizontal,