RED.notify

该API可用于显示从编辑器顶部弹出的通知。

由于这些通知会打断用户,因此应谨慎使用。

RED.notify(message, [options])

  • message - 要在通知中显示的文本
  • options - 通知的配置选项

该函数返回一个 notification 对象,可用于与通知进行交互。

配置选项

options 参数中可以提供以下属性。所有属性都是可选的。

选项 描述
type 设置通知的外观。可用值有:compactsuccesswarningerror。如果未设置此值,则通知使用默认的“info”外观。
timeout 通知应显示的时间(以毫秒为单位)。默认值:5000。如果设置了 fixed 属性,则此值将被忽略。
fixed 在超时后不隐藏通知。这也防止了通知的点击关闭默认行为。
modal 如果设置为 true,则通知应防止与任何其他UI元素的交互,直到通知被关闭。
buttons 一个按钮数组,用于在通知上显示以允许用户交互。

通知按钮

buttons 选项可用于提供一组应在通知上显示的按钮。

例如,要有一个“取消”和“确认”按钮,可以使用以下内容(请参见下面的完整示例,解释 myNotification.close())。

buttons: [
    {
        text: "取消",
        click: function(e) {
            myNotification.close();
        }
    },
    {
        text: "确认",
        class:"primary",
        click: function(e) {
            myNotification.close();
        }
    }

class 属性可用于指定按钮的额外CSS类。如果通知有多个按钮,则应有一个类设置为 primary 以指示用户点击的主要按钮。

通知对象

RED.notify() 调用返回一个 notification 对象。该对象提供以下功能:

函数 描述
notification.close() 关闭通知并处置它。
notification.update( message, options ) 替换通知的内容。

示例

普通信息通知

RED.notify("你好,世界");

持续10秒的警告通知

RED.notify("发生了一些事情", { type: "warning", timeout: 10000 });

带按钮的通知

此示例展示了如何在按钮事件处理程序中使用返回的 myNotification 对象来关闭通知。

```javascript let myNotification = RED.notify(“这是要显示的消息”,{ modal: true, fixed: true, type: ‘warning’, buttons: [ { text: “取消”, click: function(e) { myNotification.close(); } }, { text: “确认”, class:”primary”, click: function(e) { myNotification.close(); } } ] });