Skip to main content
Version: 3.0.0-beta

Interface: EntityCollection<M, USER>

This interface represents a view that includes a collection of entities. It can be in the root level of the configuration, defining the main menu navigation. You can also find it as a subcollection of a different one.

Type Parameters​

• M extends Record<string, any> = any

• USER extends User = any

Properties​

Actions?​

optional Actions: ComponentType<CollectionActionsProps<any, User, EntityCollection<any, any>>> | ComponentType<CollectionActionsProps<any, User, EntityCollection<any, any>>>[]

Builder for rendering additional components such as buttons in the collection toolbar

Defined in​

packages/firecms_core/src/types/collections.ts:171

additionalFields?​

optional additionalFields: AdditionalFieldDelegate<M, USER>[]

You can add additional fields to the collection view by implementing an additional field delegate.

Defined in​

packages/firecms_core/src/types/collections.ts:248

callbacks?​

optional callbacks: EntityCallbacks<M, USER>

This interface defines all the callbacks that can be used when an entity is being created, updated or deleted. Useful for adding your own logic or blocking the execution of the operation.

Defined in​

packages/firecms_core/src/types/collections.ts:165

collectionGroup?​

optional collectionGroup: boolean

If this collection is a top level navigation entry, you can set this property to true to indicate that this collection is a collection group.

Defined in​

packages/firecms_core/src/types/collections.ts:64

customId?​

optional customId: boolean | EnumValues | "optional"

If this property is not set, the property will be created by the datasource. You can set the value to true to allow the users to choose the ID. You can also pass a set of values (as an EnumValues object) to allow them to pick from only those.

Defined in​

packages/firecms_core/src/types/collections.ts:212

databaseId?​

optional databaseId: string

Optional database id of this collection. If not specified, the default database id will be used.

Defined in​

packages/firecms_core/src/types/collections.ts:58

defaultSelectedView?​

optional defaultSelectedView: string | DefaultSelectedViewBuilder

If you want to open custom views or subcollections by default when opening the edit view of an entity, you can specify the path to the view here. The path is relative to the current collection. For example if you have a collection that has a custom view as well as a subcollection that refers to another entity, you can either specify the path to the custom view or the path to the subcollection.

Defined in​

packages/firecms_core/src/types/collections.ts:278

defaultSize?​

optional defaultSize: CollectionSize

Default size of the rendered collection

Defined in​

packages/firecms_core/src/types/collections.ts:253

description?​

optional description: string

Optional description of this view. You can use Markdown.

Defined in​

packages/firecms_core/src/types/collections.ts:45

editable?​

optional editable: boolean

Can this collection configuration be edited by the end user. Defaults to true. Keep in mind that you can also set this prop to individual properties. This prop has only effect if you are using the collection editor.

Defined in​

packages/firecms_core/src/types/collections.ts:325

entityActions?​

optional entityActions: EntityAction<M, USER>[]

You can define additional actions that can be performed on the entities in this collection. These actions can be displayed in the collection view or in the entity view.

You can use the onClick method to implement your own logic. In the context prop you can access all the controllers of FireCMS.

const archiveEntityAction: EntityAction = {
    icon: <ArchiveIcon/>,
    name: "Archive",
    onClick({
                entity,
                collection,
                context,
            }): Promise<void> {
        // Add your code here
        return Promise.resolve(undefined);
    }
}

Defined in​

packages/firecms_core/src/types/collections.ts:196

entityViews?​

optional entityViews: (string | EntityCustomView<M>)[]

Array of builders for rendering additional panels in an entity view. Useful if you need to render custom views. You can either define the custom view inline or pass a reference to a custom view defined in the main configuration under entityViews

Defined in​

packages/firecms_core/src/types/collections.ts:242

exportable?​

optional exportable: boolean | ExportConfig<USER>

Defined in​

packages/firecms_core/src/types/collections.ts:301

forceFilter?​

optional forceFilter: Partial<Record<Extract<keyof M, string>, [WhereFilterOp, any]>>

Force a filter in this view. If applied, the rest of the filters will be disabled. Filters applied with this prop cannot be changed. e.g. forceFilter: { age: [">=", 18] }

Defined in​

packages/firecms_core/src/types/collections.ts:219

formAutoSave?​

optional formAutoSave: boolean

If set to true, the form will be auto-saved when the user changes the value of a field. Defaults to false. You can't use this prop if you are using a customId

Defined in​

packages/firecms_core/src/types/collections.ts:296

group?​

optional group: string

Optional field used to group top level navigation entries under a~ navigation view. If you set this value in a subcollection it has no effect.

Defined in​

packages/firecms_core/src/types/collections.ts:80

hideFromNavigation?​

optional hideFromNavigation: boolean

Should this collection be hidden from the main navigation panel, if it is at the root level, or in the entity side panel if it's a subcollection. It will still be accessible if you reach the specified path. You can also use this collection as a reference target.

Defined in​

packages/firecms_core/src/types/collections.ts:269

hideIdFromCollection?​

optional hideIdFromCollection: boolean

Should the ID of this collection be hidden from the grid view.

Defined in​

packages/firecms_core/src/types/collections.ts:288

hideIdFromForm?​

optional hideIdFromForm: boolean

Should the ID of this collection be hidden from the form view.

Defined in​

packages/firecms_core/src/types/collections.ts:283

icon?​

optional icon: string

Icon key to use in this collection. You can use any of the icons in the Material specs: https://fonts.google.com/icons e.g. 'account_tree' or 'person'. Find all the icons in https://firecms.co/docs/icons

