@silexlabs/grapesjs-notifications
TypeScript icon, indicating that this package has built-in type declarations

0.0.8 • Public • Published

GrapesJs Notifications Plugin

Why this plugin? GrapesJs is a powerful framework to build no-code tools and allow users to create templates using a drag-and-drop interface. However, the framework does not offer a standard way of notifying users and each plugin implements its own, which is messy and not user friendly. This plugin provides a centralized notification system that can be used by all plugins to display messages to the user.

It displays various types of notifications including errors, warnings, and activities, thereby facilitating a more interactive and responsive interface. The most important feature is probably that it allows users to interact with the notifications by clicking on them to select a specific component in the editor, go to a page or scroll to the component.

This code is part of a larger project: about Silex v3

Here is a demo page on codepen

Here is a screenshot of the notifications in action:

Notifications in action

Features

  • [x] Notification types with corresponding icons
  • [x] Select component attached to the notification (supports components on different pages)
  • [x] Customizable notification style
  • [x] Internationalization
  • [x] Local storage for persistent notifications
  • [x] Maximum number of notifications to display
  • [x] Notification timeout
  • [x] Custom notification container
  • [x] Notification events
  • [x] Notification commands
  • [x] editor.NotificationManager API
  • [x] Group notifications
  • [x] Support pages

HTML

<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet">
<script src="https://unpkg.com/grapesjs"></script>
<script src="https://unpkg.com/@silexlabs/grapesjs-notifications"></script>

<div id="gjs"></div>

JS

const editor = grapesjs.init({
	container: '#gjs',
  height: '100%',
  fromElement: true,
  storageManager: false,
  plugins: ['@silexlabs/grapesjs-notifications'],
});

CSS

body, html {
  margin: 0;
  height: 100%;
}

Summary

Plugin name: @silexlabs/grapesjs-notifications

API:

  • Notification object:
    • type: error, warning, success, info
    • message: string
    • timeout: number (ms)
    • componentId: string
  • editor.Notifications methods:
    • add(notification)
    • remove(notification)
    • clear()
  • Commands: editor.runCommand('notifications:add', notification)
    • notifications:add - Add a notification
    • notifications:remove - Remove a notification
    • notifications:clear - Clear all notifications
  • Events:
    • notifications:changed - When any change to the notifications occurs
    • notifications:added - When a notification is added
    • notifications:removed - When a notification is removed
    • notifications:cleared - When all notifications are cleared

Options

Option Description Type Default
timeout Default timeout for the notification in ms number No timeout
container Container for the notifications HTMLElement document.body
storeKey Store notifications in local storage under this key string No storage
icons Icons for the notification types object {error: '\u2716', warning: '\u26A0', success: '\u2714', info: '\u2139'}
i18n Internationalization object Check the values in locale/en.js
maxNotifications Maximum number of notifications to display number 50
reverse Reverse the order of the notifications boolean false

Styling

Note that you are free to style the container since you provide it in the options. You also can change the icons from the options.

The notifications are styled using the following CSS classes:

  • .gjs-notification - The notification container
  • .gjs-notification__group - The notification group container
  • .gjs-notification__item - The notification item
  • .gjs-notification__error - The error notification
  • .gjs-notification__warning - The warning notification
  • .gjs-notification__success - The success notification
  • .gjs-notification__info - The info notification
  • .gjs-notification__message - The notification message
  • .gjs-notification__close - The close button for the notification
.gjs-notification {
  padding: 10px;
  margin: 10px;
  border-radius: 5px;
  box-shadow: 0 0 5px rgba(0,0,0,.3);
}

Download

  • CDN
    • https://unpkg.com/@silexlabs/grapesjs-notifications
  • NPM
    • npm i @silexlabs/grapesjs-notifications
  • GIT
    • git clone https://github.com/silexlabs/grapesjs-notifications.git

Usage

Directly in the browser

<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-notifications.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
      container: '#gjs',
      // ...
      plugins: ['@silexlabs/grapesjs-notifications'],
      pluginsOpts: {
        '@silexlabs/grapesjs-notifications': { /* options */ }
      }
  });
</script>

Modern javascript

import grapesjs from 'grapesjs';
import plugin from '@silexlabs/grapesjs-notifications';
import 'grapesjs/dist/css/grapes.min.css';

const editor = grapesjs.init({
  container : '#gjs',
  // ...
  plugins: [plugin],
  pluginsOpts: {
    [plugin]: { /* options */ }
  }
  // or
  plugins: [
    editor => plugin(editor, { /* options */ }),
  ],
});

Development

Clone the repository

$ git clone https://github.com/silexlabs/grapesjs-notifications.git
$ cd @silexlabs/grapesjs-notifications

Install dependencies

$ npm i

Start the dev server

$ npm start

Build the source

$ npm run build

License

MIT

Package Sidebar

Install

npm i @silexlabs/grapesjs-notifications

Weekly Downloads

99

Version

0.0.8

License

MIT

Unpacked Size

944 kB

Total Files

8

Last publish

Collaborators

  • jbips
  • lexoyo