mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
3c1a311a67
I'm not 100% sure how to get this into the docs as I'd like, and it seems we've moved the API docs around a lot in respect to widgets, recently (I'm aware of this but aren't sure what the new layout is yet). This at least starts to get things into the right place.
59 lines
2.0 KiB
Markdown
59 lines
2.0 KiB
Markdown
# Button
|
|
|
|
|
|
A simple button widget which can be pressed using a mouse click or by pressing ++return++
|
|
when it has focus.
|
|
|
|
- [x] 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.
|
|
|
|
=== "Output"
|
|
|
|
```{.textual path="docs/examples/widgets/button.py"}
|
|
```
|
|
|
|
=== "button.py"
|
|
|
|
```python
|
|
--8<-- "docs/examples/widgets/button.py"
|
|
```
|
|
|
|
=== "button.css"
|
|
|
|
```sass
|
|
--8<-- "docs/examples/widgets/button.css"
|
|
```
|
|
|
|
## Reactive Attributes
|
|
|
|
| Name | Type | Default | Description |
|
|
|------------|-----------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------|
|
|
| `label` | `str` | `""` | The text that appears inside the button. |
|
|
| `variant` | `ButtonVariant` | `"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
|
|
|
|
- [Button.Pressed][textual.widgets.Button.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.
|
|
|
|
---
|
|
|
|
|
|
::: textual.widgets.Button
|
|
options:
|
|
heading_level: 2
|
|
|
|
::: textual.widgets.button
|
|
options:
|
|
show_root_heading: true
|
|
show_root_toc_entry: true
|