NUI / Components / Scroll, Lists & Data

DynamicEntryBoxBase

ImplementedScroll, Lists & Data

DynamicEntryBoxBase is a base surface for repeated entries generated from data.

Supported as an advanced base repeated-entry component.

Overview

DynamicEntryBoxBase is a base surface for repeated entries generated from data.

When to use

  • Use DynamicEntryBoxBase in advanced documentation or generated docs. Most public docs should lead users to DynamicEntryBox.

Children

Uses data/template fields instead of normal children.

Basic syntax

nui
DynamicEntryBoxBase EntryBase {
    items: "one|One|1;two|Two|2"
}

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 entry is used.
layoutenumNoverticalEntry layout mode.
entryWidthnumberNoDefaultEntry width.
entryHeightnumberNoDefaultEntry height.
entrySpacingnumberNo0Space between entries.
recycleEntriesboolNotrueReuses entry widgets.
recyclePoolSizeintegerNoDefaultRecycle pool size.
widthnumberNoAutoDesired width.
heightnumberNoAutoDesired height.
visibleboolNotrueVisibility flag.

Contextual properties

Contextual property rules

DynamicEntryBoxBase 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
DynamicEntryBoxBase EntryBase {
    items: "one|One|1;two|Two|2"
    itemKey: "id"
    itemText: "label"
    itemValue: "value"
    itemCommand: "UseEntry"
    layout: vertical
    entryWidth: 180
    entryHeight: 32
    entrySpacing: 6
    recycleEntries: true
    recyclePoolSize: 16
    width: 320
    height: 240
    visible: true
}

Limitations

  • Normal children { ... } blocks are not public syntax for this component.
  • Prefer DynamicEntryBox for most public documentation.