textual/docs/widgets/button.md

Button

Description

A simple button widget which can be pressed using a mouse click or by pressing ++return++ when it has focus.

• Focusable
• Container

Example

Clicking any of the buttons in the example app below will result in a ring of the terminal bell.

=== "Output"

```{.textual path="docs/examples/widgets/button.py"}
```

=== "button.py"

```python
--8<-- "docs/examples/widgets/button.py"
```

=== "button.css"

```css
--8<-- "docs/examples/widgets/button.css"
```

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 clicked, and are styled in a way that suggests this.

Events

Pressed

The Button.Pressed event is sent when the button is pressed.

• Bubbles

Attributes

No other attributes

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