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

SingleChoiceField

open class SingleChoiceField<T>(tag: String? = null, possibleValues: List<DropdownOption<T>>, val placeholder: StrRes? = null, val isClearable: Boolean = false, val presentation: SelectionPresentation = SelectionPresentation.Menu, val iosPresentation: SelectionPresentation? = null) : Field<T>

Renderer-neutral dropdown state. Kotlin owns the typed value; renderers select an option ID. presentation applies on every platform unless iosPresentation replaces it on iOS.

Constructors

SingleChoiceField

constructor(tag: String? = null, possibleValues: List<DropdownOption<T>>, placeholder: StrRes? = null, isClearable: Boolean = false, presentation: SelectionPresentation = SelectionPresentation.Menu, iosPresentation: SelectionPresentation? = null)

Properties

customCondition

var customCondition: CustomCondition?

val errors: ImmutableList<ValidationError>

val errorsState: State<ImmutableList<ValidationError>>

var form: Form?

hasErrorAndVisible

val hasErrorAndVisible: Boolean

hasErrorOrWarningAndVisible

val hasErrorOrWarningAndVisible: Boolean

val hasErrors: Boolean

return true if the element has errors, not warnings

hasErrorsNotSilent

val hasErrorsNotSilent: Boolean

hasErrorsNotSilentState

val hasErrorsNotSilentState: State<Boolean>

hasErrorsOrWarnings

val hasErrorsOrWarnings: Boolean

val hasErrorsState: State<Boolean>

return true if the element has errors, not warnings

hasWarningsState

val hasWarningsState: State<Boolean>

val indexInGroup: Int

iosPresentation

val iosPresentation: SelectionPresentation?

val isClearable: Boolean

val isEnabled: Boolean

isEnabledCondition

var isEnabledCondition: Condition

val isEnabledState: State<Boolean>

val isErrorField: Boolean

val isVisible: Boolean

isVisibleCondition

var isVisibleCondition: Condition

val isVisibleState: State<Boolean>

val key: String

Element key

onValidationChange

var onValidationChange: () -> Unit

var onValueChange: (T?) -> Unit

var parent: Group?

val parentErrors: List<ValidationError>

parentErrorState

val parentErrorState: State<List<ValidationError>>

val placeholder: StrRes?

var possibleValues: List<DropdownOption<T>>

possibleValuesState

val possibleValuesState: State<List<DropdownOption<T>>>

val presentation: SelectionPresentation

val rules: List<ValidationRule.Field<T>>

val selectedOption: State<DropdownOption<T>?>

open val submittedValue: Any?

Value contributed by this field to Form.allValues.

val tag: String?

validationOption

var validationOption: ValidationOption

var value: T?

val valueState: State<T?>

Functions

fun addRule(rule: ValidationRule.Field<T>)

clearValidationErrors

fun clearValidationErrors(triggerSource: ValidationTriggerSource)

evaluateCustomCondition

open fun evaluateCustomCondition()

evaluateEnabled

open override fun evaluateEnabled()

evaluateVisibility

open override fun evaluateVisibility()

onParentValidationChanged

open override fun onParentValidationChanged(errors: List<ValidationError>)

open override fun onValueChanged()

presentationFor

fun presentationFor(ios: Boolean): SelectionPresentation

fun remove(reload: Boolean = false)

fun removeRule(rule: ValidationRule.Field<T>)

fun selectOption(id: String?): Boolean

User selection; stale options and unavailable fields cannot mutate the form.

open override fun setBaseValue(value: Any?)

Programmatic assignment accepts only a current value; null always resets the field.

setValidationErrors

fun setValidationErrors(errors: List<ValidationError>, triggerSource: ValidationTriggerSource)

open override fun validate(triggerSource: ValidationTriggerSource, includeHidden: Boolean): ImmutableList<ValidationError>