Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Form<T, SS>

Form component controlls Fields and passes FormContext

Type parameters

  • T

  • SS

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

props

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

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<IFormState<T>>

Methods

Private callModelChange

componentDidUpdate

forceUpdate

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

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

    Returns void

Private handleChange

  • handleChange(field: keyof T, value: IFieldState<T[keyof T]>): void

Private handleReset

  • handleReset(): void

Private handleSubmit

  • handleSubmit(event: FormEvent<HTMLFormElement>): void
  • Handles form submitting and preventDefault if configure.submitting.preventDefault === true sets all Fields isChanged to false and isVisited to true and fires onSubmit from props

    Parameters

    • event: FormEvent<HTMLFormElement>

    Returns void

Private handleTransform

  • handleTransform(value: Partial<FormModel<T>>): void

render

  • render(): Element

setState

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

    • K: keyof IFormState<T>

    Parameters

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

    Returns void

shouldComponentUpdate

Static Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Static Optional UNSAFE_componentWillReceiveProps

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

Static Optional UNSAFE_componentWillUpdate

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

Static 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

Static Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a compoment is mounted. Setting state here will trigger re-rendering.

    Returns void

Static Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IFormProps<T>>, prevState: Readonly<IFormState<T>>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Static Optional componentWillMount

  • componentWillMount(): void

Static Optional componentWillReceiveProps

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

Static Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Static Optional componentWillUpdate

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

Static getDerivedStateFromProps

Static Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IFormProps<T>>, prevState: Readonly<IFormState<T>>): 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

    Returns SS | null

Static Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IFormProps<T>>, nextState: Readonly<IFormState<T>>, 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

    Returns boolean

Object literals

Static defaultProps

defaultProps: object

configure

configure: IFormConfiguration = defaultConfiguration

Generated using TypeDoc