Skip to content

Latest commit

 

History

History
409 lines (321 loc) · 8.47 KB

README-zh.md

File metadata and controls

409 lines (321 loc) · 8.47 KB

iNotify 实例预览

JS 实现浏览器的 title 闪烁、滚动、声音提示、通知，没有依赖. 它不会干扰任何 JavaScript 库或框架。有合理的体积 5.05kb (gzipped: 1.75kb)，官方文档实例预览。

下载

# v2.x
$ npm install @wcjiang/notify --save
# v1.x
$ npm install title-notify --save

使用

import Notify from "@wcjiang/notify";

const notify = new Notify({
  message: "有消息了。", // 标题
  effect: "flash", // flash | scroll 闪烁还是滚动
  openurl: "https://github.com/jaywcjlove/iNotify", // 点击弹窗打开连接地址
  onclick: () => {
    // 点击弹出的窗之行事件
    console.log("---");
  },
  // 可选播放声音
  audio: {
    // 可以使用数组传多种格式的声音文件
    file: ["msg.mp4", "msg.mp3", "msg.wav"],
    // 下面也是可以的哦
    // file: 'msg.mp4'
  },
  // 标题闪烁，或者滚动速度
  interval: 1000,
  disableFavicon: false, // 可选，默认不禁用。如果为true则不覆盖原有favicon
  // 可选，默认绿底白字的  Favicon
  updateFavicon: {
    // favicon 字体颜色
    textColor: "#fff",
    // 背景颜色，设置背景颜色透明，将值设置为“transparent”
    backgroundColor: "#2F9A00",
  },
  // 可选chrome浏览器通知，默认不填写就是下面的内容
  notification: {
    title: "通知！", // 设置标题
    icon: "", // 设置图标 icon 默认为 Favicon
    body: "您来了一条新消息", // 设置消息内容
  },
});

notify.player();

在您的 HTML 中手动下载并引入 notify.js，你也可以通过 UNPKG 进行下载：

<script src="https://unpkg.com/@wcjiang/notify/dist/notify.min.js"></script>
<script type="text/javascript">
  var notify = new Notify({
    effect: "flash",
    interval: 500,
  });
  notify.setFavicon("1");
</script>

option

  • message: String 标题
  • effect: String, flash | scroll | favicon 闪烁还是滚动
  • audio: 可选播放声音
    • file: String/Array 可以使用数组传多种格式的声音文件
  • interval: Number 标题闪烁，或者滚动速度
  • openurl: String 点击弹窗打开连接地址
  • onclick: Function 弹窗点击事件
  • updateFavicon: 设置 Favicon 图标颜色
    • textColor: 设置 favicon 字体颜色
    • backgroundColor: 背景颜色，设置背景颜色透明，将值设置为 transparent
  • notification: 可选 chrome 浏览器通知，默认不填写就是下面的内容
    • title: 默认值 通知！
    • icon: 设置图标 icon 默认为 Favicon
    • body: 设置消息内容

isPermission

判断浏览器弹框通知是否被阻止。

iNotify.isPermission();

声音设置

player

播放声音

iNotify.player();

loopPlay

自动播放声音

iNotify.loopPlay();

stopPlay

停止播放声音

iNotify.stopPlay();

setURL

设置播放声音 URL

iNotify.setURL("msg.mp3"); // 设置一个
iNotify.setURL(["msg.mp3", "msg.ogg", "msg.mp4"]); // 设置多个

title

最新的版本默认不播放标题闪烁动画，初始化之后需要调用 setTitle(true) 方法才播放标题动画。

setTitle

设置标题，

iNotify.setTitle(true); // 播放动画
iNotify.setTitle("新标题"); // 闪烁新标题
iNotify.setTitle(); // 清除闪烁 显示原来的标题

setInterval

设置时间间隔

iNotify.setInterval(2000);

addTimer

添加计数器

iNotify.addTimer();

clearTimer

清除计数器

