You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

231 lines
12 KiB

2 years ago
2 years ago
2 years ago
  1. ### mdp-date-range
  2. 该组件相对于el-date-range,进行了以下两项优化:
  3. #### 一、showStyle
  4. - 提供origin\tag\x三种样式
  5. - 可以直接传入一个对象,指定start-key,end-key,自动更新对象对应的属性。免去一堆的转换过程
  6. 1. `origin`
  7. ```vue
  8. <mdp-date-range show-style="origin" :value="formData"/>
  9. ...
  10. data() {
  11. return {
  12. formData:
  13. [ '2024-01-09 00:00:00','2024-03-09 00:00:00']
  14. }
  15. },
  16. ```
  17. <img src="../../../../docs/images/ui-components/mdp-date-range/image-20240111103632183.png" alt="image-20240111103632183" style="zoom:50%;" />
  18. 2. `x`
  19. ```vue
  20. <mdp-date-range show-style="x" :value="formData" style="border: 1px solid">
  21. <template v-slot:avater><p>&#9733;</p></template> <!-- 自定义图标-->
  22. <template v-slot:info>自定义内容</template>
  23. </mdp-date-range>
  24. ```
  25. <img src="../../../../docs/images/ui-components/mdp-date-range/image-20240111110136191.png" alt="image-20240111110136191" style="zoom:50%;" />
  26. <img src="../../../../docs/images/ui-components/mdp-date-range/image-20240111110148521.png" alt="image-20240111110148521" style="zoom:50%;" />
  27. 3. tag
  28. ```vue
  29. <mdp-date-range show-style="tag" style="border: 1px solid">
  30. <!-- 默认图标-->
  31. <template v-slot:info>自定义内容</template>
  32. </mdp-date-range>
  33. ```
  34. <img src="../../../../docs/images/ui-components/mdp-date-range/image-20240111105902269.png" alt="image-202401111059022269" style="zoom:50%;" />
  35. <img src="../../../../docs/images/ui-components/mdp-date-range/image-20240111105909638.png" alt="image-202401111105909638" style="zoom:50%;" />
  36. #### 二、value + @change事件
  37. ```vue
  38. <mdp-date-range :value="formData" @change="change"/>
  39. ```
  40. ```js
  41. data() {
  42. return {
  43. status: "login",
  44. formData:
  45. ['2024-01-09 00:00:00', '2024-03-09 00:00:00'] // 初始化值
  46. }
  47. },
  48. methods: {
  49. change(dates) {
  50. this.formData = dates
  51. }
  52. },
  53. ```
  54. #### 三、startKey 和 endKey
  55. 当传入的value是一个对象时,可以设置starKey和endKey来指定key
  56. ```vue
  57. <mdp-date-range show-style="origin" :value="formData" start-key="startDate" end-key="endDate"
  58. @change="change">
  59. ```
  60. ```js
  61. data() {
  62. return {
  63. formData: {
  64. account:'xxxxx',
  65. ....
  66. startDate: '2024-01-09 00:00:00',
  67. endDate: '2024-03-09 00:00:00'
  68. }
  69. }
  70. },
  71. methods: {
  72. change(dates) {
  73. this.formData = dates
  74. }
  75. },
  76. ```
  77. #### 四、styleObj
  78. 组件的样式
  79. ```vue
  80. <mdp-date-range :styleObj="{ backgroundColor: 'green' }"/>
  81. ```
  82. <img src="../../../../docs/images/ui-components/mdp-date-range/image-20240111144543586.png" alt="image-20240111144543586" style="zoom:50%;" />
  83. #### 五、autoDefault 和 defaultRange
  84. autoDefault 是否根据 defaultRange 生成一个时间跨度
  85. defaultRange = [-1, 1] = [ 当前时间 -1, 当前时间 +1 ]
  86. ```vue
  87. <mdp-date-range :auto-default="true" :default-range="[-1, 1]"/>
  88. ```
  89. <img src="../../../../docs/images/ui-components/mdp-date-range/image-20240111150728697.png" alt="image-20240111150728697" style="zoom:50%;" />
  90. #### 六 icon
  91. 与Attributes表的 prefix-icon 想同,自定义头部图标,只有 x 和 tag 样式下
  92. ```vue
  93. <mdp-date-range show-style="x" icon="el-icon-phone"/>
  94. <mdp-date-range show-style="tag" icon="el-icon-phone"/>
  95. ```
  96. showavater Disabled label type
  97. #### 自定义属性
  98. | 参数 | 说明 | 类型 | 可选值 | 默认值 |
  99. | --------- | ---------------------- | ------- | ------ | ------ |
  100. | showStyle | 设置组件的样式 | String | — | origin |
  101. | disabled | 是否禁止鼠标事件的触发 | Boolean | — | false |
  102. ### 用法
  103. #### 对象的方式
  104. ```js
  105. var formData={startDate:'',endDate:''}
  106. ```
  107. ```html
  108. <mdp-date-range v-model="formData" start-key='startDate' end-key="endDate"/>
  109. ```
  110. #### 数组的方式
  111. ```js
  112. var dates=[]
  113. ```
  114. ```html
  115. <mdp-date-range v-model="dates"/>
  116. ```
  117. #### element ui
  118. ### Attributes
  119. | 参数 | 说明 | 类型 | 可选值 | 默认值 |
  120. | ----------------- | ---------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------ | -------------------- |
  121. | value / v-model | 绑定值 | date(DatePicker) / array(DateRangePicker) | — | — |
  122. | readonly | 完全只读 | boolean | — | false |
  123. | disabled | 禁用 | boolean | — | false |
  124. | editable | 文本框可输入 | boolean | — | true |
  125. | clearable | 是否显示清除按钮 | boolean | — | true |
  126. | size | 输入框尺寸 | string | large, small, mini | — |
  127. | placeholder | 非范围选择时的占位内容 | string | — | — |
  128. | start-placeholder | 范围选择时开始日期的占位内容 | string | — | 开始日期 |
  129. | end-placeholder | 范围选择时结束日期的占位内容 | string | — | 结束日期 |
  130. | type | 显示类型 | string | year/month/date/dates/months/years week/datetime/datetimerange/ daterange/monthrange | date |
  131. | format | 显示在输入框中的格式 | string | 见[日期格式](https://element.eleme.cn/#/zh-CN/component/date-picker#ri-qi-ge-shi) | yyyy-MM-dd |
  132. | align | 对齐方式 | string | left, center, right | left |
  133. | popper-class | DatePicker 下拉框的类名 | string | — | — |
  134. | picker-options | 当前时间日期选择器特有的选项参考下表 | object | — | [{...略...}}] |
  135. | range-separator | 选择范围时的分隔符 | string | — | '~' |
  136. | default-value | 可选,选择器打开时默认显示的时间 | Date | 可被`new Date()`解析 | — |
  137. | default-time | 范围选择时选中日期所使用的当日内具体时刻 | string[] | 数组,长度为 2,每项值为字符串,形如`12:00:00`,第一项指定开始日期的时刻,第二项指定结束日期的时刻,不指定会使用时刻 `00:00:00` | — |
  138. | value-format | 可选,绑定值的格式。不指定则绑定值为 Date 对象 | string | 见[日期格式](https://element.eleme.cn/#/zh-CN/component/date-picker#ri-qi-ge-shi) | yyyy-MM-dd HH:mm:ss |
  139. | name | 原生属性 | string | — | — |
  140. | unlink-panels | 在范围选择器里取消两个日期面板之间的联动 | boolean | — | false |
  141. | prefix-icon | 自定义头部图标的类名 | string | — | el-icon-date |
  142. | clear-icon | 自定义清空图标的类名 | string | — | el-icon-circle-close |
  143. | validate-event | 输入时是否触发表单的校验 | boolean | - | true |
  144. | append-to-body | DetePicker 自身是否插入至 body 元素上。 | boolean | — | true |
  145. ### Picker Options
  146. | 参数 | 说明 | 类型 | 可选值 | 默认值 |
  147. | -------------- | ------------------------------------------------------------ | ------------------------------ | ------ | ------ |
  148. | shortcuts | 设置快捷选项,需要传入 { text, onClick } 对象用法参考 demo 或下表 | Object[] | — | — |
  149. | disabledDate | 设置禁用状态,参数为当前日期,要求返回 Boolean | Function | — | — |
  150. | cellClassName | 设置日期的 className | Function(Date) | — | — |
  151. | firstDayOfWeek | 周起始日 | Number | 1 到 7 | 7 |
  152. | onPick | 选中日期后会执行的回调,只有当 `daterange``datetimerange` 才生效 | Function({ maxDate, minDate }) | — | — |
  153. ### Shortcuts
  154. | 参数 | 说明 | 类型 | 可选值 | 默认值 |
  155. | ------- | ------------------------------------------------------------ | -------- | ------ | ------ |
  156. | text | 标题文本 | string | — | — |
  157. | onClick | 选中后的回调函数,参数是 vm,可通过触发 'pick' 事件设置选择器的值。例如 vm.$emit('pick', new Date()) | function | — | — |
  158. ### Events
  159. | 事件名称 | 说明 | 回调参数 | | |
  160. | -------- | ----------------------- | ------------------------------------------------------ | ---- | ---- |
  161. | change | 用户确认选定的值时触发 | 组件绑定值。格式与绑定值一致,可受 `value-format` 控制 | | |
  162. | blur | 当 input 失去焦点时触发 | 组件实例 | | |
  163. | focus | 当 input 获得焦点时触发 | 组件实例 | | |
  164. ### Methods
  165. | 方法名 | 说明 | 参数 |
  166. | ------ | ----------------- | ---- |
  167. | focus | 使 input 获取焦点 | — |