kotose-form-core/io.github.robinpcrd.kotose.form

Package-level declarations

Types

data class Condition(val tags: ImmutableSet<String> = persistentSetOf(), val condition: (Form) -> Boolean = { true })

CustomCondition

class CustomCondition(val tags: ImmutableSet<String> = persistentSetOf(), val onEval: (Element<*>, Form) -> Unit)

A custom condition that can be attached to an Element.

sealed class Element<RuleType : ValidationRule>

ExperimentalKotoseFormApi

@RequiresOptIn(message = "This Kotose Form API is experimental and may change before it becomes stable.", level = RequiresOptIn.Level.WARNING)

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalKotoseFormApi

Marks an API that is available for evaluation but is not covered by the library's source or behavioral compatibility guarantees yet.

abstract class Field<ValueType>(tag: String?) : Element<ValidationRule.Field<ValueType>> , FieldEvent

abstract class FocusableField<ValueType>(tag: String?) : Field<ValueType>

class Form

interface FormEvent

FormNavigationRequest

data class FormNavigationRequest(val id: Long, val targetKey: String)

One programmatic navigation action. Keys survive inserted validation rows.

typealias GenericElement = Element<*>

open class Group(tag: String? = null) : Element<ValidationRule.Group>

RequiredFieldRule

class RequiredFieldRule<ValueType> : ValidationRule.Field<ValueType>

This validation rule makes sure a field is not null or empty.

RequiredSingleSelectionGroupRule

class RequiredSingleSelectionGroupRule(group: SelectionGroup<*>) : ValidationRule.Group

Exactly one visible option of the group must be selected. A selection kept on a hidden option does not count, because it is neither shown nor submitted by default.

interface RequiredValue

A domain value that can report whether it satisfies a required-value rule.

SealedFormEvents

sealed class SealedFormEvents

class Transaction

ValidationError

abstract class ValidationError

The built-in errors expose a settable error so the app owns their wording, for example ValidationError.Required.error = R.string.required.toStrRes() once at startup.

ValidationOption

enum ValidationOption : Enum<ValidationOption>

sealed class ValidationRule

ValidationTriggerSource

enum ValidationTriggerSource : Enum<ValidationTriggerSource>

Functions

ensureSingleTags

fun Collection<Field<*>>.ensureSingleTags()

getMultipleSelectionGroupByTag

inline fun <ValueType> Form.getMultipleSelectionGroupByTag(tag: String): SelectionGroup.Multiple<ValueType>?

getSelectionGroupByTag

inline fun <ValueType> Form.getSelectionGroupByTag(tag: String): SelectionGroup<ValueType>?

getSingleSelectionGroupByTag

inline fun <ValueType> Form.getSingleSelectionGroupByTag(tag: String): SelectionGroup.Single<ValueType>?

fun shouldValidate(triggerSource: ValidationTriggerSource, option: ValidationOption): Boolean

fun transaction(form: Form, reload: Boolean = true, init: Transaction.() -> Unit)

@JvmName(name = "formTransaction")

fun Form.transaction(reload: Boolean = true, init: Transaction.() -> Unit)