piral-notifications

Piral Notifications ·

This is an extension library that only has a peer dependency to piral-core. What piral-notifications brings to the table is a set of API extensions that can be used with piral or piral-core to show notifications triggered by pilets in your Piral instance.

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 createNotificationsApi from the piral-notifications package.

import { createNotificationsApi } from 'piral-notifications';

The integration looks like:

renderInstance({
  // important part
  extendApi: extendApis([createNotificationsApi]),
  // ...
});

License

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