@featherk/composables 0.5.0 → 0.5.2
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
CHANGED
|
@@ -2,6 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
Vue 3 composables that improve Kendo UI for Vue behavior and accessibility.
|
|
4
4
|
|
|
5
|
+
## Composables Overview
|
|
6
|
+
|
|
7
|
+
- **Grid**: `useGridA11y` — Accessible row-level navigation and column menu keyboard support.
|
|
8
|
+
- Guide: [docs/grid/useGridA11y.md](https://github.com/NantHealth/featherk/blob/integration/packages/composables/docs/grid/useGridA11y.md)
|
|
9
|
+
- **Date**: `useMaskedDateInput` — Masked single-date input with steppers and validation.
|
|
10
|
+
- Guide: [docs/date/useMaskedDateInput.md](https://github.com/NantHealth/featherk/blob/integration/packages/composables/docs/date/useMaskedDateInput.md)
|
|
11
|
+
- **Range**: `useMaskedDateRangeInput` — Masked date range input with validation, clamp, and optional popup coordination.
|
|
12
|
+
- Guide: [docs/range/useMaskedDateRangeInput.md](https://github.com/NantHealth/featherk/blob/integration/packages/composables/docs/range/useMaskedDateRangeInput.md)
|
|
13
|
+
- **Time**: `useMaskedTimeInput` — Masked single-time input with AM/PM conveniences and bounds.
|
|
14
|
+
- Guide: [docs/time/useMaskedTimeInput.md](https://github.com/NantHealth/featherk/blob/integration/packages/composables/docs/time/useMaskedTimeInput.md)
|
|
15
|
+
- **Trap**: `usePopupTrap` — Focus trap + Escape/Outside click close behavior for popups.
|
|
16
|
+
- Guide: [docs/trap/usePopupTrap.md](https://github.com/NantHealth/featherk/blob/integration/packages/composables/docs/trap/usePopupTrap.md)
|
|
17
|
+
|
|
5
18
|
## Importing Composables
|
|
6
19
|
|
|
7
20
|
You can import directly from subpaths or from the package root.
|
|
@@ -9,14 +22,17 @@ You can import directly from subpaths or from the package root.
|
|
|
9
22
|
Subpath imports (recommended for clarity):
|
|
10
23
|
|
|
11
24
|
```ts
|
|
25
|
+
// Grid
|
|
26
|
+
import { useGridA11y } from '@featherk/composables/grid';
|
|
27
|
+
|
|
12
28
|
// Date input
|
|
13
|
-
import { useMaskedDateInput, DateChangePayload } from '@featherk/composables/date';
|
|
29
|
+
import { useMaskedDateInput, type DateChangePayload } from '@featherk/composables/date';
|
|
14
30
|
|
|
15
31
|
// Date range input
|
|
16
|
-
import { useMaskedDateRangeInput, RangeChangePayload } from '@featherk/composables/range';
|
|
32
|
+
import { useMaskedDateRangeInput, type RangeChangePayload } from '@featherk/composables/range';
|
|
17
33
|
|
|
18
34
|
// Time input
|
|
19
|
-
import { useMaskedTimeInput, TimeChangePayload } from '@featherk/composables/time';
|
|
35
|
+
import { useMaskedTimeInput, type TimeChangePayload } from '@featherk/composables/time';
|
|
20
36
|
|
|
21
37
|
// Popup focus trap utilities
|
|
22
38
|
import { usePopupTrap } from '@featherk/composables/trap';
|
|
@@ -27,50 +43,11 @@ Root imports (types are aliased to avoid name collisions):
|
|
|
27
43
|
```ts
|
|
28
44
|
import {
|
|
29
45
|
useMaskedDateInput,
|
|
30
|
-
DateChangePayload,
|
|
31
|
-
useMaskedDateRangeInput,
|
|
32
|
-
RangeChangePayload,
|
|
33
|
-
useMaskedTimeInput,
|
|
34
|
-
TimeChangePayload,
|
|
35
|
-
usePopupTrap,
|
|
36
|
-
} from '@featherk/composables';
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## useGridA11y — Integration Quick Reference
|
|
40
|
-
|
|
41
|
-
## Composables Overview
|
|
42
|
-
|
|
43
|
-
- **Grid**: `useGridA11y` — Accessible row-level navigation and column menu keyboard support.
|
|
44
|
-
- Guide: [docs/grid/useGridA11y.md](./docs/grid/useGridA11y.md)
|
|
45
|
-
- **Date**: `useMaskedDateInput` — Masked single-date input with steppers and validation.
|
|
46
|
-
- Guide: [docs/date/useMaskedDateInput.md](./docs/date/useMaskedDateInput.md)
|
|
47
|
-
- **Range**: `useMaskedDateRangeInput` — Masked date range input with validation, clamp, and optional popup coordination.
|
|
48
|
-
- Guide: [docs/range/useMaskedDateRangeInput.md](./docs/range/useMaskedDateRangeInput.md)
|
|
49
|
-
- **Time**: `useMaskedTimeInput` — Masked single-time input with AM/PM conveniences and bounds.
|
|
50
|
-
- Guide: [docs/time/useMaskedTimeInput.md](./docs/time/useMaskedTimeInput.md)
|
|
51
|
-
- **Trap**: `usePopupTrap` — Focus trap + Escape/Outside click close behavior for popups.
|
|
52
|
-
- Guide: [docs/trap/usePopupTrap.md](./docs/trap/usePopupTrap.md)
|
|
53
|
-
|
|
54
|
-
## Importing
|
|
55
|
-
|
|
56
|
-
Subpath imports (recommended):
|
|
57
|
-
|
|
58
|
-
```ts
|
|
59
|
-
import { useGridA11y } from '@featherk/composables/grid';
|
|
60
|
-
import { useMaskedDateInput } from '@featherk/composables/date';
|
|
61
|
-
import { useMaskedDateRangeInput } from '@featherk/composables/range';
|
|
62
|
-
import { useMaskedTimeInput } from '@featherk/composables/time';
|
|
63
|
-
import { usePopupTrap } from '@featherk/composables/trap';
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
Root import (types are aliased to avoid collisions):
|
|
67
|
-
|
|
68
|
-
```ts
|
|
69
|
-
import {
|
|
70
|
-
useGridA11y,
|
|
71
|
-
useMaskedDateInput,
|
|
46
|
+
type DateChangePayload,
|
|
72
47
|
useMaskedDateRangeInput,
|
|
48
|
+
type RangeChangePayload,
|
|
73
49
|
useMaskedTimeInput,
|
|
50
|
+
type TimeChangePayload,
|
|
74
51
|
usePopupTrap,
|
|
75
52
|
} from '@featherk/composables';
|
|
76
53
|
```
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# useMaskedDateInput
|
|
2
2
|
|
|
3
|
-
[← Back to Composables README](
|
|
3
|
+
[← Back to Composables README](https://github.com/NantHealth/featherk/blob/integration/packages/composables/README.md)
|
|
4
4
|
|
|
5
5
|
Composable for a masked single-date input that pairs naturally with Kendo Vue `MaskedTextBox`, and optionally coordinates with a `DatePicker`. It handles typed input in the mask `MM/DD/YYYY`, keyboard steppers (ArrowUp/ArrowDown), wheel steppers, caret persistence, min/max range validation, and clean emission only when the input is complete and valid.
|
|
6
6
|
|
package/docs/grid/useGridA11y.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# useGridA11y
|
|
2
2
|
|
|
3
|
-
[← Back to Composables README](
|
|
3
|
+
[← Back to Composables README](https://github.com/NantHealth/featherk/blob/integration/packages/composables/README.md)
|
|
4
4
|
|
|
5
5
|
Composable that augments a Kendo Vue Grid with accessible keyboard navigation, focus management, and custom behaviors for column header menus (filter/sort).
|
|
6
6
|
|
|
@@ -10,7 +10,7 @@ Composable that augments a Kendo Vue Grid with accessible keyboard navigation, f
|
|
|
10
10
|
- `@progress/kendo-vue-grid`
|
|
11
11
|
- `@featherk/composables`
|
|
12
12
|
|
|
13
|
-
Install
|
|
13
|
+
Install:
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
16
|
npm install @featherk/composables
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# useMaskedDateRangeInput
|
|
2
2
|
|
|
3
|
-
[← Back to Composables README](
|
|
3
|
+
[← Back to Composables README](https://github.com/NantHealth/featherk/blob/integration/packages/composables/README.md)
|
|
4
4
|
|
|
5
5
|
Composable for a masked date range input that pairs naturally with Kendo Vue `MaskedTextBox` and `Calendar`. It handles typed input in the mask `MM/DD/YYYY - MM/DD/YYYY`, keyboard steppers (ArrowUp/ArrowDown), wheel steppers, caret persistence, min/max clamping, ordered range validation, span calculation, and optional popup-close coordination when the calendar sets the value.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# useMaskedTimeInput
|
|
2
2
|
|
|
3
|
-
[← Back to Composables README](
|
|
3
|
+
[← Back to Composables README](https://github.com/NantHealth/featherk/blob/integration/packages/composables/README.md)
|
|
4
4
|
|
|
5
5
|
Composable for a masked single-time input that pairs naturally with Kendo Vue `MaskedTextBox`, and optionally coordinates with a `TimePicker`. It handles typed input in the mask `hh:mm AM`, keyboard steppers (ArrowUp/ArrowDown), wheel steppers, caret persistence, minute step granularity, min/max time validation, and clean emission only when the input is complete and valid.
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# usePopupTrap
|
|
2
2
|
|
|
3
|
-
[← Back to Composables README](
|
|
3
|
+
[← Back to Composables README](https://github.com/NantHealth/featherk/blob/integration/packages/composables/README.md)
|
|
4
4
|
|
|
5
5
|
Composable for managing focus trapping and close behavior for popup UIs (e.g., Kendo `Popup`, `DatePicker`, `TimePicker` dropdowns). It provides focus trapping via `@vueuse/integrations/useFocusTrap`, Escape/OutsideClick to close, automatic popup element discovery, and optional return-to-trigger focus.
|
|
6
6
|
|