@hz-libs/bpe-ui-datepicker 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +49 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,49 @@
1
+ # @hz-libs/bpe-ui-datepicker
2
+
3
+ Date picker, range picker, and calendar primitives for Vue 3.
4
+
5
+ [Docs](https://hzlibs.pages.dev/components/bpe-ui-datepicker)
6
+
7
+ ## Install
8
+
9
+ ```sh
10
+ pnpm add @hz-libs/bpe-ui-datepicker
11
+ ```
12
+
13
+ The app must already depend on Vue `^3.5.0`. This package depends on `@hz-libs/bpe-ui-popover` and `@hz-libs/bpe-ui-selectbox`. Component CSS is included in the JavaScript import.
14
+
15
+ ## Use
16
+
17
+ `v-model` is a `Date`, or `null` when the field is empty. The field can be cleared. `allow-time-picker` adds a time control. `disable` keeps the current value visible and blocks the calendar.
18
+
19
+ ```vue
20
+ <script setup>
21
+ import { ref } from 'vue'
22
+ import { DatePicker } from '@hz-libs/bpe-ui-datepicker'
23
+
24
+ const date = ref(null)
25
+ </script>
26
+
27
+ <template>
28
+ <DatePicker v-model="date" placeholder="Select a date" />
29
+ </template>
30
+ ```
31
+
32
+ `DateRangePicker` stores a start and an end date in an array.
33
+
34
+ ```vue
35
+ <script setup>
36
+ import { ref } from 'vue'
37
+ import { DateRangePicker } from '@hz-libs/bpe-ui-datepicker'
38
+
39
+ const range = ref([])
40
+ </script>
41
+
42
+ <template>
43
+ <DateRangePicker v-model="range" placeholder="Select a range" />
44
+ </template>
45
+ ```
46
+
47
+ ## Exports
48
+
49
+ `Calendar`, `CalendarRange`, `DatePicker`, `DateRangePicker`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hz-libs/bpe-ui-datepicker",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Date picker, range picker, and calendar primitives.",
5
5
  "type": "module",
6
6
  "sideEffects": [
@@ -20,8 +20,8 @@
20
20
  "vue": "^3.5.0"
21
21
  },
22
22
  "dependencies": {
23
- "@hz-libs/bpe-ui-popover": "0.1.0",
24
- "@hz-libs/bpe-ui-selectbox": "0.1.0"
23
+ "@hz-libs/bpe-ui-popover": "0.1.1",
24
+ "@hz-libs/bpe-ui-selectbox": "0.1.1"
25
25
  },
26
26
  "devDependencies": {
27
27
  "@awesome.me/kit-2a08aed3ec": "^1.0.2",