Skip to main content

UI elements reference

This page provides a quick, scannable reference of all available UI Schema element options in nullplatform. Use it as a companion to the UI design docs (which explains when to use each UI element) and the advanced docs (which shows how to add dynamic behaviors using rules).

Control options​

These options define the behavior and appearance of form controls that are bound to JSON Schema properties (such as text fields, enums, radio groups, chips, sliders, and date/time pickers). Here you’ll find display formats, enum helpers, boolean variations, and date/time configurations.

💡 Tip: Many of these options can also be combined with APPLY rules to add dynamic behavior based on data.

OptionTypeApplicable toDescription
ampmbooleanDate/Time controlsUse 12-hour format with AM/PM
autocompletebooleanEnum controlsUse autocomplete vs select dropdown (default: true)
colorstringChipControlDefault chip color: "default" | "primary" | "secondary" | "error" | "info" | "success" | "warning"
dateFormatstringDateControlDisplay format (default: "YYYY-MM-DD")
dateSaveFormatstringDateControlStorage format (default: "YYYY-MM-DD")
dateTimeFormatstringDateTimeControlDisplay format (default: "YYYY-MM-DD HH:mm")
dateTimeSaveFormatstringDateTimeControlStorage format (ISO format)
direction"vertical" | "horizontal"RadioGroup, DisplayLayout direction for options/fields
disableAddbooleanArray controlsDisable the "Add" button
disableRemovebooleanArray controlsDisable the "Remove" button
elementLabelPropstringArray layoutsProperty name to use as item label
focusbooleanMost input controlsAuto-focus this control on mount
formatstringVariousSpecial formats: "chip", "password", "markdown", "text", "radio", "radio-cards"
hideRequiredAsteriskbooleanMost controlsHide the required field asterisk
iconstringChipControl, DisplayIcon name in Iconify format (iconset:icon-name, e.g., "ic:outline-check", "eva:eye-fill")
labelSuffixstringAutocompleteSuffix text added to all option labels
mappingobjectChipControlPer-value chip configuration
multibooleanTextControlRender as multiline textarea
placeholderstringAutocompleteCustom placeholder text for input
restrictbooleanText/NumberEnforce maxLength or max value
showArrayLayoutSortButtonsbooleanArrayLayoutShow up/down arrows for reordering array items
showArrayTableSortButtonsbooleanTableControlShow up/down arrows for reordering table rows
showDescriptionbooleanDisplay controlsShow the field description
showNavButtonsbooleanCategorization stepperShow Previous/Next navigation buttons
showUnfocusedDescriptionbooleanMost controlsShow description even when not focused
sizestringChipControlDefault chip size: "small" | "medium"
styleobjectLabel, Display, ChipCSS properties object
timeFormatstringTimeControlDisplay format (default: "HH:mm")
timeSaveFormatstringTimeControlStorage format (default: "HH:mm:ss")
togglebooleanBooleanControlRender as toggle switch instead of checkbox
trimbooleanMost controlsFixed width instead of full width
valueLabelDisplay"auto" | "on" | "off"SliderControlWhen to show the slider value label
variantstringCategorization, Chip"stepper" for Categorization; "filled" | "outlined" for Chip
viewsarrayDate/Time controlsWhich picker views to show (e.g., ["year", "month", "day"])

Layout options​

Layout options control how the form is organized visually without affecting the data model. This section covers configuration for Categorization layouts, including navigation controls and collapsible sections for large schemas.

💡 Tip: Use these options to improve readability and guide users through multi-step or grouped forms.

OptionTypeApplicable toDescription
collapsableobjectCategorizationConfiguration for collapsable tabs
collapsable.collapsedbooleanCategorizationInitial collapsed state
collapsable.labelstringCategorizationToggle button label text
collapsable.i18nstringCategorizationi18n key for toggle label
showNavButtonsbooleanCategorization stepperShow Previous/Next buttons
variant"stepper"CategorizationRender as stepper layout

Display control options​

These options apply to read-only display elements and controls rendered in non-editable contexts. They allow you to adjust label/value orientation (row or column), optionally include icons, toggle descriptions, and provide a style object for presentation tweaks.

💡 Tip: These are useful for summaries, static information, and computed data outputs.

OptionTypeApplicable toDescription
direction"row" | "column"Display controlsLayout direction for label and value
iconstringDisplay controlsIcon name in Iconify format (iconset:icon-name) to display next to value
showDescriptionbooleanDisplay controlsWhether to show the field description
styleobjectDisplay controlsCSS properties to apply