Type Alias: EntityAction<M, UserType>

EntityAction<M, UserType>: object

An entity action is a custom action that can be performed on an entity. They are displayed in the entity view and in the collection view.

Type Parameters

• M extends object = any

• UserType extends User = User

Type declaration

collapsed?

optional collapsed: boolean

Show this action collapsed in the menu of the collection view. Defaults to true If false, the action will be shown in the menu

icon?

optional icon: React.ReactElement

Icon of the action

includeInForm?

optional includeInForm: boolean

Show this action in the form, defaults to true

name

name: string

Title of the action

onClick()

onClick: (props) => Promise<void> | void

Callback when the action is clicked

Parameters

• props: EntityActionClickProps<M, UserType>

Returns

Promise<void> | void

Defined in

packages/firecms_core/src/types/entity_actions.tsx:12