Skip to main content
Version: 2.0.0-alpha

Interface: BaseProperty<T, CustomProps>

Interface including all common properties of a CMS property

Type parameters

NameType
Textends CMSType
CustomPropsany

Hierarchy

Properties

Field

Optional Field: ComponentType<FieldProps<T, CustomProps, any>>

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.

Defined in

lib/src/models/properties.ts:127


Preview

Optional Preview: ComponentType<PropertyPreviewProps<T, CustomProps>>

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.

Defined in

lib/src/models/properties.ts:134


columnWidth

Optional columnWidth: number

Width in pixels of this column in the collection view. If not set the width is inferred based on the other configurations

Defined in

lib/src/models/properties.ts:93


customProps

Optional customProps: CustomProps

Additional props that are passed to the components defined in field or in preview.

Defined in

lib/src/models/properties.ts:140


dataType

dataType: DataType

Datatype of the property

Defined in

lib/src/models/properties.ts:72


defaultValue

Optional defaultValue: T

This value will be set by default for new entities.

Defined in

lib/src/models/properties.ts:145


description

Optional description: string

Property description, always displayed under the field

Defined in

lib/src/models/properties.ts:82


disabled

Optional disabled: boolean | PropertyDisabledConfig

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)

Defined in

lib/src/models/properties.ts:113


editable

Optional editable: boolean

Should this property be editable in the collection editor. If the property has been defined in code, it defaults to false otherwise, it defaults to true.

Defined in

lib/src/models/properties.ts:152


hideFromCollection

Optional hideFromCollection: boolean

Do not show this property in the collection view

Defined in

lib/src/models/properties.ts:98


longDescription

Optional longDescription: string

Longer description of a field, displayed under a popover

Defined in

lib/src/models/properties.ts:87


name

Optional name: string

Property name (e.g. Product)

Defined in

lib/src/models/properties.ts:77


readOnly

Optional readOnly: boolean

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

Defined in

lib/src/models/properties.ts:104


validation

Optional validation: PropertyValidationSchema

Rules for validating this property

Defined in

lib/src/models/properties.ts:118