Implementation references
Scripting API and implementation references.
UI Toolkit
IMGUI
Overview
- List view displays items as a flat list unlike tree view which displays items in a multi-tiered hierarchy
- This control only creates visual elements for visible items while allowing the binding of many more items
- As the user scrolls, visual elements in list view are recycled and re-bound to new data items
List view APIs
List view in UI Toolkit
Guidance
Choosing between foldout, list view and tree view
- Tree view is used for displaying items in a multi-tiered hierarchy, like a folder structure
- List view is used for displaying items as a flat list
- Foldout is used to expand / collapse a single level of mixed content, like Inspector controls
Using a foldout with list view
Do not manually insert a foldout control inside list view. Instead use list view’s built-in option for adding a foldout.
Style
Row height
List view requires all visual elements to have the same height so that it can calculate a sensible scroller size.
itemHeight property must be set for the list view to function.
Alternating row backgrounds
Use showAlternatingRowBackgrounds property to add alternating row background colors to the list view.
Show border
Use showBorder property to show a border around the list view.
Behavior
Scrolling content
List view contents are always displayed in a scroll view container to enable scrolling when the contents are larger than the viewport.
- Vertical scrolling is enabled by default
- Change horizontalScrollingEnabled property to True to display horizontal scrolling. (The default value is False)
Selecting list items
Selection state can be set to disable selections, have one selectable item, or have multiple selectable items by using selectionType property.
Reordering
List view items can be dragged to reorder their position by using reorderable property.
Formatting
Anatomy and layout
Anatomy
A list view can contain and be paired with the following elements:
1. List view foldout
2. List view
3. List view row
4. Scrollbar
Interaction states
Default
Default state of a list view row.
Hovered
When hovered, list view rows are highlighted.
Selected
When selected, list view rows are highlighted.
Focused
When focused, list view rows are highlighted in blue.
Disabled
Disabled list view items.
Color
1. List view item backgrounds
2. List view item label
Code samples
Code references
Scripting references for
UI Toolkit
Unity - Scripting API:
ListView
Scripting references for
IMGUI
Resources and related
