Fields & props
Array
This is a bit more sophisticated field so we created a page with more details here:
Array (list of objects)key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.children
: A nested set of fields for use withInputType.Object
orInputType.Array
fields.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Checkbox
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Custom
This is a bit more sophisticated field so we created a page with more details here:
Customkey
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.Field
: Field componentlabel
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.options
: (optional) An array ofOption
objects for use withInputType.Select
,InputType.Custom
andInputType.Radio
fields.
Date
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Json
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
MultiText
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Object
This is a bit more sophisticated field so we created a page with more details here:
Objectkey
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.children
: A nested set of fields for use withInputType.Object
orInputType.Array
fields.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Number
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Password
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Radio
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.options
: (optional) An array ofOption
objects for use withInputType.Select
,InputType.Custom
andInputType.Radio
fields.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Select
Also known as Dropdown, Dropdown menu, or Dropdown list
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.options
: (optional) An array ofOption
objects for use withInputType.Select
,InputType.Custom
andInputType.Radio
fields.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Switch
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Text
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
TextArea
key
: A unique identifier for the field.type
: The type of input to use for the field, as specified by theInputType
enumeration.label
: (optional) The label to display for the field.isDisabled
: (optional) A boolean value indicating whether the field should be disabled.isRequired
: (optional) A boolean value indicating whether the field is required.defaultValue
: (optional) The default value for the field.
Last updated