1. Reference
2. UIKit
3. Notification button

Notification button component

<wy-notification-button> | WyNotificationButton

Weavy notification button component to render a button complete with a realtime badge for the number of unread notifications. When clicking the button, it opens a built in overlay displaying the full list of notifications.

Weavy automatically creates notifications for reactions, mentions and other activities.

The notifications can be clicked or marked as read or unread. When clicked the notification fires a "wy-link" event with information about the originating Weavy component for the notification. This can be used to handle navigation in the app, back to where the originating Weavy component is placed.

The notification button component can optionally be tailored to only show notifications for a specific app or notifications of a specific type, such as mentions or reactions. When setting a predefined notification type, it removes the possibility for the user to filter the list by type in the UI.

Complement this with the Notification toasts component to also get realtime in-app notifications or browser notifications.

Component layout

The button is displayed as a clickable icon that acts as a button. The default size of the button is the icon size 1.5rem/24px together with the set --wy-padding (which defaults to .5rem/8px) on every side of the icon, which makes a total of 2.5rem/40px per default.

The openable notification list renders in an overlay in the top layer. That means that the notification list does not occupy any visual layout space where it's placed in the DOM, it only renders in the top layer.

You can add additional styling using CSS Custom Properties and CSS Shadow Parts and further customization using slots.

Importing

If you installed the UIKit with npm you can use the following snippet to import the component into your project. Otherwise, if you installed the UIKit as a <script> you can ignore this section.

import { WyNotificationButton } from "@weavy/uikit-web";

Examples

Notification button with notification list overlay

Display notification button with a badge that tracks notifications for the authenticated user and can open an overlay with a notification list on click.

<wy-notification-button></wy-notification-button>

Filter notifications by app

Display notifications for the authenticated user that originated from app with the specified uid. Also, show a dot instead of a count when there are unread notifications.

<wy-notification-button uid="test-chat" badge="dot"></wy-notification-button>

Styling the badge

Changes the styles of the badge in the notification button. Set the background color of the wy-badge CSS shadow part.

wy-notification-button::part(wy-badge) {
  background-color: violet;
}

HTML attributes

Attributes can be set when using the component in HTML. All attributes have corresponding Javascript properties.

Most attributes are optional and/or has sensible default values. Any required attributes are indicated with an asterisk (*).

Learn more about attributes and properties.

JavaScript properties

Properties can be used in JavaScript. Some of them have corresponding HTML attributes where applicable.

JavaScript methods

Methods for the component are available in JavaScript. Methods that are async return a promise.

DOM Events

The component triggers custom events that bubbles up the DOM tree. They can be listened to using the addEventListener() method.

Learn more about events.

Slots

The slots can be used to inject elements into the component. All predefined child nodes of the slot will be replaced with the injected content.

To prevent child nodes from rendering before the component has loaded you can hide them using CSS.

wy-notification-button:not(:defined) {
  display: none;
}