Options
All
  • Public
  • Public/Protected
  • All
Menu

formalizer

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

ErrorMessageFunction

ErrorMessageFunction<T>: (value: string, formData: T) => string

Type parameters

  • T

Type declaration

    • (value: string, formData: T): string

    • Parameters

      • value: string
      • formData: T

      Returns string

SupportedInputTypes

SupportedInputTypes: "text" | "checkbox" | "radio" | "button"

ValidationErrorCleaner

ValidationErrorCleaner: (name: string, reportMultipleErrors: boolean, ruleKey?: string) => void

Type declaration

    • (name: string, reportMultipleErrors: boolean, ruleKey?: string): void

    • Parameters

      • name: string
      • reportMultipleErrors: boolean
      • Optional ruleKey: string

      Returns void

ValidationErrorReporter

ValidationErrorReporter: (name: string, reportMultipleErrors: boolean, ruleKey: string, errorMessage: string) => void

Type declaration

    • (name: string, reportMultipleErrors: boolean, ruleKey: string, errorMessage: string): void

    • Parameters

      • name: string
      • reportMultipleErrors: boolean
      • ruleKey: string
      • errorMessage: string

      Returns void

ValidatorFunction

ValidatorFunction<T>: (value: any, options: ValidatorFunctionOptions<T>) => string | boolean | undefined

Type parameters

  • T

Type declaration

Variables

DEFAULT_VALIDATION_ERROR_MESSAGE

DEFAULT_VALIDATION_ERROR_MESSAGE: "This field is not valid." = 'This field is not valid.'

FORMALIZER_ID_DATA_ATTRIBUTE

FORMALIZER_ID_DATA_ATTRIBUTE: "data-formalizer-id" = 'data-formalizer-id'

FormalizerSettings

FormalizerSettings: FormalizerSettingsType = ...

GlobalValidators

GlobalValidators: {} = ...

Type declaration

Functions

Const isInputValidationConfig

Const mustMatch

setupForMaterialUI

  • setupForMaterialUI(): void

Const useFormInput

Const useFormalizer

  • useFormalizer<T, N>(submitHandler?: FormSubmitHandler<T>, initialValues?: N, settings?: FormalizerSettingsType): Formalizer<T>

  • Type parameters

    • T: {}

    • N: Partial<T>

    Parameters

    • Optional submitHandler: FormSubmitHandler<T>
    • Optional initialValues: N
    • Optional settings: FormalizerSettingsType

    Returns Formalizer<T>

Const validate

Generated using TypeDoc