1.0.10 • Published 4 years ago
@vuepress-yard/vuepress-plugin-window v1.0.10
@vuepress-yard/vuepress-plugin-window
Details
vuepress-theme-yard plugin -- window
使用位置 | 值 |
---|---|
plugin name | vuepress-plugin-window |
component name | DisplayWindow |
参数解释
参数 | 解释 | 默认值 | 类型 |
---|---|---|---|
title | 顶部浮窗标题 | 公告 | String |
windowStyle | 展示框体的样式 | {right: '20px',top: '70px',width: '260px',} | Object |
contentInfo | 框体展示内容 | {title: '欢迎加入QQ交流群 🎉🎉🎉',imgUrl: 'https://reinness.com/avatar.png',needImg: true,content: '这是内容(请您修改~~~)', contentStyle: {}} | Object |
bottomInfo | 底部按钮信息 | {btnText: '关于',linkTo: 'https://reinness.com'} | Object |
delayMount | 延迟展出时间 | 500 | Number |
closeOnce | 关闭后不再打开 | false | Boolean |
hideRouteList | 在某些路由下隐藏 | [] | Array |
关于最后两个参数的详细描述,请往下翻阅。
contentInfo 解释
参数 | 解释 | 默认值 |
---|---|---|
title | 悬浮窗内容第一行标题 | '欢迎加入QQ交流群 🎉🎉🎉 |
needImg | 悬浮窗内容是否使用图片 | true |
imgUrl | 悬浮窗内容的图片地址 | https://reinness.com/avatar.png |
content | 如果不使用图片的话可以使用自定义文字 | 这是内容(请您修改~~~) |
contentStyle | 自定义文字样式 | 暂无 |
closeOnce 解释
本方法采用sessionStorage
来存储标识。关闭一次窗口后写上标识,下次不会再展示。关闭当前浏览器标签后sessionStorage
释放,标识被抹除。故而下次又重新展示
hideRouteList 解释
在不同路由下,不想展示当前窗口,可通过此配置来过滤路由隐藏页。但是因为大家的路径起名各不相同,目前只兼容host
后一个路径。
例如: https://reinness.com/views
or
https://reinness.com/about
上面两个地址中,views
, about
才是被支持的路径。
如果想禁止这两个路径,那么就应该配置为 hideRouteList:["views","about"]