Interface: AdditionalColumnDelegate<M, AdditionalKey, UserType>
Use this interface for adding additional columns to entity collection views. If you need to do some async loading you can use AsyncPreviewComponent
Type parameters
| Name | Type |
|---|---|
M | extends Record<string, any> = any |
AdditionalKey | extends string = string |
UserType | extends User = User |
Properties
builder
• builder: (__namedParameters: { context: FireCMSContext<UserType, AuthController<UserType>> ; entity: Entity<M> }) => ReactNode
Type declaration
▸ (__namedParameters): ReactNode
Builder for the content of the cell for this column
Parameters
| Name | Type |
|---|---|
__namedParameters | Object |
__namedParameters.context | FireCMSContext<UserType, AuthController<UserType>> |
__namedParameters.entity | Entity<M> |
Returns
ReactNode
Defined in
lib/src/models/collections.ts:338
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"]
If you don't specify this prop, the generated column will not rerender
on entity property updates.
Defined in
lib/src/models/collections.ts:351
hideFromCollection
• Optional hideFromCollection: boolean
Defined in
lib/src/models/collections.ts:333
id
• id: AdditionalKey
Id of this column. You can use this id in the properties field of the
collection in any order you want
Defined in
lib/src/models/collections.ts:318
name
• name: string
Header of this column
Defined in
lib/src/models/collections.ts:323
width
• Optional width: number
Width of the generated column in pixels