Skip to main content
Version: 3.0.0-beta

Interface: AdditionalFieldDelegate<M, USER>

Use this interface for adding additional fields to entity collection views. If you need to do some async loading you can use AsyncPreviewComponent

Type Parameters​

• M extends Record<string, any> = any

• USER extends User = User

Properties​

Builder?​

optional Builder: ComponentType<AdditionalFieldDelegateProps<M, USER>>

Builder for the content of the cell for this column

Defined in​

packages/firecms_core/src/types/collections.ts:466


dependencies?​

optional dependencies: Extract<keyof M, string>[]

If this column needs to update dynamically based on other properties, you can define an array of keys as strings with the dependencies prop. e.g. ["name", "surname"] This is a performance optimization, if you don't define dependencies it will be updated in every render.

Defined in​

packages/firecms_core/src/types/collections.ts:476


key​

key: string

ID of this column. You can use this id in the properties field of the collection in any order you want

Defined in​

packages/firecms_core/src/types/collections.ts:451


name​

name: string

Header of this column

Defined in​

packages/firecms_core/src/types/collections.ts:456


value()?​

optional value: (props) => string | number | Promise<string | number>

Use this prop to define the value of the column as a string or number. This is the value that will be used for exporting the collection. If Builder is defined, this prop will be ignored in the collection view.

Parameters​

• props

• props.context: FireCMSContext<any>

• props.entity: Entity<M>

Returns​

string | number | Promise<string | number>

Defined in​

packages/firecms_core/src/types/collections.ts:485


width?​

optional width: number

Width of the generated column in pixels

Defined in​

packages/firecms_core/src/types/collections.ts:461

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