This is a plugin that only has a peer dependency to
piral-forms brings to the table is a set of Pilet API extensions that can be used with
piral-core for exposing enhanced form capabilities.
By default, these API extensions are not integrated in
piral, so you'd need to add them to your Piral instance.
The following functions are brought to the Pilet API.
Creates a new form container, which is an abstraction over a state container driven by the typical lifecycle of an input form.
Returns a higher-order component for providing the form-related props such as
::: summary: For pilet authors
You can use the
createForm function from the Pilet API to create a global state container managed form inside the Piral instance.
createForm returns a higher-order component that injects new props from the
FormProps<TFormData> interface into the component. These props contain among others a
formData record and a
::: summary: For Piral instance developers
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import
createFormsApi from the
The integration looks like:
There are no options available.
Piral is released using the MIT license. For more information see the license file.