NUI / Components / Scroll, Lists & Data

TileView

ImplementedScroll, Lists & Data

TileView displays repeated data entries as tiles.

Supported as a tiled data view.

Overview

TileView displays repeated data entries as tiles.

When to use

  • Inventories.
  • Grids of unlocks.
  • Image choices.
  • Card lists.
  • Item tiles.

Children

Uses data/template fields instead of normal children.

Basic syntax

nui
TileView InventoryTiles {
    items: "wood|Wood|1;stone|Stone|2"
    tileWidth: 96
    tileHeight: 96
}

Supported properties

PropertyTypeRequiredDefaultDescription
itemsstringNoEmptyInline item data.
dataSourcestringNoEmptyNamed external data source.
itemKeystringNoEmptyField or static key binding.
itemTextstringNoEmptyField or static display text binding.
itemValuestringNoEmptyField or static value binding.
itemCommandstringNoEmptyCommand when an item is used or selected.
selectedKeystringNoEmptyInitially selected item key.
selectionModeenumNosingleSelection mode.
tileWidthnumberNoDefaultTile width.
tileHeightnumberNoDefaultTile height.
virtualizedboolNotrueEnables virtualization.
recycleEntriesboolNotrueReuses entry widgets.
scrollBarVisibilityenumNoautoScrollbar visibility.
gapnumberNo0Space between tiles.
widthnumberNoAutoDesired width.
heightnumberNoAutoDesired height.
visibleboolNotrueVisibility flag.

Contextual properties

Contextual property rules

TileView may receive stack, canvas, grid, wrap, or ExpandableArea slot properties only when it is authored as a direct child of the matching parent. It does not support normal authored child nodes.

Full syntax example

nui
TileView InventoryTiles {
    items: "wood|Wood|1;stone|Stone|2"
    itemKey: "id"
    itemText: "name"
    itemValue: "count"
    itemCommand: "SelectItem"
    selectedKey: "wood"
    selectionMode: single
    tileWidth: 96
    tileHeight: 96
    virtualized: true
    recycleEntries: true
    scrollBarVisibility: auto
    gap: 8
    width: 420
    height: 280
    visible: true
}

Limitations

  • Normal children { ... } blocks are not public syntax for this component.
  • Drag and drop should not be documented as currently supported.