NE.Standard

Item models

The built-in item models: what a list, a menu, a tab strip or a tree is bound to when it is not bound to a model of your own. Every item carries an Id, which is the only thing it is ever addressed by; a model of your own implements the same interface and is observable through [RecursiveMember].

BadgeItem

A data model describing a badge item's icon and text for use in lists/collections bound to IBadgeModel.

Every styling property starts at null; what an item leaves unsaid is decided by the template drawing it.

PropertyTypeDescription
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

A data model describing one step of a trail, for use in collections bound to IBreadcrumbItemModel.

PropertyTypeDescription
UrlstringThe route this step leads back to. A step may carry a URL, a click command, or both.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

ButtonItem

A data model describing a button item's text and style for use in lists/collections bound to IButtonModel.

PropertyTypeDescription
VariantUIButtonVariant?The button's visual variant — Primary, Accent, Danger, Outline, Ghost, Link, or Surface.
SizeUISize?How much room the button takes — Small, Medium, or Large.
GroupstringThe group this button belongs to; a command bar draws its GroupSeparator where the group changes.
DescriptionUIPhraseThe secondary text. translatable
DescriptionTypeUITextAppearance?The secondary text type.
DescriptionColorUIThemeColor?The secondary text color.
TextAlignmentUITextAlignment?How the title and description align within their box — Start, Center, End, or Justify; default Start.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

FileItem

A data model describing a file for a list of tiles bound to IFileModel — a message's attachments, a downloads list, an upload's result — drawn by DefaultFileTemplate.

PropertyTypeDescription
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
FileNamestringThe file's name, shown on up to two lines; its extension picks the glyph.
FileSizelong?The file's size in bytes; unset shows none.
ContentTypestringThe file's MIME type, which picks the glyph where the name's extension says nothing.
IconstringThe glyph shown in place of the one the file's kind picks.
Loadingbool?Whether the file is still being written: a ring turns in the glyph's place.

KeyValueActionItem

A data model describing a key/value pair with an associated action button for use in lists/collections bound to IKeyValueActionModel.

PropertyTypeDescription
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
KeyITextModelThe content rendered in the row's key slot.
ValueITextModelThe content rendered in the row's value slot.
ActionIButtonModelThe content rendered in the row's action slot.
ShowInputbool?Whether the row shows its value as an input: editing state is the row's, so it survives anything the page does around it.
EditValueobjectThe draft the input edits; Value stays what the row shows until a save moves the draft over.
InputTemplatestringWhich typed input the row opens with, naming a variant registered on the list; unset, the list's default input.

A data model describing one menu entry for use in collections bound to IMenuItemModel.

A text item, so an entry carries a description: one muted line under its title, gone while the menu is folded.

PropertyTypeDescription
KindUIMenuItemKind?What this entry is. null reads as UIMenuItemKind.Item.
UrlstringThe route this entry navigates to. An entry may carry a URL, a click command, or both.
Selectedbool?Whether this entry is the current one.
Expandedbool?Whether this entry's sub-entries start out open; meaningless on an entry with none.
The initial position only — the live state afterwards is kept client-side.
ShortcutstringThe key combination that fires this entry, written as Ctrl+Shift+P and matched by physical key so it keeps working on a non-Latin layout; a context menu's entry fires for the row under the keyboard's cursor.
Checkedbool?Whether a UIMenuItemKind.Check entry is on.
ValueUIPhraseWhat a UIMenuItemKind.Select entry currently says at its end — the chosen option's name, as the controller words it.
InActionBarbool?Whether this entry also stands in its owner's action bar (SetActionBar) as its icon, its title the icon's tooltip.
A context menu's plain entry only: a caption, a rule or a group's own entry never stands in the bar.
Items
fixed
RecursiveCollection<MenuItem>The nested entries. See IMenuItemModel.Items on how deep a menu actually renders.
DescriptionUIPhraseThe secondary text. translatable
DescriptionTypeUITextAppearance?The secondary text type.
DescriptionColorUIThemeColor?The secondary text color.
TextAlignmentUITextAlignment?How the title and description align within their box — Start, Center, End, or Justify; default Start.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

OptionItem

A data model describing a selectable option's text, group and selection state for use in lists/collections bound to IOptionModel.

PropertyTypeDescription
GroupstringThe group key, or null when the item is not grouped.
Selectedbool?Whether this option's key is currently among the chosen ones.
DescriptionUIPhraseThe secondary text. translatable
DescriptionTypeUITextAppearance?The secondary text type.
DescriptionColorUIThemeColor?The secondary text color.
TextAlignmentUITextAlignment?How the title and description align within their box — Start, Center, End, or Justify; default Start.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

TabItem

One tab of a tabs view: a text item with a place in the strip. A tab that cannot be closed says so with TextBaseItem.CanRemove.

PropertyTypeDescription
Orderdouble?Where the tab sits in the strip, ascending; a drag writes the new position back.
Pinnedbool?Whether the tab is pinned: drawn with a pin, without its close control, and left where it is by a drag.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

