Skip to content

Options API ​

All options go into uischema.options (merged with config through defu). The table layout follows the Quasar / Vuetify model:

ColumnMeaning
NameKey in options (or nested path)
TypeExpected type
DefaultDefault value (— = none)
DescriptionBehaviour

Each section ends with one or more ready-to-paste JSON examples.

ControlPage
Common options (all fields)Common
String, textarea, password, pin, color, file, API, WYSIWYGText & media
Number, slider, ratingNumbers
BooleanBoolean
Enum, select, radio, multi-enumEnums
Date, time, calendarDates
Array, tags, object, oneOfArrays & objects
Group, Categorization, LabelLayouts
Nuxt UI pass-through (input, formField, …)Pass-through

Placement ​

json
{
  "type": "Control",
  "scope": "#/properties/name",
  "options": {
    "placeholder": "Your name…",
    "input": { "size": "lg" }
  }
}

Options can also be supplied globally through the config prop of JsonForms — control-local options win.

Playground ​

The interactive Nuxt UI showcases (Documentation tab) are listed in Nuxt UI playground examples. Each options page below also points to its live showcase.

Released under the BSD-3-Clause License.