|
@@ -0,0 +1,153 @@
|
|
|
|
+### $keep
|
|
|
|
+用于实现收藏业务功能, 也可以使用指令 v-keep
|
|
|
|
+
|
|
|
|
+#### 示例
|
|
|
|
+```js
|
|
|
|
+this.status = false
|
|
|
|
+this.$keep.action({
|
|
|
|
+ status: this.status,
|
|
|
|
+ id: '',
|
|
|
|
+ complete: ({ type, message }) => {
|
|
|
|
+ if (type) {
|
|
|
|
+ this.status = !this.status
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+})
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+#### Options
|
|
|
|
+| 参数 | 描述 | 类型 | 默认值 |
|
|
|
|
+| :----: | :----: | :----: | :----: |
|
|
|
|
+| loadingTip | 加载提示 | String | 提交中 |
|
|
|
|
+| showLabel | 是否需要选择标签 | Boolean | true |
|
|
|
|
+| status | 当前是否处于收藏状态 | Boolean | false |
|
|
|
|
+| id | 用于收藏的 id | String / Array | - |
|
|
|
|
+| getContainer | 指定挂载的节点 | String / Function | body / () => Element |
|
|
|
|
+| complete | 业务回调 type 是否完成业务 | Function | ({ type, message }, response) => null |
|
|
|
|
+| source | 留资业务 source | String | article_collection |
|
|
|
|
+| stopLeaveInfo | 是否禁用留资业务 | Boolaan | false |
|
|
|
|
+| beforeRedirect | 留资业务回调 beforeRedirect | Function | (conf, response) => null |
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+### $storage
|
|
|
|
+用于快捷实现本地存储存取数据
|
|
|
|
+
|
|
|
|
+#### Options
|
|
|
|
+| 参数 | 描述 | 类型 | 默认值 |
|
|
|
|
+| :----: | :----: | :----: | :----: |
|
|
|
|
+| prefix | 前缀 | String | package.json-name |
|
|
|
|
+| storage | localStorage/sessionStorage | Object | localStorage |
|
|
|
|
+| expires | 过期时间 | Date | -1 |
|
|
|
|
+| login | 是否添加特殊标识,标识登录时需清除的数据 | Boolean | false |
|
|
|
|
+| loginPrefix | 标识登录时需清除的数据的特殊附加前缀 | String | -login-clear- |
|
|
|
|
+
|
|
|
|
+#### 示例
|
|
|
|
+```js
|
|
|
|
+// 存
|
|
|
|
+this.$storage.set('test key', 'this is test value')
|
|
|
|
+
|
|
|
|
+// 取
|
|
|
|
+this.$storage.get('test key')
|
|
|
|
+// 取,没有值时使用默认值
|
|
|
|
+this.$storage.get('test key', 'this is default value')
|
|
|
|
+
|
|
|
|
+// 清除
|
|
|
|
+this.$storage.rm('test key')
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+#### 复杂示例
|
|
|
|
+```js
|
|
|
|
+// 存 设置过期时间为 今天23:59:59
|
|
|
|
+this.$storage.set('test key', 'this is test value', {
|
|
|
|
+ expires: 'today'
|
|
|
|
+})
|
|
|
|
+
|
|
|
|
+// 存 使用 sessionStorage
|
|
|
|
+this.$storage.set('test key', 'this is test value', {
|
|
|
|
+ storage: sessionStorage
|
|
|
|
+})
|
|
|
|
+
|
|
|
|
+// 存 APP端用户退出、登录时清除,或 Cookies.sessionID 变更时清除
|
|
|
|
+this.$storage.set('test key', 'this is test value', {
|
|
|
|
+ login: true
|
|
|
|
+})
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+### $visited
|
|
|
|
+用于快捷实现已访问信息存储,及回显判断,简单用法参见指令 v-visited
|
|
|
|
+
|
|
|
|
+#### 示例
|
|
|
|
+
|
|
|
|
+```js
|
|
|
|
+// 新增访问记录
|
|
|
|
+this.$visited.push({
|
|
|
|
+ type: '信息类型',
|
|
|
|
+ id: '信息唯一标识'
|
|
|
|
+})
|
|
|
|
+
|
|
|
|
+// 检查是否存在访问记录
|
|
|
|
+this.$visited.check({
|
|
|
|
+ type: '信息类型',
|
|
|
|
+ id: '信息唯一标识'
|
|
|
|
+})
|
|
|
|
+
|
|
|
|
+// 手动更新数据,获取最新本地存储数据,清除过期数据,更新 list
|
|
|
|
+this.$visited.refreshVisited()
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+#### Types 信息类型
|
|
|
|
+```
|
|
|
|
+content: 'article/content/*', 标讯详情页
|
|
|
|
+issued: 'article/issued', 供应详情页
|
|
|
|
+ent: 'ent(_ser)?_portrait', 企业详情页
|
|
|
|
+buyer: 'client_portrayal', 采购单位详情页
|
|
|
|
+project: 'client_follow_detail' 项目关注详情页
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+### $leaveInfo
|
|
|
|
+用于实现留资功能以及复杂留资逻辑判断的函数, 也可以使用指令 v-leave-info 使用简单功能
|
|
|
|
+
|
|
|
|
+#### 示例
|
|
|
|
+```js
|
|
|
|
+// 如果this.$leaveInfo中抛出异常,则do something中的内容不再执行
|
|
|
|
+// 如果beforeLeaveInfo中抛出Error,则do something中的内容不再执行
|
|
|
|
+// 判断是否需要留资
|
|
|
|
+await this.$leaveInfo({
|
|
|
|
+ source: 'listLeaveSource',
|
|
|
|
+ beforeRedirect: beforeLeaveInfo
|
|
|
|
+})
|
|
|
|
+
|
|
|
|
+// do something
|
|
|
|
+console.log('star')
|
|
|
|
+```
|
|
|
|
+```js
|
|
|
|
+// 自定义提示
|
|
|
|
+async function beforeLeaveInfo (conf, { retainedCapital: needLeaveInfo }) {
|
|
|
|
+ if (needLeaveInfo) {
|
|
|
|
+ await this.$dialog.confirm({
|
|
|
|
+ className: 'j-confirm-dialog',
|
|
|
|
+ closeOnClickOverlay: true,
|
|
|
|
+ showCancelButton: false,
|
|
|
|
+ message: '重要项目一键创建标签收藏!请完善个人信息,为您匹配精准服务',
|
|
|
|
+ confirmButtonText: '立即前往'
|
|
|
|
+ })
|
|
|
|
+ // throw new Error('需要留资,beforeRedirect中阻止了后续事件执行')
|
|
|
|
+ }
|
|
|
|
+}
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+#### Conf Options
|
|
|
|
+| 参数 | 描述 | 类型 | 默认值 |
|
|
|
|
+| :----: | :----: | :----: | :----: |
|
|
|
|
+| source | 留资id(必传) | String | '' |
|
|
|
|
+| params | 额外参数 | Object | {} |
|
|
|
|
+| beforeRedirect | 需要跳转前的回调,`throw new Error('xxx') 中断后续操作`,支持Promise | Function | - |
|
|
|
|
+| redirect | 跳转操作,默认跳转留资 | Function | - |
|
|
|
|
+
|
|
|
|
+#### callback params Options
|
|
|
|
+| 参数 | 描述 | 类型 | 默认值 |
|
|
|
|
+| :----: | :----: | :----: | :----: |
|
|
|
|
+| source | 留资id | String | '' |
|
|
|
|
+| params | 额外参数 | Object | {} |
|
|
|
|
+| fource | 是否强制留资 | Boolean | false |
|
|
|
|
+| retainedCapital | 是否需要留资。是则跳转留资页面 | Boolean | false |
|