Package-level declarations

Types

A decorator attached to a field, column, or row. Renders as an icon and/or label that can trigger a custom action when tapped (in fill mode).

Document

interface Document : Mappable

Top-level Joyfill document model.

DocumentType

enum DocumentType : Enum<DocumentType>

Error

interface Error

ErrorHandler

fun interface ErrorHandler

Interface for handling errors within the SDK

Field

interface Field : Component, Hideable, Mappable

Represents a single interactive or presentational unit within a Joyfill document.

FieldPosition

interface FieldPosition : Mappable

Layout and styling information for rendering a field instance.

File

interface File : Mappable

FormulaDefinition

interface FormulaDefinition : Mappable

FormularApplication

interface FormularApplication : Mappable

FormularTarget

enum FormularTarget : Enum<FormularTarget>

FormulaScope

enum FormulaScope : Enum<FormulaScope>

Hideable

interface Hideable

IdentityGenerator

interface IdentityGenerator

Mappable

interface Mappable

Contract for models that can be represented as a mutable map and JSON.

Page

interface Page : Hideable, Mappable

Stage

enum Stage : Enum<Stage>

Type

interface Type

Discriminant for component/schema kinds.

View

interface View : Mappable

Properties

NoOpErrorHandler

val NoOpErrorHandler: ErrorHandler

Functions

Decorator

fun Decorator(map: MutableMap<String, Any?>): Decorator

Creates a new Decorator instance from an existing mutable map.

fun Decorator(icon: String? = null, label: String? = null, color: String? = null, action: String? = null): Decorator

Creates a new Decorator instance with the specified properties.

fieldOf

fun fieldOf(map: Map<String, Any?>): Field

parseDocument

fun parseDocument(json: String): Document

Parses a JSON string into a Document.

toDocument

inline fun String.toDocument(): Document

inline fun MutableMap<String, Any?>.toDocument(): Document

inline fun JsonObject.toDocument(): Document

toDocuments

inline fun String.toDocuments(): List<Document>

toField

inline fun MutableMap<String, Any?>.toField(): Field

toFieldPosition

inline fun MutableMap<String, Any?>.toFieldPosition(): FieldPosition

toFormularApplication

inline fun MutableMap<String, Any?>.toFormularApplication(): FormularApplication

toFormularDefinition

inline fun MutableMap<String, Any?>.toFormularDefinition(): FormulaDefinition

toPage

inline fun MutableMap<String, Any?>.toPage(): Page

toPosition

inline fun MutableMap<String, Any?>.toPosition(): FieldPosition

toView

inline fun MutableMap<String, Any?>.toView(): View

type

inline fun MutableMap<String, Any?>.type(): Type

viewOf

fun viewOf(map: Map<String, Any?>): View