ComponentEvent

UI event emitted for a component interaction, enriched with document context. Provides variants for field-level and cell-level interactions.

Inheritors

Types

Link copied to clipboard
data class CellEvent<out E : ComponentEditor>(val source: E?, val page: Page, val rowIds: List<String>?, val schemaId: String? = null, val parentPath: String? = null, val id: String, val identifier: String, val fieldId: String = source?.id ?: "", val fieldIdentifier: String, val pageId: String = page.id, val fileId: String, val fieldPositionId: String, val target: String = Target.field_update) : ComponentEvent<E>

Table cell-level interaction carrying row/column and table context.

Link copied to clipboard
data class FieldEvent<out E : ComponentEditor>(val source: E, val page: Page, val id: String, val identifier: String, val fieldId: String = source.id, val fieldIdentifier: String = source.identifier, val pageId: String = page.id, val fileId: String, val fieldPositionId: String, val target: String = Target.field_update) : ComponentEvent<E>

Field-level interaction carrying editor and field context.

Properties

Link copied to clipboard
abstract val fieldId: String
Link copied to clipboard
abstract val fieldIdentifier: String
Link copied to clipboard
abstract val fieldPositionId: String
Link copied to clipboard
abstract val fileId: String
Link copied to clipboard
abstract val id: String
Link copied to clipboard
abstract val identifier: String
Link copied to clipboard
abstract val multi: Boolean?

When applicable, whether the underlying file component supports multiple selections.

Link copied to clipboard
abstract val page: Page

The page containing the component.

Link copied to clipboard
abstract val pageId: String
Link copied to clipboard
abstract val source: E?

The originating editor (if available for cell events).

Link copied to clipboard
abstract val target: String