@dotconnor/grommet
Version:
focus on the essential experience
23 lines • 2.12 kB
JavaScript
import { describe, PropTypes } from 'react-desc';
import { getAvailableAtBadge } from '../../utils/mixins';
export var doc = function doc(Form) {
var DocumentedForm = describe(Form).availableAt(getAvailableAtBadge('Form', 'Input')).description('A form that manages state for its fields.').usage("import { Form } from 'grommet';\n<Form />").intrinsicElement('form');
DocumentedForm.propTypes = {
errors: PropTypes.shape({}).description("An object representing any errors in the data. Their keys should\n match the keys in the value object.").defaultValue({}),
infos: PropTypes.shape({}).description("An object representing any information details in the data.\n Their keys should match the keys in the value object.").defaultValue({}),
messages: PropTypes.shape({
invalid: PropTypes.string,
required: PropTypes.string
}).description('Custom validation messages.').defaultValue({
invalid: 'invalid',
required: 'required'
}),
onChange: PropTypes.func.description("Function that will be called when any fields are updated.\n The fields must have a non-null `name` property assigned."),
onSubmit: PropTypes.func.description("Function that will be called when the form is submitted. The\n single argument is an event containing the latest value object\n via `event.value` and an object indicating which fields were\n touched via `event.touched`."),
onReset: PropTypes.func.description("Function that will be called when the form is reset. The\n single argument is the event provided by react."),
onValidate: PropTypes.func.description("Function that will be called when the form is validated. The\n single argument is an event containing the latest error object\n via `validationResults.errors` and info object via \n `validationResults.infos`."),
validate: PropTypes.oneOf(['blur', 'submit']).description('When to perform validation').defaultValue('submit'),
value: PropTypes.shape({}).description('An object representing all of the data in the form.').defaultValue({})
};
return DocumentedForm;
};