Skip to main content

JSON Forms Reference

This reference covers everything Prismatic's configuration wizard supports for JSON Forms. Use it when you already know what JSON Forms is and you need exhaustive details on schema features, UI schema elements, renderers, or the options you can pass.

If you're new to JSON Forms, start with What are JSON Forms? and work through Using JSON Forms before diving in here.

Prismatic adds a set of custom renderers, layouts, and options on top of what JSON Forms ships by default. Everything in this reference reflects what's available in the Prismatic configuration wizard, which may differ from stock JSON Forms.

How to read this reference​

JSON Forms drives a form from two JSON documents you author:

  • Schema - a JSON Schema that describes the data your form collects.
  • UI schema - a JSON document that describes how the schema is rendered - layouts, labels, visibility, and per-control behavior.

Three reference pages break the UI schema down further:

  • Renderers - how each schema type maps to an input control, and which controls Prismatic customizes.
  • Rules - the rule block you attach to any UI schema element to show, hide, enable, or disable it based on form data.
  • Options - an alphabetized catalog of every options key you can set on a UI schema element.

What this reference does not cover​

This reference focuses on what Prismatic renders, not the JSON Schema language itself. For JSON Schema keyword semantics - allOf, anyOf, conditional subschemas, advanced validation - see the JSON Schema specification. For format validators (email, uri, ipv4, and so on), see Formats in the schema reference.