piral-ext/README.md

Set of standard plugins with component definitions for extending piral-core.

[![Piral Logo](https://github.com/smapiot/piral/raw/main/docs/assets/logo.png)](https://piral.io)

# [Piral Ext](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/piral-ext.svg?style=flat)](https://www.npmjs.com/package/piral-ext) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io) [![Community Chat](https://dcbadge.vercel.app/api/server/kKJ2FZmK8t?style=flat)](https://discord.gg/kKJ2FZmK8t)

This is a package that consists of a set of standard plugins. The package only has a peer dependency to `piral-core`.

What `piral-ext` brings to the table is a set of Pilet API extensions that is used by `piral`. The set includes things like a dashboard component aggregating tiles, menu and notifications, or a simple translation system.

## Included Plugins

- `piral-dashboard`: Dashboard presentation
- `piral-feeds`: Data feed connectivity
- `piral-menu`: Menu integration
- `piral-modals`: Modal dialogs
- `piral-notifications`: Notification support
- `piral-translate`: Simple localization

For more details on the individual libraries please visit their own dedicated README.

## Documentation

For details on the provided API check out the [documentation of the individual plugins at the Piral website](https://docs.piral.io) or [on GitHub](https://github.com/smapiot/piral/tree/main/docs).

## License

Piral is released using the MIT license. For more information see the [license file](./LICENSE).