time-range-picker 0.1.28 → 3.0.1

package/README.md

@@ -6,12 +6,20 @@
 yarn add time-range-picker
 npm i time-range-picker
 
-依赖项：element-ui
+依赖项：element-plus
 ```
 
 ### 使用
+```js
+// 局部注册
+import TimeRangePicker from 'TimeRangePicker'
 
-`<TimeRangePicker :start.sync="time.start" :end.sync="time.end" />`
+// 全局注册
+import TimeRangePicker from 'TimeRangePicker'
+Vue.use(TimeRangePicker)
+
+// 使用
+<TimeRangePicker v-model:start="time.start" v-model:end="time.end" />
 
 ### 参数
 
@@ -24,10 +32,8 @@ npm i time-range-picker
 | value-format          | 值类型                                           | String        | 见下方说明 3            |                                             |
 | disabled              | 是否禁用                                         | Boolean       |                         | false                                       |
 | size                  | 组件大小                                         | String        | large medium small mini | medium                                      |
-| defaultDate(即将弃用) | 设置默认时间，可以选择设置是当前年范围还是月范围 | String, Array | 见下方说明 5            | ''                                          |
-| pickerOptions         | 附加参数                                         | Object        | 见下方说明 4            | {start: '00:00',step: '00:60',end: '23:00'}|
-| clearable         | 是否显示清除按钮                                         | Boolean        |             | true |
-
+| pickerOptions         | 附加参数                                         | Object        | 见下方说明 4            | {start: '00:00',step: '00:60',end: '23:00'} |
+| clearable             | 是否显示清除按钮                                 | Boolean       |                         | true                                        |
 
 ### 说明 1（type 可选项）
 
@@ -76,23 +82,15 @@ startDisabledDate(time, start, end) 开始时间限制方法 (date date-time 有
 endDisabledDate(time, start, end) 结束时间限制方法 (date date-time 有效，同原生disabledDate方法, 后面的第二和第三个参数是开始时间和结束时间)
 ```
 
-### 说明 5 （defaultDate 即将弃用） 设置默认值
-
-```
-thisYear     本年第一天今天
-thisMonth    本月第一天到今天
-pastOneYear  近一年
-pastOneMonth 近一月
-
-其他： 可以直接设置为一个数组，数组第一位和第二位对应start和end
-
-注意：如果需要点击表单重置时，恢复到默认设置的值，需要设置默认值为null或undefined
+#### 组件默认导出了常见的几个时间：
+
+```ts
+interface CommonDate {
+  currentYear: string[], 本年第一天到今天
+  currentMonth: string[], 本月第一天到今天
+  currentDay: string[], 本日0点到23点
+  pastOneYear: string[], 近一年
+  pastOneMonth: string[], 近一月
+  nowDate: string, 当前时间
+}
 ```
-
-#### 注意：现已升级，设置默认时间可不用 defaultDate 设置，直接给 start 和 end 设置即可，组件默认导出了常见的几个时间：
-
-- currentYear 本年第一天到今天
-- currentMonth 本月第一天到今天
-- pastOneYear 近一年
-- pastOneMonth 近一月
-- nowDate 当前时间