Skip to main content
Version: 3.0.0-beta

Interface: BaseProperty<T, CustomProps>

Interface including all common properties of a CMS property

Extended by​

Type Parameters​

• T extends CMSType

• CustomProps = any

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​

packages/firecms_core/src/types/properties.ts:134


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​

packages/firecms_core/src/types/properties.ts:141


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​

packages/firecms_core/src/types/properties.ts:100


customProps?​

optional customProps: CustomProps

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

Defined in​

packages/firecms_core/src/types/properties.ts:147


dataType​

dataType: "string" | "number" | "boolean" | "reference" | "date" | "geopoint" | "map" | "array"

Datatype of the property

Defined in​

packages/firecms_core/src/types/properties.ts:71


defaultValue?​

optional defaultValue: T

This value will be set by default for new entities.

Defined in​

packages/firecms_core/src/types/properties.ts:152


description?​

optional description: string

Property description, always displayed under the field

Defined in​

packages/firecms_core/src/types/properties.ts:81


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​

packages/firecms_core/src/types/properties.ts:120


editable?​

optional editable: boolean

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.

Defined in​

packages/firecms_core/src/types/properties.ts:158


hideFromCollection?​

optional hideFromCollection: boolean

Do not show this property in the collection view

Defined in​

packages/firecms_core/src/types/properties.ts:105


longDescription?​

optional longDescription: string

Longer description of a field, displayed under a popover

Defined in​

packages/firecms_core/src/types/properties.ts:94


name?​

optional name: string

Property name (e.g. Product)

Defined in​

packages/firecms_core/src/types/properties.ts:76


propertyConfig?​

optional propertyConfig: string

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.

Defined in​

packages/firecms_core/src/types/properties.ts:89


readOnly?​

optional readOnly: boolean

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

Defined in​

packages/firecms_core/src/types/properties.ts:111


validation?​

optional validation: PropertyValidationSchema

Rules for validating this property

Defined in​

packages/firecms_core/src/types/properties.ts:125

Sign up to our newsletter to get the latest news and updates. No spam!