TextBaseItem

A data model describing an item's icon and title, plus visibility/enabled state, for use in lists/collections bound to ITextBaseModel.

Styling starts at null; TextBaseItem.Visibility and TextBaseItem.Enabled keep their defaults, since they are state, not style. Abilities are bound live by the built-in row templates; a custom template keeps the abilities it rendered with, and a non-row model (a menu entry) leaves them unread.

PropertyTypeDescription
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

TextItem

A data model describing an item's title and description text for use in lists/collections bound to ITextModel.

PropertyTypeDescription
DescriptionUIPhraseThe secondary text. translatable
DescriptionTypeUITextAppearance?The secondary text type.
DescriptionColorUIThemeColor?The secondary text color.
TextAlignmentUITextAlignment?How the title and description align within their box — Start, Center, End, or Justify; default Start.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

TreeNode

A data model for one node of a tree — a text item with the key of the node above it — for lists bound to ITreeNodeModel.

PropertyTypeDescription
ParentIdstringThe key of the node this one sits under, or null at the root.
KindstringThe kind naming the node template variant that draws this node, or null for the default.
HasChildrenbool?Whether the node has children even when none are in the list yet; the first unfold asks the controller for them.
IsFolderbool?Whether the node is a folder, the only kind a drag drops onto: unset for a node holding children, true for one even while empty, false for one that takes no drop. Unlike ITreeNodeModel.HasChildren, it asks the controller for nothing.
Expandedbool?Whether the node starts unfolded; the viewer's own fold takes over from there.
DropTargetstringThe key of the folder this one was moved into, empty for the tree's top level; written by a move, read on move, whose event value is the place among that folder's nodes.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

UIOptionValue<T>

Wraps a plain value as a selectable option, taking both the option's identity and its displayed title from the value itself.

The option-shaped counterpart of UIValueItem, for Select, Search and RadioGroup.

PropertyTypeDescription
Value
fixed
TThe wrapped value.
See UIValueItem.Value for why this does not change after construction.
GroupstringThe group key, or null when the item is not grouped.
Selectedbool?Whether this option's key is currently among the chosen ones.
DescriptionUIPhraseThe secondary text. translatable
DescriptionTypeUITextAppearance?The secondary text type.
DescriptionColorUIThemeColor?The secondary text color.
TextAlignmentUITextAlignment?How the title and description align within their box — Start, Center, End, or Justify; default Start.
CanSelectbool?Whether the item may be chosen; unset means it may.
CanDragbool?Whether the item may be dragged, where its host drags at all; unset means it may.
CanRemovebool?Whether the item may be removed by the host's own gesture — a tab's close, a row's Delete key; unset means it may.
CanRenamebool?Whether the item may be renamed in place, where its host renames at all; unset means it may.
CanShowContextMenubool?Whether a right-click on the item opens the menu its template carries; unset means it does.
IconstringThe icon shown before the title, by name from the registered icon font/set.
IconColorUIThemeColor?The leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSizeUISize?The leading icon size; left unset the glyph is as tall as the title beside it.
IconShapeUIShape?The shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallbackstringThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
TitleUIPhraseThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleTypeUITextAppearance?The primary text type.
TitleColorUIThemeColor?The primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacementUITextBadgePlacement?Where badge content is placed.
TooltipUIPhraseThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacementUIPopupPlacement?The side the tooltip prefers; flips to the opposite side when there is no room for it there.
VisibilityUIResponsive<UIVisibility>?What the model does with the room it was given, optionally overridden per breakpoint.
Enabledbool?Whether this item is enabled; a default row template binds it to the row's own Enabled, so one item can disable itself independent of its siblings.
Id
fixed
stringThe stable item identifier.
Init-only and non-notifying: a keyed collection indexes its items by this, so re-keying after insertion would break the id map.
IsContent
fixed
boolWhether every word read off the item is shown as written — a name such as UTF-8 or C#, never a key.
Init-only and non-notifying: whether a word is a key is settled when the item is drawn. Sent only when set.
BadgeVariantUIBadgeVariant?The badge visual variant.
BadgeColorUIThemeColor?The badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFillUIBadgeFill?How the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIconstringThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColorUIThemeColor?The badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSizeUISize?The badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitleUIPhraseThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleTypeUITextAppearance?The role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltipUIPhraseThe tooltip for the badge content. translatable
BadgeTooltipPlacementUIPopupPlacement?The side the badge's own tooltip prefers, placed against the badge rather than against the row.

UIValueItem<T>

Wraps a plain value as a bindable item, taking the item's identity from the value itself.

The identity is the value, so a list holding the same value twice is refused; use UIOptionValue for Select/Search/RadioGroup.

PropertyTypeDescription
Id
fixed
stringThe stable item identifier.
Value
fixed
TThe wrapped value.
Read-only: the id is derived from it, so replace the item to change the value.