piral-modals

Piral Modals ·

This is an extension library that only has a peer dependency to piral-core. What piral-modals brings to the table is a set of API extensions that can be used with piral or piral-core to easily trigger the display of modal dialogs from pilets.

Documentation

For details on the provided API check out the documentation at the Piral website or on GitHub.

Setup and Bootstrapping

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 createModalsApi from the piral-modals package.

import { createModalsApi } from 'piral-modals';

The integration looks like:

const instance = createInstance({
  // important part
  extendApi: [createModalsApi()],
  // ...
});

Via the options the globally available dialogs can be defined.

For example:

const instance = createInstance({
  // important part
  extendApi: [createModalsApi({
    dialogs: [
      {
        name: 'userinfo',
        component: UserInfoModal,
      },
    ],
  })],
  // ...
});

License

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