Notification API,爲你的網頁添加桌面通知推送

Notification 是什麼

MDN:web

Notifications API 的 Notification 接口用於配置和向用戶顯示桌面通知。這些通知的外觀和特定功能因平臺而異,但一般它們提供了一種向用戶異步提供信息的方式。chrome

其實,MDN 的說明已經可讓咱們很清楚知道 Notification 的做用。Notification 可以爲用戶提供異步的桌面消息通知,即便你縮小瀏覽器或是活動在其餘標籤頁,只要調用該 Api 的標籤頁沒被關閉,它都能工做。在桌面端的瀏覽器中,除了 IE 不支持外,其餘就均已支持。瀏覽器

如下只提到經常使用的屬性及其方法,更全的看MDN文檔: https://developer.mozilla.org/en-US/docs/Web/API/notification安全

狀態值

permission:異步

只讀屬性,表示當前顯示通知權限的字符串,爲如下值:async

  • denied: 拒絕顯示通知
  • granted: 接受顯示通知
  • default: 未選擇,瀏覽器默認將其看成拒絕的行爲
Notification.permission

受權

requestPermission:編輯器

向用戶請求顯示通知的權限。只有當 permission 的值爲 default 時調用此方法,右上角纔會顯示受權彈窗。若是用戶此前已選擇過,那麼再次調用直接返回狀態值。測試

Notification.requestPermission().then(res => {
  // denied 或 granted
  console.log(res) 
})

須要注意的是,用戶若是選擇拒絕後,再次調用也不會彈出受權提示。想要再次更改狀態,只能由用戶手動設置:網站

  • 第一種:點擊地址欄前的小按鈕(感嘆號或小鎖),設置通知狀態
  • 第二種:chrome 瀏覽器右上角 設置 >> 隱私設置和安全性 >> 網站設置 >> 通知

構造實例

new Notification(title[,options])

當用戶容許受權後,構造實例後,瀏覽器就會彈窗提示。ui

let notification = new Notification('通知標題', {
  // 正文內容
  body: '已經錯過的風景就不要再打聽了,當你選定了一個方向,另外一邊的風景便與你無關了。',
  // 圖標
  icon: 'https://common.cnblogs.com/images/wechat.png',
  // 預覽大圖
  image: 'https://user-gold-cdn.xitu.io/2020/5/18/1722800bd522f520?imageView2/1/w/1304/h/734/q/85/format/webp/interlace/1',
  // 通知id
  tag: 1,
  // 是否一直保持有效
  requireInteraction: true
})

tag:

通知的ID,默認 tag 爲空。當 tag 相同時,重複構造實例,新通知會替換舊通知。反之,通知不會替換,而是像樓層同樣疊加。一樣的,忽略 tag 屬性,通知也不會替換。

requireInteraction:

通知是否保持,不會自動關閉。默認爲 false,會自動關閉。當設置爲 true 時,由用戶手動關閉或調用實例的 close 方法進行關閉。

notification.close()

事件處理

監聽用戶點擊通知時,能夠爲實例添加事件:

let notification = new Notification('通知標題', {
  body'已經錯過的風景就不要再打聽了,當你選定了一個方向,另外一邊的風景便與你無關了。',
  icon'https://common.cnblogs.com/images/wechat.png',
  image'https://user-gold-cdn.xitu.io/2020/5/18/1722800bd522f520?imageView2/1/w/1304/h/734/q/85/format/webp/interlace/1',
  tag1
})

notification.onclick = function ({
  alert('用戶點擊了通知')
}

若是想要在事件內獲取一些自定義參數信息,能夠爲實例添加 data 屬性:

let notification = new Notification('通知標題', {
  body'已經錯過的風景就不要再打聽了,當你選定了一個方向,另外一邊的風景便與你無關了。',
  icon'https://common.cnblogs.com/images/wechat.png',
  image'https://user-gold-cdn.xitu.io/2020/5/18/1722800bd522f520?imageView2/1/w/1304/h/734/q/85/format/webp/interlace/1',
  tag1,
  data: {
    url'https://juejin.im'
  }
})

notification.onclick = function (e{
  window.open(e.target.data.url, '_blank')
}

實例上還能夠綁定事件 show(顯示通知時觸發) 、close(關閉通知時觸發)、error(通知錯誤時觸發)。

MDN 文檔上提示,onshowonclose 是一個過期的API,不保證能夠正常工做。但在 chrome 瀏覽器測試使用這兩個 API,仍是可以工做的,最好仍是慎用吧。

封裝Notification

爲了方便調用,簡單封裝建立 Notification 的方法,在原基礎上加入消息時長配置

/*
* @param {string} title - 消息標題
* @param {object} options - 消息配置
* @param {number} duration - 消息時長
* @param {function} onclick
* @param {function} onshow
* @param {function} onclose
* @param {function} onerror
* @return {object}
*/

async function createNotify(data{
  // 一些判斷
  if (window.Notification) {
    if (Notification.permission === 'granted') {
      return notify(data)
    } else if (Notification.permission === 'default') {
      let [err, status] = await Notification.requestPermission().then(status => [null, status]).catch(err => [err, null])
      return err || status === 'denied' ? Promise.reject() : notify(data)
    }
  }
  // 構造實例
  function notify(data{
    let { title, options, duration } = data
    options.requireInteraction = true
    let notification = new Notification(title, options)
    setTimeout(()=> notification.close(), duration || 5000)
    // 綁定事件
    let methods = ['onclick''onshow''onclose''onerror']
    for(let i = 0; i < methods.length; i++) {
      let method = methods[i]
      if (typeof options[method] === 'function') {
        notification[method] = options[method]
      }
    }
    return notification
  }
  return Promise.reject()
}

使用

createNotify({
  title'標題',
  options: {
    body'消息內容'
  },
  duration3000
})

瀏覽器支持

PC 端支持還不錯,移動端就基本一片紅了...

兼容性查詢:https://www.caniuse.com/#search=Notification

相關文章
相關標籤/搜索