import Form from 'prg-form/src/Form.jsx'

public class | source

Form

Extends:

Component → Form

Basic form element

PropTypes

property	type	type signature	description
`className`	`string`		form class name
`values`	`object`		values to fill the form
`onChange`	`function`	`(inputName, input) => {}`)	form change handler
`onSubmit`	`function`	`(values) => {}`	fired after form submit

Example:

import { Form, Input } from 'prg-form';

function MyForm ({ values }) {
    return (
        <Form
            className="special-class"
            onSubmit={(values, form) => console.log(values)}
            onChange={(input) => console.log(input.name, input.getValue())}
            values={values}
        >
             <Input type="email" name="inputName" label="Input Label" />
        </Form>
    );
}

Method Summary

Public Methods
public	getValues(): Object Returns current form data
public	reset(data: Object) Resets form without trigging the onChange method
public	setErrors(errorList: Object) Sets errors to form.

Public Methods

public getValues(): Object source

Returns current form data

Return:

Object

public reset(data: Object) source

Resets form without trigging the onChange method

Params:

Name	Type	Attribute	Description
data	Object	optional

Example:

// makes form empty and resets all errors
form.reset();

// sets data and resets all errors without trigging the validation
form.reset();

public setErrors(errorList: Object) source

Sets errors to form. Use empty object to remove all errors

Params:

Name	Type	Attribute	Description
errorList	Object

Example:

// set signle error to inputName
form.setErrors({ inputName: 'Error text' });