Skip to main content
Version: 3.0.0-beta

Interface: ReferenceProperty

Extends​

Properties​

Field?​

optional Field: ComponentType<FieldProps<EntityReference, any, 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.

Inherited from​

BaseProperty.Field

Defined in​

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


Preview?​

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

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

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

Inherited from​

BaseProperty.columnWidth

Defined in​

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


customProps?​

optional customProps: any

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

Inherited from​

BaseProperty.customProps

Defined in​

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


dataType​

dataType: "reference"

Datatype of the property

Overrides​

BaseProperty.dataType

Defined in​

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


defaultValue?​

optional defaultValue: EntityReference

This value will be set by default for new entities.

Inherited from​

BaseProperty.defaultValue

Defined in​

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


description?​

optional description: string

Property description, always displayed under the field

Inherited from​

BaseProperty.description

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)

Inherited from​

BaseProperty.disabled

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.

Inherited from​

BaseProperty.editable

Defined in​

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


forceFilter?​

optional forceFilter: Partial<Record<string, [WhereFilterOp, any]>>

Allow selection of entities that pass the given filter only. e.g. forceFilter: { age: [">=", 18] }

Defined in​

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


hideFromCollection?​

optional hideFromCollection: boolean

Do not show this property in the collection view

Inherited from​

BaseProperty.hideFromCollection

Defined in​

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


optional includeEntityLink: boolean

Should the reference include a link to the entity (open the entity details). Defaults to true

Defined in​

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


includeId?​

optional includeId: boolean

Should the reference include the ID of the entity. Defaults to true

Defined in​

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


longDescription?​

optional longDescription: string

Longer description of a field, displayed under a popover

Inherited from​

BaseProperty.longDescription

Defined in​

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


name?​

optional name: string

Property name (e.g. Product)

Inherited from​

BaseProperty.name

Defined in​

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


path?​

optional path: string

Absolute collection path of the collection this reference points to. The collection of the entity is inferred based on the root navigation, so the filters and search delegate existing there are applied to this view as well. You can leave this prop undefined if the path is not yet know, e.g. you are using a property builder and the path depends on a different property. Note that you can also use a collection alias.

Defined in​

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


previewProperties?​

optional previewProperties: string[]

Properties that need to be rendered when displaying a preview of this reference. If not specified the first 3 are used. Only the first 3 specified values are considered.

Defined in​

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


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.

Inherited from​

BaseProperty.propertyConfig

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.

Inherited from​

BaseProperty.readOnly

Defined in​

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


validation?​

optional validation: PropertyValidationSchema

Rules for validating this property

Inherited from​

BaseProperty.validation

Defined in​

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

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