EntityActionClickProps

Optional form context, present if the action is being called from a form. This allows you to access the form state and methods, including modifying the form values.

fullIdPath?

optional fullIdPath: string

Defined in: types/entity_actions.tsx:68

fullPath?

optional fullPath: string

Defined in: types/entity_actions.tsx:67

highlightEntity()?

optional highlightEntity: (entity) => void

Defined in: types/entity_actions.tsx:101

Optional highlight function to highlight the entity in the collection view

Parameters

entity

Entity<any>

Returns

void

navigateBack()?

optional navigateBack: () => void

Defined in: types/entity_actions.tsx:112

Optional function to navigate back (e.g. when deleting an entity or navigating from a form)

Returns

void

onCollectionChange()?

optional onCollectionChange: () => void

Defined in: types/entity_actions.tsx:117

Callback to be called when the collection changes, e.g. after an entity is deleted or created.

Returns

void

openEntityMode

openEntityMode: "side_panel" | "full_screen"

Defined in: types/entity_actions.tsx:90

If the action is rendered in the form, is it open in a side panel or full screen?

selectionController?

optional selectionController: SelectionController

Defined in: types/entity_actions.tsx:95

Optional selection controller, present if the action is being called from a collection view

sideEntityController?

optional sideEntityController: SideEntityController

Defined in: types/entity_actions.tsx:80

Present if this actions is being called from a side dialog only

unhighlightEntity()?

optional unhighlightEntity: (entity) => void

Defined in: types/entity_actions.tsx:107

Optional unhighlight function to remove the highlight from the entity in the collection view

Parameters

entity

Entity<any>

Returns

void

view

view: "collection" | "form"

Defined in: types/entity_actions.tsx:85

Is the action being called from the collection view or from the entity form view?