Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Form<T, Model, S, SS, S>

Type parameters

  • T: Record<string, Model>

  • Model: BasicModel<unknown>

  • S

  • SS

  • S

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns Form

  • Parameters

    • props: IFormProps<T, Model>
    • Optional context: any

    Returns Form

Properties

Private children

children: IFormChild[] = []

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

formRef

formRef: RefObject<HTMLFormElement> = React.createRef<HTMLFormElement>()

Private getContext

getContext: makeContext = memorize(makeContext)

props

props: Readonly<IFormProps<T, Model>> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<S>

Private subscription

subscription: Subscription | null = null

Static CombineErrors

CombineErrors: CombineErrors = CombineErrors

Static FieldSetValue

FieldSetValue: FieldSetValue = FieldSetValue

Static FieldValue

FieldValue: FieldValue = FieldValue

Static TouchWhen

TouchWhen: TouchWhen = TouchWhen

Static ValidateOccasion

ValidateOccasion: ValidateOccasion = ValidateOccasion

Static ValidateOption

ValidateOption: ValidateOption = ValidateOption

Static array

array: array = array

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Static createAsyncValidator

createAsyncValidator: createAsyncValidator = createAsyncValidator

Static displayName

displayName: string = "ZentForm"

Static field

field: field = field

Static form

form: form = form

Static isAsyncValidator

isAsyncValidator: isAsyncValidator = isAsyncValidator

Static set

set: set = set

Static useField

useField: useField = useField

Static useFieldArray

useFieldArray: useFieldArray = useFieldArray

Static useFieldArrayValue

useFieldArrayValue: useFieldArrayValue = useFieldArrayValue

Static useFieldSet

useFieldSet: useFieldSet = useFieldSet

Static useForm

useForm: useForm = useForm

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IFormProps<T, Model>>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IFormProps<T, Model>>, nextState: Readonly<S>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(prevProps: IFormProps<T, Model>): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IFormProps<T, Model>>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IFormProps<T, Model>>, nextState: Readonly<S>, nextContext: any): void

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IFormProps<T, Model>>, prevState: Readonly<S>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<IFormProps<T, Model>>
    • prevState: Readonly<S>

    Returns SS | null

Private listenEvents

  • listenEvents(): void

Private onKeyDown

  • onKeyDown(e: KeyboardEvent<HTMLFormElement>): void

Private onSubmit

  • onSubmit(e: FormEvent<HTMLFormElement>): void

Private removeEventListeners

  • removeEventListeners(): void

render

  • render(): Element

scrollToFirstError

  • scrollToFirstError(): void

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof S

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IFormProps<T, Model>>, nextState: Readonly<S>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<IFormProps<T, Model>>
    • nextState: Readonly<S>
    • nextContext: any

    Returns boolean

Private submit

  • submit(e?: SyntheticEvent): Promise<void>

Private submitListener

  • submitListener(e?: SyntheticEvent): void

Generated using TypeDoc