List (lv_list)

A vertical container into which buttons and text rows can be added.

Edit on GitHub

Overview

Deprecated

The lv_list widget is deprecated and kept only for backward compatibility. A list is just a flex container with a column flow, so build one directly from lv_obj with a LV_FLEX_FLOW_COLUMN layout instead. See the lv_example_flex_list example for a starting point.

The List is a vertical container. You add full-width buttons and text rows to it; the layout takes care of stacking them.

Styling

Background

Buttons and Text

Buttons

lv_list_add_button(list, icon, text) adds a full-width button with an icon (that can be an image or symbol) and text. This function returns a pointer to the button created, which you can use to, for example, add an event call-back.

The text is scrolled horizontally if it is longer than the button.

Text

lv_list_add_text(list, text) adds a text string. This function returns a pointer to the label created, which you can use to, for example, change its text with one of the lv_label_set_text...() functions.

Examples

Simple List

Sorting a List using up and down buttons

Last updated on

On this page