feathery-react is a library you can use to render a Feathery form
anywhere in your React app or website.
It also supports granular customization of your form components, design,
- An active Feathery account, form, and API key
You can install
feathery-react directly from NPM.
Feathery React is compatible with React 16.8+ (the one with React Hooks).
The following is a React component that renders a Feathery form.
Make sure to replace
formKey with your relevant info.
Async function that initializes the Feathery library to the correct auth and user info. This is necessary before using the rest of the API and can be called multiple times, although it will register as a no-op after the first call.
|Admin or user API key to authorize the client to communicate with Feathery servers. If it's a user API key, no need to pass |
|Configuration options for your Feathery forms|
|Unique ID of the user who is accessing Feathery. This can be anything as long as it's unique per user. If not specified, Feathery autogenerates the user ID.|
|Array of IDs corresponding to forms that you want to preload at initialization. This can improve form load performance. The |
|Defaults to |
|The user's authentication token. Setting this denotes the user as |
Initialize this component in your React app at the location where
you want a Feathery form to appear. It renders an HTML
|Unique ID of your Feathery form to display. It can be found on your dashboard.|
|Callback function upon successful step submission attempt. Full reference|
|Callback function upon loading of each form step. Full reference|
|Callback function upon a field value changing. Full reference|
|Initial form field values of the shape |
|Custom components that you want to render in your form. Full reference|
|Your custom CSS class(es) to associate with your form element.|
|Your custom inline CSS styling to associate with your form element.|