Skip to content

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 ListItems. The arrow keys can be used to navigate the list.

ListViewExample One Two Three

from textual.app import App, ComposeResult
from textual.widgets import ListView, ListItem, Label, Footer


class ListViewExample(App):

    CSS_PATH = "list_view.css"

    def compose(self) -> ComposeResult:
        yield ListView(
            ListItem(Label("One")),
            ListItem(Label("Two")),
            ListItem(Label("Three")),
        )
        yield Footer()


if __name__ == "__main__":
    app = ListViewExample()
    app.run()

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.

  • Bubbles

Attributes

attribute type purpose
item ListItem The item that was selected.

See Also