@dbp-toolkit/notification

0.3.3 • Public • Published

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';

...
async <your_function_name>(event) {
    send({
        "summary": "Item deleted",
        "body": "Item foo was deleted!",
        "type": "info",
        "timeout": 5,
    });
}

...

render() {
        let loggedIn = this.auth && this.auth.token;
        let i18n = this._i18n;
        
        return html`
            ...
            <button id="send-button" @click="${this.<your_function_name>}" class ="button">
                ${i18n.t('<your_text>')}
            </button>
            ...
        `
}

Local development

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

# install dependencies
npm install

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

# run tests
npm test

# build local packages in dist directory
npm run build

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

Readme

Keywords

none

Package Sidebar

Install

npm i @dbp-toolkit/notification

Weekly Downloads

27

Version

0.3.3

License

LGPL-2.1-or-later

Unpacked Size

618 kB

Total Files

27

Last publish

Collaborators

  • lazka
  • pbek
  • dbp-deploy