Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

  • SS

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns Form

  • Parameters

    Returns Form

Properties

context

context: any

props

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

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

Methods

Input

  • Input<A, U, S, K, I>(props: InputProps<T, A, U, S, K, I>): Element
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    • I: InputType

    Parameters

    Returns Element

InputFormGroup

Select

  • Select<A, U, S, K>(props: SelectProps<T, A, U, S, K>): Element
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns Element

SelectFormGroup

  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns Element

TextArea

  • TextArea<A, U, S, K>(props: TextAreaProps<T, A, U, S, K>): Element
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns Element

TextAreaFormGroup

  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns Element

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<FormProps<T>>, nextState: Readonly<FormState>, 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

Optional componentDidMount

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

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<FormProps<T>>, prevState: Readonly<FormState>, 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

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

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

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<FormProps<T>>, nextState: Readonly<FormState>, nextContext: any): void

dirty

  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns any

emitChange

  • emitChange<A, U, S, K>(event: FormEventType<T, A, U, S, K>): void
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns void

forceUpdate

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

    • Optional callBack: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

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

getValidationForField

  • getValidationForField(lens: any): null | object & object & object
  • Parameters

    • lens: any

    Returns null | object & object & object

invalid

  • invalid<A, U, S, K>(path: LensPathType<T, A, U, S, K>): null | object & object & object
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns null | object & object & object

pristine

  • pristine<A, U, S, K>(path: LensPathType<T, A, U, S, K>): boolean
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns boolean

render

  • render(): Element
  • Returns Element

setState

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

    • K: keyof FormState

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

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

touched

  • touched<A, U, S, K>(path: LensPathType<T, A, U, S, K>): any
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns any

untouched

  • untouched<A, U, S, K>(path: LensPathType<T, A, U, S, K>): boolean
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns boolean

valid

  • valid<A, U, S, K>(path: LensPathType<T, A, U, S, K>): boolean
  • Type parameters

    • A: keyof T

    • U: keyof T[A]

    • S: keyof T[A][U]

    • K: keyof T[A][U][S]

    Parameters

    Returns boolean

Object literals

state

state: object

fields

fields: object

Type declaration

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc