Documents / @faasjs/react / Form

Function: Form()

Form<Values, FormElements, Rules>(__namedParameters): Element

FormContainer component is a wrapper that provides context and state management for form elements. It initializes form states such as values, errors, submitting status, elements, language, and rules.

Type Parameters

Values

Values extends Record<string, any> = Record<string, any>

The type of form values, defaults to Record<string, any>.

FormElements

FormElements extends FormElementTypes = FormElementTypes

The type of form elements, defaults to FormElementTypes.

Rules

Rules extends FormRules = FormRules

The type of form rules, defaults to FormDefaultRules.

Parameters

__namedParameters

FormProps<Values, FormElements, Rules>

Returns

Element

The FormContainer component.

Example

import { Form } from '@faasjs/react'

function MyForm() {
  return <Form
    items={[
      { name: 'name' },
    ]}
  />
}