Files
textual/docs/widgets/list_item.md
Dave Pearson c90e4adaf8 Correct the check list for the ListItem
The checks in the list, which were unckecked, needed spaces in them to
render correctly in the docs.
2022-12-15 16:23:49 +00:00

47 lines
1.0 KiB
Markdown

# List Item
`ListItem` is the type of the elements in a `ListView`.
- [ ] Focusable
- [ ] Container
## Example
The example below shows an app with a simple `ListView`, consisting
of multiple `ListItem`s. The arrow keys can be used to navigate the list.
=== "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 |
|---------------|--------|---------|--------------------------------------|
| `highlighted` | `bool` | `False` | True if this ListItem is highlighted |
## Messages
### Selected
The `ListItem.Selected` message is sent when the item is selected.
- [x] Bubbles
#### Attributes
| attribute | type | purpose |
|-----------|------------|-----------------------------|
| `item` | `ListItem` | The item that was selected. |
## See Also
* [ListItem](../api/list_item.md) code reference