List

Examples

Schema

import type { SchemaNode } from '@object-ui/types';

interface ListSchema {
  type: 'list';
  title?: string;           // heading drawn above the list
  bind?: string;            // path to an array in the host scope, read first
  items?: SchemaNode[];     // drawn when `bind` resolves no array
  ordered?: boolean;
  className?: string;
  wrapperClass?: string;
}

A list needs at least one of bind and items. The renderer reads bind through useDataScope first and falls back to items when the bound value is not an array, so a node may carry both. A bind-only list draws one entry per element of the bound array:

{
  "type": "list",
  "bind": "customerNames"
}

A list with neither key is refused at the node by safeValidateSchema and the strict face, with params.code set to LIST_ENTRIES_REQUIRED. Until objectui#11405 items was required, so the bind-only list above was refused at items. The TypeScript face declares items optional and cannot express the at-least-one rule; the validator enforces it.