0.1.1 • Published 3 years ago

@7factor/form-builder v0.1.1

Weekly downloads
5
License
ISC
Repository
github
Last release
3 years ago

7Factor Form-Builder Forms on Web

This library is intended to help you render custom Form-Builder forms in your react application.

Installation

yarn add @7factor/form-builder

Usage

import Form from "@7factor/form-builder-web"

return () => <Form 
        id="THE_ID_OF_YOUR_FORM"
        initialValues={{
            name: "value"
        }}
        disableFields={['id']}
        hideSubmit={false}
        onSubmit={ (values) => /* Do Something */ }
    />
PropertyDefault ValueRequired ?Function
idnoneyesThis is the id of the form to render, found in your form URL
initialValuesnonenoUse this to default any values in your form.
disableFieldsnonenoUse this array of strings, the name of each field, to prevent the user from editing them.
hideSubmitfalsenoOptionally hide the submit button for readonly viewing.
onSubmitnonenoUse this to prevent the submission on Form-Builder and instead handle it locally within your applicatoin

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT