diff --git a/functions/useForm.html b/functions/useForm.html index 90cb319..b9c51d2 100644 --- a/functions/useForm.html +++ b/functions/useForm.html @@ -33,7 +33,7 @@
__namedParameters: UseFormOptions<T> = {}

Returns UseFormReturn<T>

+
  • Defined in use-form.ts:14
    • diff --git a/interfaces/ErrorMessage.html b/interfaces/ErrorMessage.html index a452eec..2ffdcd4 100644 --- a/interfaces/ErrorMessage.html +++ b/interfaces/ErrorMessage.html @@ -20,7 +20,7 @@
    • ErrorMessage
    +
  • Defined in types.ts:147
    • @@ -40,14 +40,14 @@ validate for custom validations

    +
  • Defined in types.ts:152

    • message

    message: string

    The error message for the field.

    +
  • Defined in types.ts:156
    • diff --git a/interfaces/ErrorStrings.html b/interfaces/ErrorStrings.html index b705356..b1270e3 100644 --- a/interfaces/ErrorStrings.html +++ b/interfaces/ErrorStrings.html @@ -23,7 +23,7 @@
    • ErrorStrings
    +
  • Defined in types.ts:192
    • @@ -48,7 +48,7 @@
    +
  • Defined in types.ts:220

    • minLength

    minLength: string | ((length: number) => string)
    @@ -59,7 +59,7 @@
    +
  • Defined in types.ts:209

    • pattern

    pattern: string | ((pattern: string | RegExp) => string)
    @@ -70,7 +70,7 @@
    +
  • Defined in types.ts:231

    • required

    required: string
    @@ -78,7 +78,7 @@

    Default: "Required"

    +
  • Defined in types.ts:198
    • diff --git a/interfaces/FieldOptions.html b/interfaces/FieldOptions.html index 3afab1a..f83a422 100644 --- a/interfaces/FieldOptions.html +++ b/interfaces/FieldOptions.html @@ -27,7 +27,7 @@
    • FieldOptions
    +
  • Defined in types.ts:83
    • @@ -52,7 +52,7 @@

    Map of custom error messages for the default validation methods.

    +
  • Defined in types.ts:119

    • Optional maxLength

    maxLength?: number
    @@ -61,7 +61,7 @@ and an error message will be provided in errors.

    +
  • Defined in types.ts:106

    • Optional minLength

    minLength?: number
    @@ -70,7 +70,7 @@ and an error message will be provided in errors.

    and an error message will be provided in errors.

    +
  • Defined in types.ts:98

    • Optional onChange

    onChange?: ((event: ChangeEvent, value: T[K]) => void)
    @@ -94,7 +94,7 @@ Use this callback instead, which acts right after the input's onChange
    value: T[K]

    Returns void

    +
  • Defined in types.ts:144

    • Optional parse

    parse?: ((value: string) => T[K])
    @@ -116,7 +116,7 @@ to be updated with the result of this function.

    value: string

    Returns T[K]

    +
  • Defined in types.ts:136

    • Optional pattern

    pattern?: string | RegExp
    @@ -125,7 +125,7 @@ to be updated with the result of this function.

    To cause a validation error for a pattern, use validate instead.

    +
  • Defined in types.ts:114

    • Optional required

    required?: boolean
    @@ -134,7 +134,7 @@ To cause a validation error for a pattern, use validate instead.

    errors    .

    +
  • Defined in types.ts:90

    • Optional validate

    validate?: ((value: T[K]) => string)
    @@ -156,7 +156,7 @@ To cause a validation error for a pattern, use validate instead.

    value: T[K]

    Returns string

    +
  • Defined in types.ts:128
    • diff --git a/interfaces/UseFormOptions.html b/interfaces/UseFormOptions.html index 68df57a..8168ea1 100644 --- a/interfaces/UseFormOptions.html +++ b/interfaces/UseFormOptions.html @@ -28,7 +28,7 @@
    • UseFormOptions
    +
  • Defined in types.ts:4
    • @@ -53,7 +53,7 @@

    never - Show validations after the user has submitted the form only, or on manual trigger.

    +
  • Defined in types.ts:33

    • Optional errorMessages

    errorMessages?: Partial<ErrorStrings>
    @@ -61,7 +61,7 @@

    See

    +
  • Defined in types.ts:20

    • Optional initialState

    initialState?: Partial<T>
    @@ -69,7 +69,7 @@ Any missing field will be empty.

    +
  • Defined in types.ts:9

    • Optional onSubmit

    onSubmit?: ((values: T, e: FormEvent<HTMLFormElement>) => void)
    @@ -91,7 +91,7 @@ Any missing field will be empty.

    e: FormEvent<HTMLFormElement>

    Returns void

    +
  • Defined in types.ts:14
    • diff --git a/interfaces/UseFormReturn.html b/interfaces/UseFormReturn.html index 60f4c8f..1d3631c 100644 --- a/interfaces/UseFormReturn.html +++ b/interfaces/UseFormReturn.html @@ -25,7 +25,7 @@
    • UseFormReturn
    +
  • Defined in types.ts:36
    • @@ -52,7 +52,7 @@ Each property is the name of the field and the value is the error message, if an

    If there is no error, the value will be undefined.

    +
  • Defined in types.ts:49

    • field

    field: (<K, E>(key: K, options?: FieldOptions<T, K>) => FieldReturn<E>)
    @@ -82,7 +82,7 @@ See each of the options for more information.

    Optional options: FieldOptions<T, K>

    Returns FieldReturn<E>

    +
  • Defined in types.ts:41

    • handleSubmit

    handleSubmit: ((e: FormEvent<HTMLFormElement>) => void)
    @@ -103,21 +103,21 @@ You should inject this into the form's onSubmit prop.

    e: FormEvent<HTMLFormElement>

    Returns void

    +
  • Defined in types.ts:70

    • isValid

    isValid: boolean

    Indicates whether the form is valid.

    +
  • Defined in types.ts:64

    • rawState

    rawState: Partial<Record<keyof T, string | number | string[]>>

    The current form data, before parsing.

    +
  • Defined in types.ts:59

    • setValue

    setValue: (<K>(key: K, value: T[K]) => void)
    @@ -144,7 +144,7 @@ You should inject this into the form's onSubmit prop.

    value: T[K]

    Returns void

    +
  • Defined in types.ts:80

    • setValues

    setValues: ((values: Partial<T>) => void)
    @@ -164,14 +164,14 @@ You should inject this into the form's onSubmit prop.

    values: Partial<T>

    Returns void

    +
  • Defined in types.ts:75

    • state

    state: Partial<T>

    The current form data, after parsing.

    +
  • Defined in types.ts:54
    • diff --git a/types/BlurEvent.html b/types/BlurEvent.html index b334a06..ccf43a3 100644 --- a/types/BlurEvent.html +++ b/types/BlurEvent.html @@ -17,7 +17,7 @@

    Type alias BlurEventInternal

    BlurEvent: ChangeEvent
    +
  • Defined in types.ts:187
    • diff --git a/types/ChangeEvent.html b/types/ChangeEvent.html index 3beae5b..b579c9f 100644 --- a/types/ChangeEvent.html +++ b/types/ChangeEvent.html @@ -22,7 +22,7 @@
  • target: any
    • +
  • Defined in types.ts:182
    • diff --git a/types/FieldReturn.html b/types/FieldReturn.html index 3799fb9..04693ef 100644 --- a/types/FieldReturn.html +++ b/types/FieldReturn.html @@ -63,7 +63,7 @@

    The value of the field.

    +
  • Defined in types.ts:161