Notifications

Description

Notifications provides the routed notifications page, navbar dropdown, and settings widget used by Enso UI applications.

Installation

Install the package:

yarn add @enso-ui/notifications

The package is usually consumed from the full enso-ui workspace inside an Enso application.

Features

• registers the /core/notifications/index page route
• ships a navbar dropdown that fetches, reads, and marks notifications as read
• includes a settings widget for toast position selection
• exports register.js to wire navbar and settings items into the host app

Usage

import notificationsRoute from '@enso-ui/notifications/src/bulma/routes/notifications.js';
import registerNotifications from '@enso-ui/notifications/src/bulma/register.js';

API

Route and registration modules

Common imports:

• src/bulma/routes/notifications.js
• src/bulma/register.js

Navbar component

src/bulma/components/navbar/Notifications.vue

• wraps the core renderless notifications controller
• renders unread count, dropdown items, and mark-all-as-read actions

Settings component

src/bulma/components/settings/ToastrPosition.vue

• renders the toastr-position selector through the dropdown package
• uses the core settings controller to update the preferred position

Routes

/core/notifications/index

Route name:

• core.notifications.index

Companion Backend Package

• laravel-enso/notifications ↗

Depends On

• @enso-ui/directives ↗
• @enso-ui/dropdown ↗
• @enso-ui/toastr ↗
• @enso-ui/transitions ↗
• @enso-ui/ui ↗

Contributions

are welcome. Pull requests are great, but issues are good too.

Thank you to all the people who already contributed to Enso!

License

MIT