docs(w.w.slider): Add value signal to initial example

Since the primary use case of the slider widget is to do something
with the value when it changes, the initial example should show
how to do that.
This commit is contained in:
Lucas Schwiderski 2021-12-21 11:55:36 +01:00
parent e55d1d41f3
commit 5ac0829f5d
No known key found for this signature in database
GPG Key ID: AA12679AAA6DF4D8
1 changed files with 23 additions and 10 deletions

View File

@ -1,12 +1,12 @@
--DOC_GEN_IMAGE --DOC_HIDE --DOC_GEN_IMAGE --DOC_HIDE_START
local parent = ... --DOC_HIDE local parent = ...
local wibox = require( "wibox" ) --DOC_HIDE local wibox = require( "wibox" )
local beautiful = require( "beautiful" ) --DOC_HIDE local beautiful = require( "beautiful" )
local gears = {shape=require("gears.shape") } --DOC_HIDE local gears = {shape=require("gears.shape") }
local naughty = { notify = function(_) end }
parent:add( --DOC_HIDE --DOC_HIDE_END
local widget = wibox.widget {
wibox.widget {
bar_shape = gears.shape.rounded_rect, bar_shape = gears.shape.rounded_rect,
bar_height = 3, bar_height = 3,
bar_color = beautiful.border_color, bar_color = beautiful.border_color,
@ -19,6 +19,19 @@ wibox.widget {
forced_height = 50, --DOC_HIDE forced_height = 50, --DOC_HIDE
forced_width = 100, --DOC_HIDE forced_width = 100, --DOC_HIDE
} }
--DOC_NEWLINE
-- Connect to `property::value` to use the value on change
widget:connect_signal("property::value", function(_, new_value)
--DOC_HIDE_START
if new_value ~= 10 then
error(string.format("unexpected value %s", new_value))
end
--DOC_HIDE_END
naughty.notify { title = "Slider changed", message = new_value }
end)
) --DOC_HIDE --DOC_HIDE_START
--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80 widget.value = 10
parent:add(widget)
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80