Skip to content

Latest commit

 

History

History
137 lines (99 loc) · 3.38 KB

DOCUMENTATION.md

File metadata and controls

137 lines (99 loc) · 3.38 KB

API Docs

Constants

DefaultFormSubscription

DefaultFormSubstription

All enabled form subscription options.

DefaultFieldSubscription

DefaultFieldSubstription

All enabled field subscription options.

TextInputTransform

Text input transform.

Transforms a non-empty input value.

Functions

fieldInputProp(state, transformer)FieldProp

Extract the field props to be used in the field input.

formStateErrors(state)

Collect all form errors from validation error and submission error.

useFieldState(param)

Create a reactive field state object with extended functionality.

useFormState(input)

Create a bind object for the form state.

getStringFromInput(ev)

Extract a string value of a HTMLElement from a InputEvent.

useForm(config)

Create a form controller.

DefaultFormSubscription

DefaultFormSubstription

All enabled form subscription options.

Kind: global constant

DefaultFieldSubscription

DefaultFieldSubstription

All enabled field subscription options.

Kind: global constant

TextInputTransform

Text input transform.

Transforms a non-empty input value.

Kind: global constant

fieldInputProp(state, transformer) ⇒ FieldProp

Extract the field props to be used in the field input.

Kind: global function
Returns: FieldProp - field props

Param Description
state field state
transformer input transform

formStateErrors(state) ⇒

Collect all form errors from validation error and submission error.

Kind: global function
Returns: All form errors.

Param Description
state Form state.

useFieldState(param) ⇒

Create a reactive field state object with extended functionality.

Kind: global function
Returns: Reactive binding object.

Param Description
param Field bindind input.

useFormState(input)

Create a bind object for the form state.

Kind: global function

Param Description
input Form bind input.

getStringFromInput(ev)

Extract a string value of a HTMLElement from a InputEvent.

Kind: global function

Param Description
ev InputEvent

useForm(config) ⇒

Create a form controller.

Kind: global function
Returns: Reactive form api.

Param Description
config Form api configuration.