3.8 KiB
id, title, sidebar_label, sidebar_position, custom_edit_url
| id | title | sidebar_label | sidebar_position | custom_edit_url |
|---|---|---|---|---|
| referenceproperty | Interface: ReferenceProperty<S, Key> | ReferenceProperty | 0 | null |
Type parameters
| Name | Type |
|---|---|
S |
S: EntitySchema<Key> = EntitySchema<any> |
Key |
Key: string = Extract<keyof S["properties"], string> |
Hierarchy
-
BaseProperty↳ ReferenceProperty
Properties
collectionPath
• collectionPath: string
Absolute collection path of the collection this reference points to. The schema 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.
Defined in
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
config
• Optional config: FieldConfig<DocumentReference<DocumentData>, any>
Configure how this property field is displayed
Defined in
dataType
• dataType: "reference"
Overrides
BaseProperty.dataType
Defined in
description
• Optional description: string
Property description, always displayed under the field
Inherited from
BaseProperty.description
Defined in
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
Inherited from
BaseProperty.disabled
Defined in
longDescription
• Optional longDescription: string
Longer description of a field, displayed under a popover
Inherited from
BaseProperty.longDescription
Defined in
previewProperties
• Optional previewProperties: Key[]
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
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
title
• Optional title: string
Property title (e.g. Product)
Inherited from
BaseProperty.title
Defined in
validation
• Optional validation: PropertyValidationSchema
Rules for validating this property
Inherited from
BaseProperty.validation