Uniform Platform API

Home > @uniformdev/canvas > ParamTypeConfigConventions

ParamTypeConfigConventions interface

Base interface for parameter type configurations that provides common validation properties.

This interface establishes conventions for parameter/field types config objects.

All properties here are OPTIONAL, and only defined for consistency across param types that use similar config functionality.

Signature:

Properties

Property	Modifiers	Type	Description
required?		boolean	(Optional) Whether an author must enter a value for this property. Implementation of the `required` property is optional (you must set it in the config UI, and also respect it on the component renderer) - custom types that do not need, or use a different meaning for required should create their own custom-named property instead. NOTE: setting required to true will cause a UI indication that the parameter is required. Even if not using it for validation, you can choose to configure it to control the UI.

Property

Modifiers

Type

Description

required?

boolean

(Optional) Whether an author must enter a value for this property.

Implementation of the required property is optional (you must set it in the config UI, and also respect it on the component renderer) - custom types that do not need, or use a different meaning for required should create their own custom-named property instead.

NOTE: setting required to true will cause a UI indication that the parameter is required. Even if not using it for validation, you can choose to configure it to control the UI.