editor/joyfill

Package-level declarations

Types

BulkDelete

class BulkDelete(val page: Page, val changelog: ChangeLog) : BulkEvent

One bulk deletion containing the deleted rows and their cell values.

BulkEdit

class BulkEdit(val page: Page, val changelog: ChangeLog) : BulkEvent

One bulk edit containing every affected row ID and column value.

BulkEvent

sealed class BulkEvent : ComponentEvent<Nothing> , ChangeLog

A committed bulk action, with the same v2 envelope as its single changelog.

ComponentEvent

interface ComponentEvent<out E : ComponentEditor> : ChangeLogParams

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

DecoratorConfig

data class DecoratorConfig(val visibleLimitInFields: Int = 2, val visibleLimitInRows: Int = 1, val showInBulkForm: Boolean)

Configuration for controlling the visibility of decorators in different contexts.

DisplayConfig

data class DisplayConfig(val showUnsupportedFields: Boolean = false, val showUnsupportedColumns: Boolean = true, val showRowNumbers: Boolean = true, val inlineFields: Boolean = false, val singleClickRowEdit: Boolean = false, val decorators: DecoratorConfig = DecoratorConfig.Default)

What renders, and how.

FormConfig

data class FormConfig(val mode: Mode = Mode.fill, val license: String? = null, val events: FormEvents = FormEvents(), val display: DisplayConfig = DisplayConfig(), val pages: PageConfig = PageConfig(), val functions: ResolutionResourceBuilder.() -> Unit? = null, val validateSchema: Boolean = true)

Single configuration object for a document's editor and its rendering.

FormEvents

data class FormEvents(val onChange: (ComponentEvent<*>) -> Unit? = null, val onFocus: (ComponentEvent<*>) -> Unit? = null, val onBlur: (ComponentEvent<*>) -> Unit? = null, val onUpload: suspend (ComponentEvent<AbstractFileEditor>) -> List<String>? = null, val onCapture: suspend (ComponentEvent<AbstractCompStringEditor>) -> String?? = null)

All field/page event handlers in one place.

PageConfig

data class PageConfig(val enableDuplicates: Boolean = false, val enableDeletes: Boolean = false, val currentPageId: String? = null, val showSelector: Boolean = true)

Page-navigation capabilities.