ComponentEvent

UI event emitted for a component interaction, enriched with document context. Provides variants for field-level, cell-level, and page-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.FieldUpdate.value, val view: String? = null, val viewId: String? = null) : 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.FieldUpdate.value, val view: String? = null, val viewId: String? = null) : ComponentEvent<E>

Field-level interaction carrying editor and field context.

Link copied to clipboard

Page-level events for focus and blur transitions. These events are emitted when users navigate between pages.

Link copied to clipboard

Properties

Link copied to clipboard
abstract val fieldId: String

Target field id.

Link copied to clipboard
abstract val fieldIdentifier: String

Target field identifier.

Link copied to clipboard
abstract val fieldPositionId: String

Layout position id for the field instance.

Link copied to clipboard
abstract val fileId: String

File id containing the page.

Link copied to clipboard
abstract val id: String

Document id.

Link copied to clipboard
abstract val identifier: String

External document identifier.

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

Page id containing the target field.

Link copied to clipboard
abstract val source: E?

The originating editor (if available for cell events).

Link copied to clipboard
abstract val target: String

Change target identifier used by handlers.

Link copied to clipboard
abstract val type: String
Link copied to clipboard
abstract val view: String?

View type (e.g., "mobile") for view-specific changes.

Link copied to clipboard
abstract val viewId: String?

View id for view-specific changes.