Skip to main content

AdditionalFieldDelegate <M, UserType>

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

Index

Properties

optionalBuilder

Builder?: ComponentType<AdditionalFieldDelegateProps<M, UserType>>

Builder for the content of the cell for this column

optionaldependencies

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.

key

key: string

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

name

name: string

Header of this column

optionalvalue

value?: (props: { context: FireCMSContext<any>; entity: Entity<M> }) => undefined | 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.


Type declaration

    • (props: { context: FireCMSContext<any>; entity: Entity<M> }): undefined | string | number | Promise<string | number>
    • Parameters

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

optionalwidth

width?: number

Width of the generated column in pixels

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