Defined in​

packages/firecms_core/src/types/collections.ts:73

id​

id: string

You can set an alias that will be used internally instead of the path. The alias value will be used to determine the URL of the collection, while path will still be used in the datasource. Note that you can use this value in reference properties too.

Defined in​

packages/firecms_core/src/types/collections.ts:28

initialFilter?​

optional initialFilter: Partial<Record<Extract<keyof M, string>, [WhereFilterOp, any]>>

Initial filters applied to the collection this collection is related to. Defaults to none. Filters applied with this prop can be changed. e.g. initialFilter: { age: [">=", 18] }

Defined in​

packages/firecms_core/src/types/collections.ts:226

initialSort?​

optional initialSort: [Extract<keyof M, string>, "asc" | "desc"]

Default sort applied to this collection. When setting this prop, entities will have a default order applied in the collection. e.g. initialSort: ["order", "asc"]

Defined in​

packages/firecms_core/src/types/collections.ts:234

inlineEditing?​

optional inlineEditing: boolean

Can the elements in this collection be edited inline in the collection view. If this flag is set to false but permissions.edit is true, entities can still be edited in the side panel

Defined in​

packages/firecms_core/src/types/collections.ts:260

name​

name: string

Name of the collection, typically plural. E.g. Products, Blog

Defined in​

packages/firecms_core/src/types/collections.ts:34

openEntityMode?​

optional openEntityMode: "side_panel" | "full_screen"

When editing an entity, you can choose to open the entity in a side dialog or in a full screen dialog. Defaults to full_screen.

Defined in​

packages/firecms_core/src/types/collections.ts:103

overrides?​

optional overrides: EntityOverrides

Overrides for the entity view, like the data source or the storage source.

Defined in​

packages/firecms_core/src/types/collections.ts:312

ownerId?​

optional ownerId: string

User id of the owner of this collection. This is used only by plugins, or if you are writing custom code

Defined in​

packages/firecms_core/src/types/collections.ts:307

pagination?​

optional pagination: number | boolean

If enabled, content is loaded in batches. If false all entities in the collection are loaded. You can specify a number to specify the pagination size (50 by default) Defaults to true

Defined in​

packages/firecms_core/src/types/collections.ts:134

path​

path: string

Relative path of this view to its parent. If this view is in the root the path is equal to the absolute one. This path also determines the URL in FireCMS, unless an alias is specified

Defined in​

packages/firecms_core/src/types/collections.ts:52

permissions?​

optional permissions: Permissions | PermissionsBuilder<EntityCollection<any, any>, USER, M>

Permissions the logged-in user can perform on this collection. If not specified everything defaults to true.

Defined in​

packages/firecms_core/src/types/collections.ts:146

previewProperties?​

optional previewProperties: string[]

Default preview properties displayed when this collection is referenced to.

Defined in​

packages/firecms_core/src/types/collections.ts:90

properties​

properties: PropertiesOrBuilders<M>

Set of properties that compose an entity

Defined in​

packages/firecms_core/src/types/collections.ts:85

propertiesOrder?​

optional propertiesOrder: (string | Extract<keyof M, string>)[]

Order in which the properties are displayed. If you are specifying your collection as code, the order is the same as the one you define in properties. Additional columns are added at the end of the list, if the order is not specified. You can use this prop to hide some properties from the table view. Note that if you set this prop, other ways to hide fields, like hidden in the property definition, will be ignored. propertiesOrder has precedence over hidden.

  • For properties use the property key.
  • For additional columns use the column id.
  • If you have subcollections, you get a column for each subcollection, with the path (or alias) as the subcollection, prefixed with subcollection:. e.g. subcollection:orders.
  • If you are using a collection group, you will also have an additional collectionGroupParent column. You can use this prop to hide some properties from the table view. Note that if you set this prop, other ways to hide fields, like hidden in the property definition,will be ignored. propertiesOrder has precedence over hidden.

Defined in​

packages/firecms_core/src/types/collections.ts:126

selectionController?​

optional selectionController: SelectionController<M>

Pass your own selection controller if you want to control selected entities externally.

See​

useSelectionController

Defined in​

packages/firecms_core/src/types/collections.ts:203

selectionEnabled?​

optional selectionEnabled: boolean

Are the entities in this collection selectable. Defaults to true

Defined in​

packages/firecms_core/src/types/collections.ts:151

sideDialogWidth?​

optional sideDialogWidth: string | number

Width of the side dialog (in pixels) when opening an entity in this collection.

Defined in​

packages/firecms_core/src/types/collections.ts:317

singularName?​

optional singularName: string

Singular name of an entry in this collection E.g. Product, Blog entry

Defined in​

packages/firecms_core/src/types/collections.ts:40

subcollections?​

optional subcollections: EntityCollection<any, any>[]

You can add subcollections to your entity in the same way you define the root collections. The collections added here will be displayed when opening the side dialog of an entity.

Defined in​

packages/firecms_core/src/types/collections.ts:158

textSearchEnabled?​

optional textSearchEnabled: boolean

Flag to indicate if a search bar should be displayed on top of the collection table.

Defined in​

packages/firecms_core/src/types/collections.ts:140

titleProperty?​

optional titleProperty: keyof M

Title property of the entity. This is the property that will be used as the title in entity related views and references. If not specified, the first property simple text property will be used.

Defined in​

packages/firecms_core/src/types/collections.ts:97

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