Button¶
A simple button widget which can be pressed using a mouse click or by pressing Enter when it has focus.
- Focusable
- Container
Example¶
The example below shows each button variant, and its disabled equivalent. Clicking any of the non-disabled buttons in the example app below will result in the app exiting and the details of the selected button being printed to the console.
from textual.app import App, ComposeResult
from textual.containers import Horizontal, VerticalScroll
from textual.widgets import Button, Static
class ButtonsApp(App[str]):
CSS_PATH = "button.css"
def compose(self) -> ComposeResult:
yield Horizontal(
VerticalScroll(
Static("Standard Buttons", classes="header"),
Button("Default"),
Button("Primary!", variant="primary"),
Button.success("Success!"),
Button.warning("Warning!"),
Button.error("Error!"),
),
VerticalScroll(
Static("Disabled Buttons", classes="header"),
Button("Default", disabled=True),
Button("Primary!", variant="primary", disabled=True),
Button.success("Success!", disabled=True),
Button.warning("Warning!", disabled=True),
Button.error("Error!", disabled=True),
),
)
def on_button_pressed(self, event: Button.Pressed) -> None:
self.exit(str(event.button))
if __name__ == "__main__":
app = ButtonsApp()
print(app.run())
Reactive Attributes¶
Name | Type | Default | Description |
---|---|---|---|
label |
str |
"" |
The text that appears inside the button. |
variant |
str |
"default" |
Semantic styling variant. One of default , primary , success , warning , error . |
disabled |
bool |
False |
Whether the button is disabled or not. Disabled buttons cannot be focused or clicked, and are styled in a way that suggests this. |
Messages¶
Pressed
¶
Additional Notes¶
- The spacing between the text and the edges of a button are due to border, not padding. To create a button with zero visible padding, use the
border: none;
declaration.
See Also¶
- Button code reference