Package-level declarations
Types
Link copied to clipboard
High-level editor for a Document.
Link copied to clipboard
class GotoConfig(val open: Boolean = false, val animate: Boolean = true, val focus: Boolean = false)
Configuration for DocumentEditor.goto navigation.
Link copied to clipboard
data class GotoRowTarget(val rowId: String, val rowIndex: Int, val rowManager: RowManager?, val rowEntry: RowEntry?, val openRowForm: Boolean = false, val animate: Boolean = true, val focus: Boolean = false, val columnId: String? = null)
Target for row navigation within a table or collection field. Used by TableEditor and CollectionEditor when navigateTo is invoked.
Link copied to clipboard
Link copied to clipboard
data class NavigationTarget(val scrollIndex: Int, val animate: Boolean = true, val focus: Boolean = true)
Request for field-level scroll navigation. Used by DocumentEditor when navigating to a field or when scrolling to bring a table/collection into view before row navigation.
Link copied to clipboard
interface NavResponse
Response from a DocumentEditor.goto navigation request.
Link copied to clipboard
interface Route
Type-safe navigation routes for DocumentEditor.goto.
Functions
Link copied to clipboard
fun editorOf(document: Document, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor
Creates a new DocumentEditor for the given document.
fun editorOf(json: String, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor
Creates a new DocumentEditor from the given json.
fun editorOf(map: MutableMap<String, Any?>, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor
Creates a new DocumentEditor from the given map.
fun editorOf(json: JsonObject, validateSchema: Boolean = true, identity: IdentityGenerator = IdentityGenerator.default, layout: LayoutConfig = LayoutConfig.convenientMobile(), functions: ResolutionResourceBuilder.() -> Unit? = null, onError: ErrorHandler = NoOpErrorHandler, onChange: DocumentEditor.(ChangeEvent) -> Unit? = null): DocumentEditor
Creates a new DocumentEditor for the given json.