SelectionController
@firecms/core / SelectionController
Type Alias: SelectionController<M>
Section titled “Type Alias: SelectionController<M>”SelectionController<
M> =object
Defined in: types/collections.ts:427
Use this controller to retrieve the selected entities or modify them in an EntityCollection
Type Parameters
Section titled “Type Parameters”M extends Record<string, any> = any
Properties
Section titled “Properties”isEntitySelected()
Section titled “isEntitySelected()”isEntitySelected: (
entity) =>boolean
Defined in: types/collections.ts:430
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity<M>
Returns
Section titled “Returns”boolean
selectedEntities
Section titled “selectedEntities”selectedEntities:
Entity<M>[]
Defined in: types/collections.ts:428
setSelectedEntities
Section titled “setSelectedEntities”setSelectedEntities:
Dispatch<SetStateAction<Entity<M>[]>>
Defined in: types/collections.ts:429
toggleEntitySelection()
Section titled “toggleEntitySelection()”toggleEntitySelection: (
entity,newSelectedState?) =>void
Defined in: types/collections.ts:431
Parameters
Section titled “Parameters”entity
Section titled “entity”Entity<M>
newSelectedState?
Section titled “newSelectedState?”boolean
Returns
Section titled “Returns”void
