Package com.github.k0shk0sh.compose.easyforms

Types

CardValidationType

object CardValidationType : EasyFormsValidationType

Cards validation with regex that support most common cards.

EasyForms

class EasyForms

A class that manage all your forms states.

EasyFormsCheckboxState

data class EasyFormsCheckboxState(defaultValue: Boolean, isRequired: Boolean) : EasyFormsState<State<Boolean>, Boolean>

EasyFormsErrorState

enum EasyFormsErrorState : Enum<EasyFormsErrorState>

Represent the three different states a field could have.

EasyFormsRadioButtonState

data class EasyFormsRadioButtonState(defaultValue: Boolean, isRequired: Boolean) : EasyFormsState<State<Boolean>, Nothing>

EasyFormsRangeSliderState

data class EasyFormsRangeSliderState(defaultValue: ClosedFloatingPointRange<Float>, isRequired: Boolean) : EasyFormsState<State<ClosedFloatingPointRange<Float>>, ClosedFloatingPointRange<Float>>

EasyFormsResult

sealed class EasyFormsResult

A class that represent must of the Compose form fields result states.

EasyFormsSliderState

data class EasyFormsSliderState(defaultValue: Float, isRequired: Boolean) : EasyFormsState<State<Float>, Float>

EasyFormsState

abstract class EasyFormsState<ST, CT>

EasyFormsSwitchState

data class EasyFormsSwitchState(defaultValue: Boolean, isRequired: Boolean) : EasyFormsState<State<Boolean>, Boolean>

EasyFormsTextFieldState

data class EasyFormsTextFieldState(defaultValue: String, easyFormsValidationType: EasyFormsValidationType) : EasyFormsState<State<TextFieldValue>, TextFieldValue>

EasyFormsTriCheckboxState

data class EasyFormsTriCheckboxState(defaultValue: ToggleableState, isRequired: Boolean) : EasyFormsState<State<ToggleableState>, Nothing>

EasyFormsValidationType

abstract class EasyFormsValidationType(minLength: Int, maxLength: Int, regex: String?)

EmailValidationType

object EmailValidationType : EasyFormsValidationType

Email validation using @see androidx.core.util.PatternsCompat.EMAIL_ADDRESS

NameValidationType

object NameValidationType : EasyFormsValidationType

Name validation

Name must contain at least one char.
Name must contain at most 20 chars.

PasswordValidationType

object PasswordValidationType : EasyFormsValidationType

Password validation using below criteria:

Password must contain at least one digit 0-9.
Password must contain at least one lowercase Latin character a-z.
Password must contain at least one uppercase Latin character A-Z.
Password must contain at least one special character like ! @ # & ( ).
Password must contain a length of at least 8 characters and a maximum of 20 characters.

PhoneNumberValidationType

object PhoneNumberValidationType : EasyFormsValidationType

Phone validation using below criteria:

Number must contain at least 7 digits.
Number must contain at most 19 digits.
Number can start with +.
Number can contains whitespaces in between.
Number can contains () as second part of the number.
Number can contains - as a separator.

UrlValidationType

object UrlValidationType : EasyFormsValidationType

Url validation using @see androidx.core.util.PatternsCompat.WEB_URL

Functions

BuildEasyForms

fun BuildEasyForms(key: Any = EASY_FORMS_KEY, saveableStateRegistry: SaveableStateRegistry? = null, content: @Composable() (easyForms: EasyForms) -> Unit)

Please be aware that BuildEasyForms should be called as parent of your forms UI tree and not as a top parent of your whole tree.