diff --git a/functions/useForm.html b/functions/useForm.html index e9cfe78..dd6a9a4 100644 --- a/functions/useForm.html +++ b/functions/useForm.html @@ -44,7 +44,7 @@

Returns UseFormReturn<T>

+
  • Defined in use-form.ts:22
    • diff --git a/index.html b/index.html index 00743e7..92a55c7 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,12 @@

    FormPlex - React

     -

    Full documentation

    +

    + +

    GitHub | +Documentation | +NPM | casraf.dev

    +

    Handle forms in your React apps with incredible ease.

    FormPlex lets you use React forms without the hassle; including easy validations, predictable and diff --git a/interfaces/ErrorMessage.html b/interfaces/ErrorMessage.html index 45f007d..fac2f51 100644 --- a/interfaces/ErrorMessage.html +++ b/interfaces/ErrorMessage.html @@ -33,7 +33,7 @@ under the field's key. Otherwise, it is undefined.

    • ErrorMessage
    +
  • Defined in types.ts:239
    • @@ -59,14 +59,14 @@ under the field's key. Otherwise, it is undefined.

    +
  • Defined in types.ts:248

    • message

    message: string

    The error message for the field.

    +
  • Defined in types.ts:253
    • diff --git a/interfaces/ErrorStrings.html b/interfaces/ErrorStrings.html index d8170ca..5371222 100644 --- a/interfaces/ErrorStrings.html +++ b/interfaces/ErrorStrings.html @@ -28,7 +28,7 @@
    • ErrorStrings
    +
  • Defined in types.ts:295
    • @@ -54,7 +54,7 @@

    See

    FieldOptions.maxLength for defining a maximum length for the field

    +
  • Defined in types.ts:331

    • minLength

    minLength: string | ((length: number) => string)
    @@ -67,7 +67,7 @@

    See

    FieldOptions.minLength for defining a minimum length for the field

    +
  • Defined in types.ts:317

    • required

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

    See

    FieldOptions.required for defining a field as required

    +
  • Defined in types.ts:303
    • diff --git a/interfaces/FieldOptions.html b/interfaces/FieldOptions.html index 89a4311..1cbe80c 100644 --- a/interfaces/FieldOptions.html +++ b/interfaces/FieldOptions.html @@ -30,7 +30,7 @@
    • FieldOptions
    +
  • Defined in types.ts:125
    • @@ -65,7 +65,7 @@
    +
  • Defined in types.ts:174

    • Optional maxLength

    maxLength?: number
    @@ -75,7 +75,7 @@ be provided in UseFormReturn.errors.

    To provide a custom error message, use errorMessages.

    +
  • Defined in types.ts:154

    • Optional minLength

    minLength?: number
    @@ -85,7 +85,7 @@ be provided in UseFormReturn.errors.

    To provide a custom error message, use errorMessages.

    +
  • Defined in types.ts:144

    • Optional onBlur

    onBlur?: ((event: ChangeEvent, value: T[K]) => void)
    @@ -113,7 +113,7 @@ be provided in UseFormReturn.errors.

    Returns void

    +
  • Defined in types.ts:225

    • Optional onChange

    onChange?: ((event: ChangeEvent, value: T[K]) => void)
    @@ -141,7 +141,7 @@ be provided in UseFormReturn.errors.

    Returns void

    +
  • Defined in types.ts:213

    • Optional parse

    parse?: ((value: string) => T[K])
    @@ -168,7 +168,7 @@ placed here.

    Returns T[K]

    +
  • Defined in types.ts:201

    • Optional pattern

    pattern?: string | RegExp
    @@ -177,7 +177,7 @@ placed here.

    error for a pattern, use validate instead.

    +
  • Defined in types.ts:162

    • Optional required

    required?: boolean
    @@ -187,7 +187,7 @@ error for a pattern, use validate inste

    To provide a custom error message, use errorMessages.

    +
  • Defined in types.ts:134

    • Optional validate

    validate?: ((value: T[K]) => string)
    @@ -219,7 +219,7 @@ error for a pattern, use validate inste

    Returns string

    +
  • Defined in types.ts:189
    • diff --git a/interfaces/UseFormOptions.html b/interfaces/UseFormOptions.html index 68d71f2..3f54ecf 100644 --- a/interfaces/UseFormOptions.html +++ b/interfaces/UseFormOptions.html @@ -30,7 +30,7 @@
    • UseFormOptions
    +
  • Defined in types.ts:6
    • @@ -57,7 +57,7 @@

    See

    validate for manual validation trigger

    +
  • Defined in types.ts:42

    • Optional errorMessages

    errorMessages?: Partial<ErrorStrings>
    @@ -73,7 +73,7 @@
    +
  • Defined in types.ts:27

    • Optional initialState

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

    +
  • Defined in types.ts:11

    • Optional onSubmit

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

    e: FormEvent<HTMLFormElement>

    Returns void

    +
  • Defined in types.ts:16
    • diff --git a/interfaces/UseFormReturn.html b/interfaces/UseFormReturn.html index 286fc9a..48396fb 100644 --- a/interfaces/UseFormReturn.html +++ b/interfaces/UseFormReturn.html @@ -28,7 +28,7 @@
    • UseFormReturn
    +
  • Defined in types.ts:48
    • @@ -61,7 +61,7 @@ Each property is the name of the field and the value is the error message, if an

    See

    ErrorMessage

    +
  • Defined in types.ts:70

    • field

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

    Returns FieldReturn<E>

    +
  • Defined in types.ts:60

    • handleSubmit

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

    Returns void

    +
  • Defined in types.ts:93

    • isValid

    isValid: boolean

    Indicates whether the form is valid.

    +
  • Defined in types.ts:85

    • rawState

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

    The current form data, before parsing.

    +
  • Defined in types.ts:80

    • setValue

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

    Returns void

    +
  • Defined in types.ts:110

    • setValues

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

    Returns void

    +
  • Defined in types.ts:101

    • state

    state: Partial<T>

    The current form data, after parsing.

    +
  • Defined in types.ts:75

    • Methods

    @@ -223,7 +223,7 @@ You should inject this into the form's onSubmit prop.

    Returns boolean

    +
  • Defined in types.ts:119