iNotify.clearTimer();

favicon 通知

setFavicon

设置 icon 显示数字或者文本

iNotify.setFavicon(10);

setFaviconColor

设置 icon 显示文本颜色

iNotify.setFaviconColor("#0043ff");

setFaviconBackgroundColor

设置 icon 显示文本颜色

iNotify.setFaviconBackgroundColor("#0043ff");
// 设置字体和背景颜色
iNotify.setFaviconColor("#f5ff00").setFaviconBackgroundColor("red");

faviconClear

清除数字显示原来的 icon

iNotify.faviconClear();

chrome 通知

notify

弹出 chrome 通知，不传参数为预设值...

iNotify.notify();
iNotify.notify({
  title: "新通知",
  body: "打雷啦，下雨啦...",
  openurl: "http://www.bing.com",
  onclick: function () {
    console.log("on click");
  },
  onshow: function () {
    console.log("on show");
  },
});
  • title 一定会被显示的通知标题。
  • dir 文字的方向；它的值可以是 auto（自动）, ltr（从左到右）, or rtl（从右到左）。
  • icon 一个图片的 URL，将被用于显示通知的图标。
  • body 通知中额外显示的字符串。
  • openurl 点击打开指定 URL。
  • onclick 每当用户点击通知时被触发。
  • onshow 当通知显示的时候被触发。
  • onerror 每当通知遇到错误时被触发。
  • onclose 当用户关闭通知时被触发。

其它

iNotify.init().title; 获取标题

例子

实例一

function iconNotify(num) {
  if (!notify) {
    var notify = new Notify({
      effect: "flash",
      interval: 500,
    });
  }
  if (num === 0) {
    notify.faviconClear();
    notify.setTitle();
  } else if (num < 100) {
    notify.setFavicon(num);
    notify.setTitle("有新消息！");
  } else if (num > 99) {
    notify.setFavicon("..");
    notify.setTitle("有新消息！");
  }
}

实例二

var notify = new Notify({
  effect: "flash",
  interval: 500,
});
notify.setFavicon("1");

实例三

var iN = new Notify({
  effect: "flash",
  interval: 500,
  message: "有消息拉！",
  updateFavicon: {
    // 可选，默认绿底白字
    textColor: "#fff", // favicon 字体颜色
    backgroundColor: "#2F9A00", // 背景颜色
  },
}).setFavicon(10);

实例四

var iN = new Notify().setFavicon(5);

实例五

var iN = new Notify({
  effect: "flash",
  interval: 500,
  message: "有消息拉！",
  audio: {
    file: "msg.mp4",
  },
})
  .setFavicon(10)
  .player();

实例五

var iN = new Notify({
  effect: "flash",
  interval: 500,
  message: "有消息拉！",
  audio: {
    file: "msg.mp4", //可以使用数组传多种格式的声音文件
  },
  notification: {
    title: "通知！",
    icon: "",
    body: "您来了一条新消息",
  },
})
  .setFavicon(10)
  .player();

//弹出chrome通知，不传参数为预设值...
iN.notify();

iN.notify({
  title: "新通知",
  body: "打雷啦，下雨啦...",
});

实例六

var iN = new Notify({
  effect: "flash",
  interval: 500,
  message: "有消息拉！",
  audio: {
    file: ["msg.mp4", "msg.mp3", "msg.wav"],
  },
  notification: {
    title: "通知！",
    body: "您来了一条新消息",
  },
});

iN.setFavicon(10).player();

var n = new Notify();
n.init({
  effect: "flash",
  interval: 500,
  message: "有消息拉！",
  audio: {
    file: ["openSub.mp4", "openSub.mp3", "openSub.wav"],
  },
  notification: {
    title: "通知！",
    icon: "",
    body: "您来了一个客户",
  },
});

n.setFavicon(10).player();

贡献者

一如既往，感谢我们出色的贡献者！

由 contributors 制作。

License

MIT © Kenny Wong