Type: array

Each item of this array must be:

root WidgetRegistryElement
Type: object

root root items directoryUrl
Type: stringFormat: uri

Used to locate the assets for a specific widget type. Use this if the location of the JS, CSS, images, etc. is different from the location of this document.
Examples:

"https://s3.amazonaws.com/acmeinc.widgets.prod"

"https://static.mateuaguilo.com"

root root items shortcode
Type: string

The widget type identifier across all systems. This ID should be unique per registry.

Must be at most 255 characters long


Examples:

"boilerplate"

"foo-bar"

root root items version
Type: string

The semantic version string for the widget. This is mainly used for change detection.

Must match regular expression: ^v[0-9]+\.[0-9]+\.[0-9]+$
Examples:

"v0.2.1"

"v3.0.1"

root root items files
Type: array of string

The list of files necessary to embed a widget into an HTML page. If you are building a widget type CMS integration, this should be your main integration point. A widget should be completely functional after including these files and then executing the render function.

Each item of this array must be:

root root items files files items
Type: string

File path relative to "directoryUrl" to embed on the page for this widget. If no "directoryUrl" is present then consider these files to be relative to the location of this document.
Examples:

"js/main.js"

"assets/media.jpeg"

"1/FA/99/BF3305.chunk.js"

root root items title
Type: string

This is used in editorial tools to provide a friendlier alternative to "shortcode". This property should be unique per registry to avoid confusion, but it is not mandatory.

Must be at most 255 characters long


Examples:

"Boilerplate"

"Foo is the Bar"

root root items createdAt
Type: stringFormat: date-time

The original date when this was created.
Example:

"2021-04-28T14:15:03.750Z"

root root items updatedAt
Type: stringFormat: date-time

The last time this entry was modified.
Example:

"2021-04-28T14:15:03.750Z"

root root items settingsSchema
Type: object

Used by widget developers to create reusable widget types. Allows JS widget developers to specify input data that the widget needs.

Some examples for this could include:

  • Content for a CTA button.
  • A radio button to select dark mode,
  • a checklist to only display certain products on the widget.
  • A text field to specify an API endpoint.
  • etc.

This uses the JSON Schema format for each one of the fields, then each CMS integration will transform that into a form that editors will use for data input. Data provided by editors will then be serialized and rendered as "data-[name-of-field]" attributes in the wrapper div for the widget.

root root items settingsSchema fields
Type: object or boolean Default: true

root root items settingsSchema fields $id
Type: stringFormat: uri-reference

root root items settingsSchema fields $schema
Type: stringFormat: uri

root root items settingsSchema fields $ref
Type: stringFormat: uri-reference

root root items settingsSchema fields $comment
Type: string

root root items settingsSchema fields title
Type: string

root root items settingsSchema fields description
Type: string

root root items settingsSchema fields default
Type: object

root root items settingsSchema fields readOnly
Type: boolean Default: false

root root items settingsSchema fields writeOnly
Type: boolean Default: false

root root items settingsSchema fields examples
Type: array

Each item of this array must be:

root root items settingsSchema fields examples examples items
Type: object

root root items settingsSchema fields multipleOf
Type: number

Value must be strictly greater than 0

root root items settingsSchema fields maximum
Type: number

root root items settingsSchema fields exclusiveMaximum
Type: number

root root items settingsSchema fields minimum
Type: number

root root items settingsSchema fields exclusiveMinimum
Type: number

root root items settingsSchema fields maxLength
Type: integer

Value must be greater or equal to 0

root root items settingsSchema fields pattern
Type: stringFormat: regex

root root items settingsSchema fields additionalItems
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields items
Default: true

root root items settingsSchema fields items anyOf #
Type: object or boolean Default: true
Same definition as fields
root root items settingsSchema fields items anyOf schemaArray
Type: array

Must contain a minimum of 1 items

Each item of this array must be:

root root items settingsSchema fields items anyOf item 1 #
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields uniqueItems
Type: boolean Default: false

root root items settingsSchema fields contains
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields required
Type: array of string Default: []

All items must be unique

Each item of this array must be:

root root items settingsSchema fields required required items
Type: string

Each additional property must conform to the following schema

root root items settingsSchema fields additionalProperties
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields definitions
Type: object Default: {}

Each additional property must conform to the following schema

root root items settingsSchema fields definitions #
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields properties
Type: object Default: {}

Each additional property must conform to the following schema

root root items settingsSchema fields properties #
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields patternProperties
Type: object Default: {}

Each additional property must conform to the following schema

root root items settingsSchema fields patternProperties #
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields dependencies
Type: object

Each additional property must conform to the following schema

root root items settingsSchema fields dependencies additionalProperties

root root items settingsSchema fields dependencies additionalProperties anyOf #
Type: object or boolean Default: true
Same definition as fields
root root items settingsSchema fields dependencies additionalProperties anyOf stringArray
Type: array of string Default: []
Same definition as required

root root items settingsSchema fields propertyNames
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields const
Type: object

root root items settingsSchema fields enum
Type: array

Must contain a minimum of 1 items

All items must be unique

Each item of this array must be:

root root items settingsSchema fields enum enum items
Type: object

root root items settingsSchema fields type

root root items settingsSchema fields type anyOf simpleTypes
Type: enum (of string)

Must be one of:

  • "array"
  • "boolean"
  • "integer"
  • "null"
  • "number"
  • "object"
  • "string"
root root items settingsSchema fields type anyOf item 1
Type: array

Must contain a minimum of 1 items

All items must be unique

Each item of this array must be:

root root items settingsSchema fields type anyOf item 1 simpleTypes
Type: enum (of string)
Same definition as _items_settingsSchema_fields_type_anyOf_i0

root root items settingsSchema fields format
Type: string

root root items settingsSchema fields contentMediaType
Type: string

root root items settingsSchema fields contentEncoding
Type: string

root root items settingsSchema fields if
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields then
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields else
Type: object or boolean Default: true
Same definition as fields

root root items settingsSchema fields not
Type: object or boolean Default: true
Same definition as fields

root root items status
Type: enum (of string)

Denotes the status of the widget and its readiness for production.

Must be one of:

  • "stable"
  • "beta"
  • "wip"
  • "deprecated"

root root items help
Type: string

Documentation or help for this widget. This is provided by the developer and it may be surfaced to editors in the CMS editorial forms. This field can contain HTML.
Example:

"The G2 Crowd widget pulls the data from the G2 API to display interactive information on the product specified."

root root items homepage
Type: stringFormat: uri

A URL with more information about the widget. This is typically a link to the widget type repository or demo page. This page should contain information about the license of the software for the widget.
Examples:

"https://github.com/MyOrg/js-widget-types-monorepo"

"https://codeberg.org/MyOrg/js-widget-types-monorepo"

Additional Properties of any type are allowed.

root root items additionalProperties
Type: object