Files
textual/docs/widgets/list_view.md
Rodrigo Girão Serrão 5ee0ebfef4 Rename CSS files to TCSS.
Related issue: #3137.
2023-08-22 13:21:17 +01:00

1.1 KiB

ListView

!!! tip "Added in version 0.6.0"

Displays a vertical list of ListItems which can be highlighted and selected. Supports keyboard navigation.

  • Focusable
  • 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"
```

=== "list_view.tcss"

```sass
--8<-- "docs/examples/widgets/list_view.tcss"
```

Reactive Attributes

Name Type Default Description
index int 0 The currently highlighted index

Messages

  • [ListView.Highlighted][textual.widgets.ListView.Highlighted]
  • [ListView.Selected][textual.widgets.ListView.Selected]

Bindings

The list view widget defines the following bindings:

::: textual.widgets.ListView.BINDINGS options: show_root_heading: false show_root_toc_entry: false


::: textual.widgets.ListView options: heading_level: 2