ArrayProperty

Is this field disabled. When set to true, it gets rendered as a disabled field. You can also specify a configuration for defining the behaviour of disabled properties (including custom messages, clear value on disabled or hide the field completely)

Inherited from

BaseProperty.disabled

editable?

optional editable: boolean

Defined in: types/properties.ts:159

Should this property be editable. If set to true, the user will be able to modify the property and save the new config. The saved config will then become the source of truth.

Inherited from

BaseProperty.editable

expanded?

optional expanded: boolean

Defined in: types/properties.ts:501

Should the field be initially expanded. Defaults to true

Field?

optional Field: ComponentType<FieldProps<T, any, any>>

Defined in: types/properties.ts:135

If you need to render a custom field, you can create a component that takes FieldProps as props. You receive the value, a function to update the value and additional utility props such as if there is an error. You can customize it by passing custom props that are received in the component.

Inherited from

BaseProperty.Field

hideFromCollection?

optional hideFromCollection: boolean

Defined in: types/properties.ts:106

Do not show this property in the collection view

Inherited from

BaseProperty.hideFromCollection

longDescription?

optional longDescription: string

Defined in: types/properties.ts:95

Longer description of a field, displayed under a popover

Inherited from

BaseProperty.longDescription

minimalistView?

optional minimalistView: boolean

Defined in: types/properties.ts:507

Display the child properties directly, without being wrapped in an extendable panel.

name?

optional name: string

Defined in: types/properties.ts:77

Property name (e.g. Product)

Inherited from

BaseProperty.name

of?

optional of: PropertyOrBuilder<ArrayT, any> | Property<ArrayT>[]

Defined in: types/properties.ts:449

The property of this array. You can specify any property (except another Array property) You can leave this field empty only if you are providing a custom field, or using the oneOf prop, otherwise an error will be thrown.

oneOf?

optional oneOf: object

Defined in: types/properties.ts:466

Use this field if you would like to have an array of typed objects. It is useful if you need to have values of different types in the same array. Each entry of the array is an object with the shape:

{ type: "YOUR_TYPE", value: "YOUR_VALUE"}

Note that you can use any property so value can take any value (strings, numbers, array, objects…) You can customise the type and value fields to suit your needs.

An example use case for this feature may be a blog entry, where you have images and text blocks using markdown.

properties

properties: Properties

Record of properties, where the key is the type and the value is the corresponding property

propertiesOrder?

optional propertiesOrder: string[]

Order in which the properties are displayed. If you are specifying your collection as code, the order is the same as the one you define in properties, and you don’t need to specify this prop.

typeField?

optional typeField: string

Name of the field to use as the discriminator for type Defaults to type

valueField?

optional valueField: string

Name of the field to use as the value Defaults to value

Preview?

optional Preview: ComponentType<PropertyPreviewProps<T, any>>

Defined in: types/properties.ts:142

Configure how a property is displayed as a preview, e.g. in the collection view. You can customize it by passing custom props that are received in the component.

Inherited from

BaseProperty.Preview

propertyConfig?

optional propertyConfig: string

Defined in: types/properties.ts:90

You can use this prop to reuse a property that has been defined in the top level of the CMS in the prop fields. All the configuration will be taken from the inherited config, and overwritten by the current property config.

Inherited from

BaseProperty.propertyConfig

readOnly?

optional readOnly: boolean

Defined in: types/properties.ts:112

Is this a read only property. When set to true, it gets rendered as a preview.

Inherited from

BaseProperty.readOnly

sortable?

optional sortable: boolean

Defined in: types/properties.ts:513

Can the elements in this array be reordered. Defaults to true. This prop has no effect if disabled is set to true.

validation?

optional validation: ArrayPropertyValidationSchema

Defined in: types/properties.ts:496

Rules for validating this property

Overrides

BaseProperty.validation

widthPercentage?

optional widthPercentage: number

Defined in: types/properties.ts:165

A number between 0 and 100 that indicates the width of the field in the form view. It defaults to 100, but you can set it to 50 to have two fields in the same row.

Inherited from

BaseProperty.widthPercentage