Skip to main content
Version: 2.0.0-beta

Interface: CollectionActionsProps<M, UserType, EC>

Parameter passed to the Actions prop in the collection configuration. Note that actions are rendered in the collection toolbar, as well as in the home page card. If you don't want to render the actions in the home page card, you can return null if mode is home.

Type parameters

NameType
Mextends Record<string, any> = any
UserTypeextends User = User
ECextends EntityCollection<M> = EntityCollection<M>

Properties

collection

collection: EC

The collection configuration

Defined in

lib/src/types/collections.ts:256


context

context: FireCMSContext<UserType, AuthController<UserType>>

Context of the app status

Defined in

lib/src/types/collections.ts:274


loadedEntities

loadedEntities: Entity<M>[]

Entities that are currently loaded in the collection view. Note that this is not the full list of entities, but only the ones currently loaded in the collection view.

Defined in

lib/src/types/collections.ts:269


path

path: string

Collection path of this entity. This is the full path, like users/1234/addresses

Defined in

lib/src/types/collections.ts:251


selectionController

selectionController: SelectionController<M>

Use this controller to get the selected entities and to update the selected entities state.

Defined in

lib/src/types/collections.ts:262

Enterprise?

Learn how to get the most out of your project with the help of our consulting team.
Get in touch
Sign up to our newsletter to get the latest news and updates. No spam!