@acpaas-ui/js-notification-store 中文文档教程

Question

ACPaaS UI JS Notification Store

@acpaas-ui/js-notification-store 包提供了一个单例存储在整个应用程序中保存和轻松访问通知。 您可以加载消息映射并通过句柄触发通知。 最重要的是，您可以设置目标来保存您的通知（例如弹出窗口、状态栏、表单）。 通知作为 BehaviorSubjects 返回，允许您订阅更改。

## Installation

NPM

npm install @acpaas-ui/js-notification-store --save

Yarn

yarn add @acpaas-ui/js-notification-store

## Import

// ES2015
import { NotificationStore } from '@acpaas-ui/js-notification-store';

const store = new NotificationStore({
    404: 'not found'
});

store.triggerNotification('404', 'statusbar');

Usage

Loading messages

要加载消息映射，只需在构造函数中提供它：

import NotificationStore from 'aui-notification-store';

const store = new NotificationStore({
    404: 'not found'
});

如果 allowOverrides 选项设置为 true：

NotificationStore.allowOverrides = true;

您可以使用每个新实例：

const store2 = new NotificationStore({
    404: 'not here'
});

或者，您可以在实例上调用 loadMessages 方法：

store.loadMessages({
    404: 'not here'
});

无论哪种情况，您都需要将 allowOverrides 选项设置为 true，否则现有消息将被保留.

Triggering notifications

要触发通知，您可以在商店实例上调用 triggerNotification 方法。 提供句柄、（可选）目标和一些（也是可选的）额外选项：

const store = new NotificationStore({
    404: 'not found'
});

store.triggerNotification('404', 'statusbar', { timer: 1000 });

Clearing notifications

您可以通过调用存储上的 clearNotification 方法来清除通知：

const notifications = store.getNotifications('statusbar');
const notificationToClear = notifications.find(notification => notification.handle === 'clearme');

store.clearNotification(notificationToClear);

Subscribing to notifications

每个实例都有一个 notifications 属性，它将所有当前通知保存为您可以订阅的 BehaviorSubject：

store.notifications.subscribe(newNotifications => {
    // do something
});

或从中获取当前值（这是一个对象，其中包含每个目标的通知映射：

const notifications = store.notifications.getValue();

Available methods and properties

Notification Class

静态属性

• defaultOptions (object): returns a plain object with the default options
• availableTypes (object): getter for the available notification types

静态方法

• parseOptions(options): check the provided options against the default options

实例属性

• handle (string): the unique handle for the notification message
• target (string): the target to store the notification with
• message (string): the message to be shown when triggering the notification
• type (string): the type of notification (N, I, E, W, S)
• timer (number): the lifespan of the notification once it is shown (in ms)
• scope (string): the app scope the notification should be visible in

NotificationStore Class

静态属性

• allowOverrides (boolean): get/set for the allowOverrides option
• defaultHandle (string): get/set for the default handle to fall back to when triggering a notification
• defaultTarget (string): get/set for the default target to fall back to when triggering a notification
• defaultMessage (string): get/set for the default message to fall back to when triggering a notification
• defaultTimer (number): get/set for the default timer to fall back to when triggering a notification
• defaultScope (string): get/set for the default scope to fall back to when triggering a notification
• messages (object): get/set for the available messages
• options (object): get/set for the currently selected options
• subjects (Map): getter for the current subjects

静态方法

• subscriber(store): add a new BehaviorSubject for a store (internal function)
• getFlatTarget(target): get the notifications as a flat array for a target (internal function)
• getFlatNotifications(target): get the notifications (for a target if provided) as a flat object of target arrays (internal function)
• deleteNotification(notification): delete a notification (internal function)
• updateSubjects(): trigger an update to all subjects (internal function)
• resetStore(): clear all messages and notifications and reset all options

实例属性

• notifications (BehaviorSubject): a BehaviorSubject that holds all current notifications

< strong>实例方法

• getMessages: get the stored messages
• getMessage(handle): get a message by its handle
• loadMessages(messages): load a new set of messages (takes the allowOverrides option into account)
• triggerNotification(handle, target, options): trigger a new notification by handle, target and provide some extra optional options
• loadNotification(notification): load a new notification, needs a Notification instance
• getNotifications(target): return a flat object holding all notifications or the notifications for the provided target
• clearNotification(notification): clear a notification, needs a Notification instance
• clearTarget(target): clear all notifications for a target, target is required