inputforms/pro.respawn.kmmutils.inputforms/Input

Input

sealed interface Input

A user input. An input can have 3 states:

Invalid: input contains validation errors listed in the Input.Invalid.errors field.
Valid: an input that has been validated and is considered valid
Empty: an input that has either a default value, an empty value, or has never been validated. How you want to handle Empty values depends on the business logic of your app.

Inheritors

Invalid

Empty

Valid

Types

Companion

object Companion

Empty

@JvmInline

value class Empty : Input

An input that has either a default value, an empty value, or has never been validated. How you want to handle Empty values depends on the business logic of your app.

Invalid

data class Invalid : Input

A value that signifies an invalid input

Valid

@JvmInline

value class Valid : Input

A valid input.

Properties

isEmpty

val Input.isEmpty: Boolean

Whether this is Input.Empty

isEmptyValue

val Input.isEmptyValue: Boolean

Whether the actual string of this Input is blank

isInvalid

val Input.isInvalid: Boolean

Whether this is Input.Invalid

isValid

val Input.isValid: Boolean

Whether this is Input.Valid

isValidOrEmpty

val Input.isValidOrEmpty: Boolean

Whether this Input is valid or empty

value

abstract val value: String

A current string value that the input holds

Functions

copy

open fun copy(value: String = this.value): Input

Copy the input. Type and errors are preserved

mustMatch

infix fun Input.mustMatch(other: Input): Input

Applies an additional Rules.Equals to this input, then appends the result of the validation to other validation errors present, if any. Allows to create an Input that must always match some other one Don't forget to run the validation on both the dependent and the original inputs when any of them changes.

orEmpty

fun Input.orEmpty(): String

Returns Input.value if it is valid, otherwise an empty string

orNull

fun Input.orNull(): String?

Returns Input.value if it is valid, otherwise null

validate

fun Input.validate(form: Form): Input

Validate this Input using a given form.

fun Input.validate(rule: Rule): Input

Validate this Input using the given rule. Previous errors are preserved.

valueIfValid

fun Input.valueIfValid(): String?

Returns null if this Input is not valid, otherwise returns Input.value