textual/docs/widgets/list_view.md

List View

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.css"

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

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.

• 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.

• 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).

• Bubbles

Attributes

attribute	type	purpose
children	list[ListItem]	The new ListView children

See Also

• ListView code reference