Options
All
  • Public
  • Public/Protected
  • All
Menu

@habx/lib-form-helper - v8.1.0

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

FieldErrorBehavior

FieldErrorBehavior: "always" | "never" | "dirty" | "touched"

Describes when the error should be displayed

FormatterCallback

FormatterCallback<InputValue, Props, FieldValue>: FieldTransform<FieldValue, InputValue, Props>

Type parameters

  • InputValue

  • Props

  • FieldValue = any

ParserCallback

ParserCallback<InputValue, Props, FieldValue>: FieldTransform<InputValue, FieldValue, Props>

Type parameters

  • InputValue

  • Props

  • FieldValue = any

ValidationCallback

ValidationCallback<FieldValue, Props>: (value: FieldValue | undefined, allValues: any, meta: FieldMetaState<FieldValue>, props: Props) => string | undefined | Promise<string | undefined>

Type parameters

  • FieldValue

  • Props

Type declaration

    • (value: FieldValue | undefined, allValues: any, meta: FieldMetaState<FieldValue>, props: Props): string | undefined | Promise<string | undefined>

    • Parameters

      • value: FieldValue | undefined
      • allValues: any
      • meta: FieldMetaState<FieldValue>
      • props: Props

      Returns string | undefined | Promise<string | undefined>

Variables

Const CodeEditorJSON

CodeEditorJSON: LazyExoticComponent<NamedExoticComponent<CodeEditorJSONProps>> = BaseCodeEditorJSON

Const FieldError

FieldError: React.FunctionComponent<FieldErrorProps> = ...

Const FormContext

FormContext: Context<FormContextProps> = ...

Const FormSection

FormSection: React.FunctionComponent<FormSectionProps> = ...

Const FormSectionWatcher

FormSectionWatcher: React.FunctionComponent<FormSectionWatcherProps> = ...

Functions

Form

  • Form<Values, InitialValues>(__namedParameters: FormProps<Values, InitialValues>): Element

  • Type parameters

    • Values

    • InitialValues = Partial<Values>

    Parameters

    • __namedParameters: FormProps<Values, InitialValues>

    Returns Element

asyncDebounce

  • asyncDebounce<D, Value>(func: (value: Value, ...params: any[]) => undefined | D | Promise<D>, time: number): (value: Value, ...params: any[]) => undefined | D | Promise<undefined | D>

  • Type parameters

    • D

    • Value

    Parameters

    • func: (value: Value, ...params: any[]) => undefined | D | Promise<D>
        • (value: Value, ...params: any[]): undefined | D | Promise<D>

        • Parameters

          • value: Value
          • Rest ...params: any[]

          Returns undefined | D | Promise<D>

    • time: number

    Returns (value: Value, ...params: any[]) => undefined | D | Promise<undefined | D>

      • (value: Value, ...params: any[]): undefined | D | Promise<undefined | D>

      • Parameters

        • value: Value
        • Rest ...params: any[]

        Returns undefined | D | Promise<undefined | D>

joinNames

  • joinNames(path: string, newName: undefined | string | number): string

  • Parameters

    • path: string
    • newName: undefined | string | number

    Returns string

useFinalFormField

  • useFinalFormField<FieldValue, Props>(baseName: string, props: undefined | Props, inputConfig?: InputHookConfig): UseFinalFormFieldValue<FieldValue>

useFormAutoSubmitDecorator

  • useFormAutoSubmitDecorator<Params>(config?: UseFormAutoSubmitDecoratorConfig): Decorator<Params, Partial<Params>>

useFormKeyboardSubmitDecorator

  • useFormKeyboardSubmitDecorator<Params>(): Decorator<Params, Partial<Params>>

useFormattedNumber

  • useFormattedNumber(__namedParameters?: Options): readonly [string, (input?: null | string | number) => void]

usePreventLeaveDecorator

useStatus

  • useStatus(): { form: FormContextProps; section: SectionContextProps }

  • Returns { form: FormContextProps; section: SectionContextProps }

    • form: FormContextProps
    • section: SectionContextProps

withFinalForm

  • withFinalForm<InputValue, AdditionalProps, Element, FieldValue>(options?: WithFinalFormOptions<InputValue, FieldValue, any>): <Props>(WrappedComponent: ComponentType<Props>) => ForwardRefExoticComponent<PropsWithoutRef<ComponentProps> & RefAttributes<Element>>

  • Type parameters

    • InputValue: unknown

    • AdditionalProps: object = {}

    • Element: HTMLElement = HTMLDivElement

    • FieldValue = any

    Parameters

    Returns <Props>(WrappedComponent: ComponentType<Props>) => ForwardRefExoticComponent<PropsWithoutRef<ComponentProps> & RefAttributes<Element>>

      • <Props>(WrappedComponent: ComponentType<Props>): ForwardRefExoticComponent<PropsWithoutRef<ComponentProps> & RefAttributes<Element>>

      • Type parameters

        • Props: object

        Parameters

        • WrappedComponent: ComponentType<Props>

        Returns ForwardRefExoticComponent<PropsWithoutRef<ComponentProps> & RefAttributes<Element>>