Nautical Poseidon Mythology
Miss any of our Open RFC calls?Watch the recordings here! »


0.12.1 • Public • Published

Piral Logo

Piral Forms · GitHub License npm version tested with jest Gitter Chat

This is a plugin that only has a peer dependency to piral-core. What piral-forms brings to the table is a set of Pilet API extensions that can be used with piral or 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 error, submitting, changed, formData, setFormData(), submit(), reset(), or changeForm().


::: 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.

Example use:

import { PiletApi } from '<name-of-piral-instance>';
import { MyPage } from './MyPage';
export function setup(piral: PiletApi) {
  const withSimpleForm = piral.createForm({
    message: `Really lose the data?`,
    emptyData: {
      firstName: '',
      lastName: '',
    onSubmit(data) {
      // return promise with data
  piral.registerPage('/sample-form', withSimpleForm(MyPage));

Calling 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 submit function.


::: 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 piral-forms package.

import { createFormsApi } from 'piral-forms';

The integration looks like:

const instance = createInstance({
  // important part
  plugins: [createFormsApi()],
  // ...

There are no options available.



Piral is released using the MIT license. For more information see the license file.


npm i piral-forms

DownloadsWeekly Downloads






Unpacked Size

65.2 kB

Total Files



Last publish


  • avatar