更新日志弹窗接入
说明
更新日志弹窗接入方案是兔小巢为产品提供的快捷展示更新日志的网页开发工具包
注意:由于小程序场景比较特殊,需要使用小程序自身方法接入更新日志,具体可查看小程序接入更新日志
示例
接入指引
支持直接下载插件js文件,也支持npm 引入
从npm上安装依赖来使用工具包
安装依赖
npm install txc-change-log --save
模块引入
// main.js
import TxcChangeLog from 'txc-change-log';
// 实例化
const txcChangeLog = new TxcChangeLog({ id: 1368 });
...
手动下载并引入来使用工具包
使用实例:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>兔小巢更新日志接入 demo</title>
</head>
<body>
<script src="./js/txc-change-log.js"></script>
<script>
// 实例化
var txcChangeLog = new TxcChangeLog({ id: 1368 });
// ...
</script>
</body>
</html>
api说明
实例化参数
参数名 | 类型 | 必填 | 默认值 | 备注 |
---|---|---|---|---|
id | number | 是 | - | 传入兔小巢社区ID |
modalIndex | number | 否 | 1000 | 配置遮罩层z-index |
recentDay | number | 否 | 7 | 默认只对最近7天内的更新日志进行判断是否弹窗,需要延长或缩短的可以传入recentDay 参数进行自定义 |
方法
方法名 | 说明 |
---|---|
activateChangeLog | 激活兔小巢弹窗插件,由兔小巢弹窗插件自动判断是否需要弹出更新日志,并在合适的时机弹出更新日志 |
showModal | 同步方法,不做任何判断直接弹出更新日志弹窗,同时弹出需要自己记录 |
closeModal | 同步方法,关闭更新日志弹窗 |
shouldModalShow | 异步方法,判断是否需要弹出更新日志弹窗 |