piral-notifications
Advanced tools
Comparing version 0.10.0-pre.846 to 0.10.0-pre.853
{ | ||
"name": "piral-notifications", | ||
"version": "0.10.0-pre.846", | ||
"version": "0.10.0-pre.853", | ||
"description": "Plugin for triggering notifications in Piral.", | ||
@@ -39,3 +39,3 @@ "keywords": [ | ||
"devDependencies": { | ||
"piral-core": "^0.10.0-pre.846" | ||
"piral-core": "^0.10.0-pre.853" | ||
}, | ||
@@ -45,3 +45,3 @@ "peerDependencies": { | ||
}, | ||
"gitHead": "bf161f59f5b0b218f7443a4cf61534edd2aef929" | ||
"gitHead": "840155ef91a8f43f65ded5e18985ad25074bdc63" | ||
} |
@@ -15,4 +15,24 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io) | ||
## Usage | ||
> For authors of pilets | ||
You can use the `showNotification` function from the Pilet API to show a notification within the Piral instance. | ||
Example use: | ||
```ts | ||
import { PiletApi } from '<name-of-piral-instance>'; | ||
export function setup(piral: PiletApi) { | ||
piral.showNotification('Hello from my sample pilet!', { | ||
type: 'info', | ||
}); | ||
} | ||
``` | ||
## Setup and Bootstrapping | ||
> For Piral instance developers | ||
The provided library only brings API extensions for pilets to a Piral instance. | ||
@@ -19,0 +39,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
19090
83