Skip to content

Nuxt UI playground examples

The playground splits into two galleries:

TabContent
DocumentationNuxt UI showcases + API tables (Name / Type / Default / Description)
ExamplesJSONForms demos, compositions and edge cases

Any example whose name starts with nuxt- automatically lands in Documentation. Open the playground.

Documentation catalogue

Overview

ExampleFileTakeaway
Nuxt UI — Control showcasenuxt-ui-showcase.tsSeveral controls side by side to judge height / alignment
Control Optionscontrol-options.tsCommon options, restrict, toggle, autocomplete, WYSIWYG
Simple formsimple-form.tsMinimal string + boolean form

Text & media controls

ExampleComponentsKey options
String & TextareaUInput, UTextarea, passwordrestrict, multi, input, format: password
Pin InputUPinInputformat: pin, otp, mask, length
Color PickerUColorPickercolorFormat, showInput
File UploadUFileUploadaccept, layout, multi through array
Autocomplete APIUInputMenuapi.*, minLength, suggestion
WYSIWYGUEditorwysiwyg, contentType (json | html)

Numbers & booleans

ExampleComponentsKey options
NumberUInputNumberstep, inputNumber
SliderUSliderslider, step, hideValue
RatingUInputRatingformat: rating, icon, hideValue
BooleanUCheckbox, USwitchtoggle, checkbox, switch

Enums

ExampleComponentsKey options
SelectUSelect, USelectMenuformat: select vs default (search)
Radio & Multi-enumURadioGroup, UCheckboxGroupformat: radio, vertical, radioGroup

Dates

ExampleComponentsKey options
Date & TimeUInputDate, UInputTimepattern, month / year precision
CalendarUCalendarformat: calendar
Date rangesCalendar / InputDaterange, minDate, disabled*

Structure

ExampleComponentsKey options
TagsUInputTagsformat: tags, delimiter
ArrayRepeatable cardsshowSortButtons, elementLabelProp, detail
LayoutsUCard, UTabs, Labelcard, queryKey, level, separator

Adding a showcase

  1. Create playground/examples/items/nuxt-<name>.ts calling registerExamples([{ name: 'nuxt-…', … }]).
  2. Prefix name with nuxt- (or pass section: 'docs') to land in the Documentation tab.
  3. Declare the API groups in playground/docs-api/props.ts (API_BY_EXAMPLE).
  4. Document the options under docs/guide/options/ and link them from this page.

Files are eagerly loaded through import.meta.glob in playground/examples/index.ts — no extra manual registry.

Relation to the Options API guide

Every options page ends with ready-to-paste JSON. The showcases above are their interactive counterpart:

Released under the BSD-3-Clause License.