mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
79 lines
1.8 KiB
Markdown
79 lines
1.8 KiB
Markdown
# List View
|
|
|
|
Displays a vertical list of `ListItem`s which can be highlighted and selected.
|
|
Supports keyboard navigation.
|
|
|
|
- [x] Focusable
|
|
- [x] Container
|
|
|
|
## Example
|
|
|
|
The example below shows an app with a simple `ListView`.
|
|
|
|
=== "Output"
|
|
|
|
```{.textual path="docs/examples/widgets/list_view.py"}
|
|
```
|
|
|
|
=== "list_view.py"
|
|
|
|
```python
|
|
--8<-- "docs/examples/widgets/list_view.py"
|
|
```
|
|
|
|
## Reactive Attributes
|
|
|
|
| Name | Type | Default | Description |
|
|
|---------|-------|---------|---------------------------------|
|
|
| `index` | `int` | `0` | The currently highlighted index |
|
|
|
|
## Messages
|
|
|
|
### Highlighted
|
|
|
|
The `ListView.Highlighted` message is emitted when the highlight changes.
|
|
This happens when you use the arrow keys on your keyboard and when you
|
|
click on a list item.
|
|
|
|
- [x] Bubbles
|
|
|
|
#### Attributes
|
|
|
|
| attribute | type | purpose |
|
|
|-----------|------------|--------------------------------|
|
|
| `item` | `ListItem` | The item that was highlighted. |
|
|
|
|
### Selected
|
|
|
|
The `ListView.Selected` message is emitted when a list item is selected.
|
|
You can select a list item by pressing ++enter++ while it is highlighted,
|
|
or by clicking on it.
|
|
|
|
- [x] Bubbles
|
|
|
|
#### Attributes
|
|
|
|
| attribute | type | purpose |
|
|
|-----------|------------|-----------------------------|
|
|
| `item` | `ListItem` | The item that was selected. |
|
|
|
|
|
|
### ChildrenUpdated
|
|
|
|
The `ListView.ChildrenUpdated` message is emitted when the elements in the `ListView`
|
|
are changed (e.g. a child is added, or the list is cleared)
|
|
|
|
- [x] Bubbles
|
|
|
|
#### Attributes
|
|
|
|
| attribute | type | purpose |
|
|
|------------|------------------|---------------------------|
|
|
| `children` | `list[ListItem]` | The new ListView children |
|
|
|
|
|
|
|
|
## See Also
|
|
|
|
* [ListView](../api/list_view.md) code reference
|