Table Of Contents
Button¶

The Button is a Label with associated actions that are triggered when the button is pressed (or released after a click/touch). To configure the button, you can use the same properties that you can use for the Label class:
button = Button(text='Hello world', font_size=14)
To attach a callback when the button is pressed (clicked/touched), use bind:
def callback(instance):
print('The button <%s> is being pressed' % instance.text)
btn1 = Button(text='Hello world 1')
btn1.bind(on_press=callback)
btn2 = Button(text='Hello world 2')
btn2.bind(on_press=callback)
If you want to be notified every time the button state changes, you can bind to the Button.state property:
def callback(instance, value):
print('My button <%s> state is <%s>' % (instance, value))
btn1 = Button(text='Hello world 1')
btn1.bind(state=callback)
Bases: kivy.uix.behaviors.ButtonBehavior, kivy.uix.label.Label
Button class, see module documentation for more information.
Changed in version 1.8.0: The behavior / logic of the button has been moved to ButtonBehaviors.
Background color, in the format (r, g, b, a).
New in version 1.0.8.
The background_color is a ListProperty and defaults to [1, 1, 1, 1].
Background image of the button used for the default graphical representation when the button is pressed.
New in version 1.8.0.
background_down is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/button_disabled_pressed’.
Background image of the button used for the default graphical representation when the button is not pressed.
New in version 1.8.0.
background_normal is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/button_disabled’.
Background image of the button used for the default graphical representation when the button is pressed.
New in version 1.0.4.
background_down is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/button_pressed’.
Background image of the button used for the default graphical representation when the button is not pressed.
New in version 1.0.4.
background_normal is a StringProperty and defaults to ‘atlas://data/images/defaulttheme/button’.
Border used for BorderImage graphics instruction. Used with background_normal and background_down. Can be used for custom backgrounds.
It must be a list of four values: (top, right, bottom, left). Read the BorderImage instruction for more information about how to use it.
border is a ListProperty and defaults to (16, 16, 16, 16)