address-book-shell 0.0.6 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -12
- package/lib/address-book-shell.common.js +227 -219
- package/lib/address-book-shell.umd.js +227 -219
- package/lib/address-book-shell.umd.min.js +1 -1
- package/package.json +1 -1
- package/packages/address-book/src/components/address-content.vue +12 -4
- package/packages/address-book/src/index.vue +14 -7
- package/src/App.vue +0 -29
- package/src/api/cas-api.js +0 -28
package/README.md
CHANGED
|
@@ -1,20 +1,67 @@
|
|
|
1
|
-
# address-book-shell
|
|
1
|
+
# address-book-shell
|
|
2
|
+
基于vue2和element-ui开发的地址本组件
|
|
2
3
|
|
|
3
|
-
###
|
|
4
|
+
### 组件下载
|
|
5
|
+
npm i address-book-shell
|
|
6
|
+
<br/> 或
|
|
7
|
+
<br/>yarn add address-book-shell
|
|
4
8
|
|
|
5
|
-
|
|
9
|
+
### 组件注册
|
|
10
|
+
```javascript
|
|
11
|
+
import microserviceRequest from '@/utils/microService/microService-request.js'
|
|
12
|
+
import AddressBookShell from 'address-book-shell'
|
|
13
|
+
Vue.use(AddressBookShell, {
|
|
14
|
+
microserviceRequest: microserviceRequest,
|
|
15
|
+
})
|
|
16
|
+
```
|
|
17
|
+
上面的microserviceRequest是封装好的微服务请求方法,出于安全考虑,此方法不放在公网,因此需要业务方自行传入,否则无法使用本组件;
|
|
18
|
+
<br/>
|
|
19
|
+
<br/>至此,地址本注册就完成了
|
|
6
20
|
|
|
7
|
-
###
|
|
8
|
-
|
|
9
|
-
再打包 npm run lib
|
|
21
|
+
### 组件使用
|
|
22
|
+
需要使用地址本的项目要接入cas单点登录，然后注册地址本即可使用。
|
|
10
23
|
|
|
11
|
-
|
|
12
|
-
|
|
24
|
+
``` javascript
|
|
25
|
+
<address-book-shell
|
|
26
|
+
:visible.sync="addredssListVisible"
|
|
27
|
+
:selected="selected"
|
|
28
|
+
:close-on-click-modal="false"
|
|
29
|
+
@submitted="submitAddredss"
|
|
30
|
+
@colse="closeAddress"
|
|
31
|
+
:loginUserinfo="loginUserinfo"
|
|
32
|
+
:append-to-body="true"
|
|
33
|
+
/>
|
|
34
|
+
```
|
|
13
35
|
|
|
14
|
-
###
|
|
36
|
+
### 组件属性
|
|
37
|
+
> 注意:地址本组件继承了element-ui库Dialog组件的全部属性，即Dialog属性全部适用本组件。
|
|
15
38
|
|
|
16
|
-
|
|
39
|
+
地址本自定义属性：
|
|
40
|
+
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
|
41
|
+
| :--- | :--- | :--- | :---: |:---: |
|
|
42
|
+
| selected                        | 地址本初始化默认选中的人员数据 | Array             | - | [] |
|
|
43
|
+
| selectDisabled | 是否将selected传入的人员置灰不能再选 | Boolean | - | false |
|
|
44
|
+
| needPeopleData | 是否只需要人员数据(设置为true不会再返回已选岗位和部门,会将所选全部转换为人员后再返回) | Boolean | - | false |
|
|
45
|
+
| typeList | 用来控制模糊搜索下拉选项内容 | Array | [{ id: '', name: '全部' },{ id: '2', name: '部门' },{ id: '4', name: '岗位' },{ id: '8', name: '人员' },] | [{ id: '', name: '全部' },{ id: '2', name: '部门' },{ id: '4', name: '岗位' },{ id: '8', name: '人员' },] |
|
|
46
|
+
| onlyMailList | 是否只展示通讯录模块 | Boolean | - | false |
|
|
47
|
+
| tabs | 自定义tabs的内容,如果不传或传空数组,将根据身份动态显示合适的模块 | Array | ['通讯录','合作方好友] | [] |
|
|
48
|
+
| radio | 地址本是否只能单选 | Boolean | - | false |
|
|
49
|
+
| title | 地址本标题 | String | - | 地址本 |
|
|
50
|
+
| width | 地址本宽度 | String | - | 800px |
|
|
51
|
+
| customClass | 地址本自定义类名 | String | - | address-modal |
|
|
52
|
+
| noAddRecent | 是否不需要添加最近联系人 | Boolean | - | false |
|
|
53
|
+
| hiddenRecently | 是否隐藏最近联系人模块 | Boolean | - | false |
|
|
54
|
+
| footButton | 自定义功能按钮(check:查看当前名单;collect: 收藏当前名单) | Array | ['check','collect'] | ['check'] |
|
|
55
|
+
| top | 地址本 CSS 中的 margin-topz值 | string | - | 7vh |
|
|
56
|
+
| robotsList | 机器人数据,不传或传[],不会显示机器人模块 | Array | - | [] |
|
|
57
|
+
| loginUserinfo | cas登录返回的用户信息(必传) | Object | - | {} |
|
|
17
58
|
|
|
18
|
-
### 发布到npm
|
|
19
59
|
|
|
20
|
-
|
|
60
|
+
### 组件事件
|
|
61
|
+
> 注意:地址本组件继承了element-ui库Dialog组件的全部事件，即Dialog事件全部适用本组件。
|
|
62
|
+
|
|
63
|
+
组件自定义事件:
|
|
64
|
+
| 事件名称 | 说明 | 回调参数 |
|
|
65
|
+
| :--- | :--- | :-- |
|
|
66
|
+
| submitted | 点击确实按钮的回调 |返回选中的人员数据|
|
|
67
|
+
|