AdditionalFieldDelegate

@firecms/core

---

@firecms/core / AdditionalFieldDelegate

Interface: AdditionalFieldDelegate<M, USER>

Defined in: types/collections.ts:485

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

M extends Record<string, any> = any

USER

USER extends User = User

Properties

Builder?

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

Defined in: types/collections.ts:507

Builder for the content of the cell for this column

---

dependencies?

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

Defined in: types/collections.ts:517

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.

---

key

key: string

Defined in: types/collections.ts:492

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

---

name

name: string

Defined in: types/collections.ts:497

Header of this column

---

value()?

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

Defined in: types/collections.ts:526

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

context

FireCMSContext<any>

entity

Entity<M>

Returns

string | number | Promise<string | number> | undefined

---

width?

optional width: number

Defined in: types/collections.ts:502

Width of the generated column in pixels