0.3.2 • Published 1 year ago

@dbp-toolkit/notification v0.3.2

Weekly downloads
56
License
LGPL-2.1-or-later
Repository
github
Last release
1 year ago

Notification Web Component

You can install this component via npm:

npm i @dbp-toolkit/notification

Usage

<dbp-notification></dbp-notification>
<script type="module" src="node_modules/@dbp-toolkit/notification/dist/dbp-notification.js"></script>

Or directly via CDN:

<dbp-notification></dbp-notification>
<script type="module" src="https://unpkg.com/@dbp-toolkit/notification@0.2.2/dist/dbp-notification.js"></script>

Attributes

  • lang (optional, default: de): set to de or en for German or English
    • example <dbp-notification lang="de" client-id="my-client-id"></dbp-notification>

Sending notifications

import { send } from './notification';

send({
    "summary": "Item deleted",
    "body": "Item foo was deleted!",
    "type": "info",
    "timeout": 5,
});

Local development

# get the source
git clone git@github.com:digital-blueprint/toolkit.git
cd toolkit/packages/notification

# install dependencies
yarn install

# constantly build dist/bundle.js and run a local web-server on port 8002 
yarn run watch

# run tests
yarn test

# build local packages in dist directory
yarn run build

Jump to http://localhost:8002 and you should get a demo page.