@react-stately/datepicker 3.0.0-nightly.3113 → 3.0.0-nightly.3114
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/dist/ar-AE.main.js +9 -0
- package/dist/ar-AE.main.js.map +1 -0
- package/dist/ar-AE.mjs +11 -0
- package/dist/ar-AE.module.js +11 -0
- package/dist/ar-AE.module.js.map +1 -0
- package/dist/bg-BG.main.js +9 -0
- package/dist/bg-BG.main.js.map +1 -0
- package/dist/bg-BG.mjs +11 -0
- package/dist/bg-BG.module.js +11 -0
- package/dist/bg-BG.module.js.map +1 -0
- package/dist/cs-CZ.main.js +9 -0
- package/dist/cs-CZ.main.js.map +1 -0
- package/dist/cs-CZ.mjs +11 -0
- package/dist/cs-CZ.module.js +11 -0
- package/dist/cs-CZ.module.js.map +1 -0
- package/dist/da-DK.main.js +9 -0
- package/dist/da-DK.main.js.map +1 -0
- package/dist/da-DK.mjs +11 -0
- package/dist/da-DK.module.js +11 -0
- package/dist/da-DK.module.js.map +1 -0
- package/dist/de-DE.main.js +9 -0
- package/dist/de-DE.main.js.map +1 -0
- package/dist/de-DE.mjs +11 -0
- package/dist/de-DE.module.js +11 -0
- package/dist/de-DE.module.js.map +1 -0
- package/dist/el-GR.main.js +9 -0
- package/dist/el-GR.main.js.map +1 -0
- package/dist/el-GR.mjs +11 -0
- package/dist/el-GR.module.js +11 -0
- package/dist/el-GR.module.js.map +1 -0
- package/dist/en-US.main.js +9 -0
- package/dist/en-US.main.js.map +1 -0
- package/dist/en-US.mjs +11 -0
- package/dist/en-US.module.js +11 -0
- package/dist/en-US.module.js.map +1 -0
- package/dist/es-ES.main.js +9 -0
- package/dist/es-ES.main.js.map +1 -0
- package/dist/es-ES.mjs +11 -0
- package/dist/es-ES.module.js +11 -0
- package/dist/es-ES.module.js.map +1 -0
- package/dist/et-EE.main.js +9 -0
- package/dist/et-EE.main.js.map +1 -0
- package/dist/et-EE.mjs +11 -0
- package/dist/et-EE.module.js +11 -0
- package/dist/et-EE.module.js.map +1 -0
- package/dist/fi-FI.main.js +9 -0
- package/dist/fi-FI.main.js.map +1 -0
- package/dist/fi-FI.mjs +11 -0
- package/dist/fi-FI.module.js +11 -0
- package/dist/fi-FI.module.js.map +1 -0
- package/dist/fr-FR.main.js +9 -0
- package/dist/fr-FR.main.js.map +1 -0
- package/dist/fr-FR.mjs +11 -0
- package/dist/fr-FR.module.js +11 -0
- package/dist/fr-FR.module.js.map +1 -0
- package/dist/he-IL.main.js +9 -0
- package/dist/he-IL.main.js.map +1 -0
- package/dist/he-IL.mjs +11 -0
- package/dist/he-IL.module.js +11 -0
- package/dist/he-IL.module.js.map +1 -0
- package/dist/hr-HR.main.js +9 -0
- package/dist/hr-HR.main.js.map +1 -0
- package/dist/hr-HR.mjs +11 -0
- package/dist/hr-HR.module.js +11 -0
- package/dist/hr-HR.module.js.map +1 -0
- package/dist/hu-HU.main.js +9 -0
- package/dist/hu-HU.main.js.map +1 -0
- package/dist/hu-HU.mjs +11 -0
- package/dist/hu-HU.module.js +11 -0
- package/dist/hu-HU.module.js.map +1 -0
- package/dist/import.mjs +23 -0
- package/dist/intlStrings.main.js +108 -0
- package/dist/intlStrings.main.js.map +1 -0
- package/dist/intlStrings.mjs +110 -0
- package/dist/intlStrings.module.js +110 -0
- package/dist/intlStrings.module.js.map +1 -0
- package/dist/it-IT.main.js +9 -0
- package/dist/it-IT.main.js.map +1 -0
- package/dist/it-IT.mjs +11 -0
- package/dist/it-IT.module.js +11 -0
- package/dist/it-IT.module.js.map +1 -0
- package/dist/ja-JP.main.js +9 -0
- package/dist/ja-JP.main.js.map +1 -0
- package/dist/ja-JP.mjs +11 -0
- package/dist/ja-JP.module.js +11 -0
- package/dist/ja-JP.module.js.map +1 -0
- package/dist/ko-KR.main.js +9 -0
- package/dist/ko-KR.main.js.map +1 -0
- package/dist/ko-KR.mjs +11 -0
- package/dist/ko-KR.module.js +11 -0
- package/dist/ko-KR.module.js.map +1 -0
- package/dist/lt-LT.main.js +9 -0
- package/dist/lt-LT.main.js.map +1 -0
- package/dist/lt-LT.mjs +11 -0
- package/dist/lt-LT.module.js +11 -0
- package/dist/lt-LT.module.js.map +1 -0
- package/dist/lv-LV.main.js +9 -0
- package/dist/lv-LV.main.js.map +1 -0
- package/dist/lv-LV.mjs +11 -0
- package/dist/lv-LV.module.js +11 -0
- package/dist/lv-LV.module.js.map +1 -0
- package/dist/main.js +19 -744
- package/dist/main.js.map +1 -1
- package/dist/module.js +16 -730
- package/dist/module.js.map +1 -1
- package/dist/nb-NO.main.js +9 -0
- package/dist/nb-NO.main.js.map +1 -0
- package/dist/nb-NO.mjs +11 -0
- package/dist/nb-NO.module.js +11 -0
- package/dist/nb-NO.module.js.map +1 -0
- package/dist/nl-NL.main.js +9 -0
- package/dist/nl-NL.main.js.map +1 -0
- package/dist/nl-NL.mjs +11 -0
- package/dist/nl-NL.module.js +11 -0
- package/dist/nl-NL.module.js.map +1 -0
- package/dist/pl-PL.main.js +9 -0
- package/dist/pl-PL.main.js.map +1 -0
- package/dist/pl-PL.mjs +11 -0
- package/dist/pl-PL.module.js +11 -0
- package/dist/pl-PL.module.js.map +1 -0
- package/dist/placeholders.main.js +409 -0
- package/dist/placeholders.main.js.map +1 -0
- package/dist/placeholders.mjs +404 -0
- package/dist/placeholders.module.js +404 -0
- package/dist/placeholders.module.js.map +1 -0
- package/dist/pt-BR.main.js +9 -0
- package/dist/pt-BR.main.js.map +1 -0
- package/dist/pt-BR.mjs +11 -0
- package/dist/pt-BR.module.js +11 -0
- package/dist/pt-BR.module.js.map +1 -0
- package/dist/pt-PT.main.js +9 -0
- package/dist/pt-PT.main.js.map +1 -0
- package/dist/pt-PT.mjs +11 -0
- package/dist/pt-PT.module.js +11 -0
- package/dist/pt-PT.module.js.map +1 -0
- package/dist/ro-RO.main.js +9 -0
- package/dist/ro-RO.main.js.map +1 -0
- package/dist/ro-RO.mjs +11 -0
- package/dist/ro-RO.module.js +11 -0
- package/dist/ro-RO.module.js.map +1 -0
- package/dist/ru-RU.main.js +9 -0
- package/dist/ru-RU.main.js.map +1 -0
- package/dist/ru-RU.mjs +11 -0
- package/dist/ru-RU.module.js +11 -0
- package/dist/ru-RU.module.js.map +1 -0
- package/dist/sk-SK.main.js +9 -0
- package/dist/sk-SK.main.js.map +1 -0
- package/dist/sk-SK.mjs +11 -0
- package/dist/sk-SK.module.js +11 -0
- package/dist/sk-SK.module.js.map +1 -0
- package/dist/sl-SI.main.js +9 -0
- package/dist/sl-SI.main.js.map +1 -0
- package/dist/sl-SI.mjs +11 -0
- package/dist/sl-SI.module.js +11 -0
- package/dist/sl-SI.module.js.map +1 -0
- package/dist/sr-SP.main.js +9 -0
- package/dist/sr-SP.main.js.map +1 -0
- package/dist/sr-SP.mjs +11 -0
- package/dist/sr-SP.module.js +11 -0
- package/dist/sr-SP.module.js.map +1 -0
- package/dist/sv-SE.main.js +9 -0
- package/dist/sv-SE.main.js.map +1 -0
- package/dist/sv-SE.mjs +11 -0
- package/dist/sv-SE.module.js +11 -0
- package/dist/sv-SE.module.js.map +1 -0
- package/dist/tr-TR.main.js +9 -0
- package/dist/tr-TR.main.js.map +1 -0
- package/dist/tr-TR.mjs +11 -0
- package/dist/tr-TR.module.js +11 -0
- package/dist/tr-TR.module.js.map +1 -0
- package/dist/types.d.ts +208 -41
- package/dist/types.d.ts.map +1 -1
- package/dist/uk-UA.main.js +9 -0
- package/dist/uk-UA.main.js.map +1 -0
- package/dist/uk-UA.mjs +11 -0
- package/dist/uk-UA.module.js +11 -0
- package/dist/uk-UA.module.js.map +1 -0
- package/dist/useDateFieldState.main.js +449 -0
- package/dist/useDateFieldState.main.js.map +1 -0
- package/dist/useDateFieldState.mjs +444 -0
- package/dist/useDateFieldState.module.js +444 -0
- package/dist/useDateFieldState.module.js.map +1 -0
- package/dist/useDatePickerState.main.js +138 -0
- package/dist/useDatePickerState.main.js.map +1 -0
- package/dist/useDatePickerState.mjs +133 -0
- package/dist/useDatePickerState.module.js +133 -0
- package/dist/useDatePickerState.module.js.map +1 -0
- package/dist/useDateRangePickerState.main.js +245 -0
- package/dist/useDateRangePickerState.main.js.map +1 -0
- package/dist/useDateRangePickerState.mjs +240 -0
- package/dist/useDateRangePickerState.module.js +240 -0
- package/dist/useDateRangePickerState.module.js.map +1 -0
- package/dist/useTimeFieldState.main.js +86 -0
- package/dist/useTimeFieldState.main.js.map +1 -0
- package/dist/useTimeFieldState.mjs +81 -0
- package/dist/useTimeFieldState.module.js +81 -0
- package/dist/useTimeFieldState.module.js.map +1 -0
- package/dist/utils.main.js +190 -0
- package/dist/utils.main.js.map +1 -0
- package/dist/utils.mjs +179 -0
- package/dist/utils.module.js +179 -0
- package/dist/utils.module.js.map +1 -0
- package/dist/zh-CN.main.js +9 -0
- package/dist/zh-CN.main.js.map +1 -0
- package/dist/zh-CN.mjs +11 -0
- package/dist/zh-CN.module.js +11 -0
- package/dist/zh-CN.module.js.map +1 -0
- package/dist/zh-TW.main.js +9 -0
- package/dist/zh-TW.main.js.map +1 -0
- package/dist/zh-TW.mjs +11 -0
- package/dist/zh-TW.module.js +11 -0
- package/dist/zh-TW.module.js.map +1 -0
- package/package.json +16 -9
- package/src/index.ts +9 -4
- package/src/placeholders.ts +108 -0
- package/src/{useDatePickerFieldState.ts → useDateFieldState.ts} +199 -59
- package/src/useDatePickerState.ts +104 -32
- package/src/useDateRangePickerState.ts +155 -55
- package/src/useTimeFieldState.ts +37 -12
- package/src/utils.ts +140 -18
|
@@ -10,34 +10,78 @@
|
|
|
10
10
|
* governing permissions and limitations under the License.
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
import {DateFormatter,
|
|
13
|
+
|
|
14
|
+
import {DateFormatter, toCalendarDate, toCalendarDateTime} from '@internationalized/date';
|
|
15
15
|
import {DateRange, DateRangePickerProps, DateValue, Granularity, TimeValue} from '@react-types/datepicker';
|
|
16
|
+
import {FieldOptions, FormatterOptions, getFormatOptions, getPlaceholderTime, getRangeValidationResult, useDefaultProps} from './utils';
|
|
17
|
+
import {FormValidationState, useFormValidationState} from '@react-stately/form';
|
|
18
|
+
import {OverlayTriggerState, useOverlayTriggerState} from '@react-stately/overlays';
|
|
16
19
|
import {RangeValue, ValidationState} from '@react-types/shared';
|
|
17
20
|
import {useControlledState} from '@react-stately/utils';
|
|
18
|
-
import {
|
|
21
|
+
import {useMemo, useState} from 'react';
|
|
22
|
+
|
|
23
|
+
export interface DateRangePickerStateOptions<T extends DateValue = DateValue> extends DateRangePickerProps<T> {
|
|
24
|
+
/**
|
|
25
|
+
* Determines whether the date picker popover should close automatically when a date is selected.
|
|
26
|
+
* @default true
|
|
27
|
+
*/
|
|
28
|
+
shouldCloseOnSelect?: boolean | (() => boolean)
|
|
29
|
+
}
|
|
19
30
|
|
|
20
31
|
type TimeRange = RangeValue<TimeValue>;
|
|
21
|
-
export interface DateRangePickerState {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
32
|
+
export interface DateRangePickerState extends OverlayTriggerState, FormValidationState {
|
|
33
|
+
/** The currently selected date range. */
|
|
34
|
+
value: DateRange | null,
|
|
35
|
+
/** Sets the selected date range. */
|
|
36
|
+
setValue(value: DateRange | null): void,
|
|
37
|
+
/**
|
|
38
|
+
* The date portion of the selected range. This may be set prior to `value` if the user has
|
|
39
|
+
* selected a date range but has not yet selected a time range.
|
|
40
|
+
*/
|
|
41
|
+
dateRange: DateRange | null,
|
|
42
|
+
/** Sets the date portion of the selected range. */
|
|
43
|
+
setDateRange(value: DateRange): void,
|
|
44
|
+
/**
|
|
45
|
+
* The time portion of the selected range. This may be set prior to `value` if the user has
|
|
46
|
+
* selected a time range but has not yet selected a date range.
|
|
47
|
+
*/
|
|
48
|
+
timeRange: TimeRange | null,
|
|
49
|
+
/** Sets the time portion of the selected range. */
|
|
50
|
+
setTimeRange(value: TimeRange): void,
|
|
51
|
+
/** Sets the date portion of either the start or end of the selected range. */
|
|
52
|
+
setDate(part: 'start' | 'end', value: DateValue): void,
|
|
53
|
+
/** Sets the time portion of either the start or end of the selected range. */
|
|
54
|
+
setTime(part: 'start' | 'end', value: TimeValue): void,
|
|
55
|
+
/** Sets the date and time of either the start or end of the selected range. */
|
|
56
|
+
setDateTime(part: 'start' | 'end', value: DateValue): void,
|
|
57
|
+
/** The granularity for the field, based on the `granularity` prop and current value. */
|
|
58
|
+
granularity: Granularity,
|
|
59
|
+
/** Whether the date range picker supports selecting times, according to the `granularity` prop and current value. */
|
|
60
|
+
hasTime: boolean,
|
|
61
|
+
/** Whether the calendar popover is currently open. */
|
|
31
62
|
isOpen: boolean,
|
|
32
|
-
|
|
63
|
+
/** Sets whether the calendar popover is open. */
|
|
64
|
+
setOpen(isOpen: boolean): void,
|
|
65
|
+
/**
|
|
66
|
+
* The current validation state of the date range picker, based on the `validationState`, `minValue`, and `maxValue` props.
|
|
67
|
+
* @deprecated Use `isInvalid` instead.
|
|
68
|
+
*/
|
|
33
69
|
validationState: ValidationState,
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
70
|
+
/** Whether the date range picker is invalid, based on the `isInvalid`, `minValue`, and `maxValue` props. */
|
|
71
|
+
isInvalid: boolean,
|
|
72
|
+
/** Formats the selected range using the given options. */
|
|
73
|
+
formatValue(locale: string, fieldOptions: FieldOptions): {start: string, end: string},
|
|
74
|
+
/** Gets a formatter based on state's props. */
|
|
75
|
+
getDateFormatter(locale: string, formatOptions: FormatterOptions): DateFormatter
|
|
37
76
|
}
|
|
38
77
|
|
|
39
|
-
|
|
40
|
-
|
|
78
|
+
/**
|
|
79
|
+
* Provides state management for a date range picker component.
|
|
80
|
+
* A date range picker combines two DateFields and a RangeCalendar popover to allow
|
|
81
|
+
* users to enter or select a date and time range.
|
|
82
|
+
*/
|
|
83
|
+
export function useDateRangePickerState<T extends DateValue = DateValue>(props: DateRangePickerStateOptions<T>): DateRangePickerState {
|
|
84
|
+
let overlayState = useOverlayTriggerState(props);
|
|
41
85
|
let [controlledValue, setControlledValue] = useControlledState<DateRange>(props.value, props.defaultValue || null, props.onChange);
|
|
42
86
|
let [placeholderValue, setPlaceholderValue] = useState(() => controlledValue || {start: null, end: null});
|
|
43
87
|
|
|
@@ -48,12 +92,9 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
48
92
|
}
|
|
49
93
|
|
|
50
94
|
let value = controlledValue || placeholderValue;
|
|
51
|
-
let valueRef = useRef(value);
|
|
52
|
-
valueRef.current = value;
|
|
53
95
|
|
|
54
96
|
let setValue = (value: DateRange) => {
|
|
55
|
-
|
|
56
|
-
setPlaceholderValue(value);
|
|
97
|
+
setPlaceholderValue(value || {start: null, end: null});
|
|
57
98
|
if (value?.start && value.end) {
|
|
58
99
|
setControlledValue(value);
|
|
59
100
|
} else {
|
|
@@ -63,7 +104,8 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
63
104
|
|
|
64
105
|
let v = (value?.start || value?.end || props.placeholderValue);
|
|
65
106
|
let [granularity, defaultTimeZone] = useDefaultProps(v, props.granularity);
|
|
66
|
-
let hasTime = granularity === 'hour' || granularity === 'minute' || granularity === 'second'
|
|
107
|
+
let hasTime = granularity === 'hour' || granularity === 'minute' || granularity === 'second';
|
|
108
|
+
let shouldCloseOnSelect = props.shouldCloseOnSelect ?? true;
|
|
67
109
|
|
|
68
110
|
let [dateRange, setSelectedDateRange] = useState<DateRange>(null);
|
|
69
111
|
let [timeRange, setSelectedTimeRange] = useState<TimeRange>(null);
|
|
@@ -77,27 +119,35 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
77
119
|
|
|
78
120
|
let commitValue = (dateRange: DateRange, timeRange: TimeRange) => {
|
|
79
121
|
setValue({
|
|
80
|
-
start: 'timeZone' in timeRange.start ? timeRange.start.set(
|
|
81
|
-
end: 'timeZone' in timeRange.end ? timeRange.end.set(
|
|
122
|
+
start: 'timeZone' in timeRange.start ? timeRange.start.set(toCalendarDate(dateRange.start)) : toCalendarDateTime(dateRange.start, timeRange.start),
|
|
123
|
+
end: 'timeZone' in timeRange.end ? timeRange.end.set(toCalendarDate(dateRange.end)) : toCalendarDateTime(dateRange.end, timeRange.end)
|
|
82
124
|
});
|
|
125
|
+
setSelectedDateRange(null);
|
|
126
|
+
setSelectedTimeRange(null);
|
|
127
|
+
validation.commitValidation();
|
|
83
128
|
};
|
|
84
129
|
|
|
85
130
|
// Intercept setValue to make sure the Time section is not changed by date selection in Calendar
|
|
86
131
|
let setDateRange = (range: DateRange) => {
|
|
132
|
+
let shouldClose = typeof shouldCloseOnSelect === 'function' ? shouldCloseOnSelect() : shouldCloseOnSelect;
|
|
87
133
|
if (hasTime) {
|
|
88
|
-
if (range.start && range.end && timeRange?.start && timeRange?.end) {
|
|
89
|
-
commitValue(range,
|
|
134
|
+
if (shouldClose || (range.start && range.end && timeRange?.start && timeRange?.end)) {
|
|
135
|
+
commitValue(range, {
|
|
136
|
+
start: timeRange?.start || getPlaceholderTime(props.placeholderValue),
|
|
137
|
+
end: timeRange?.end || getPlaceholderTime(props.placeholderValue)
|
|
138
|
+
});
|
|
90
139
|
} else {
|
|
91
140
|
setSelectedDateRange(range);
|
|
92
141
|
}
|
|
93
142
|
} else if (range.start && range.end) {
|
|
94
143
|
setValue(range);
|
|
144
|
+
validation.commitValidation();
|
|
95
145
|
} else {
|
|
96
146
|
setSelectedDateRange(range);
|
|
97
147
|
}
|
|
98
148
|
|
|
99
|
-
if (
|
|
100
|
-
setOpen(false);
|
|
149
|
+
if (shouldClose) {
|
|
150
|
+
overlayState.setOpen(false);
|
|
101
151
|
}
|
|
102
152
|
};
|
|
103
153
|
|
|
@@ -109,19 +159,43 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
109
159
|
}
|
|
110
160
|
};
|
|
111
161
|
|
|
112
|
-
let
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
162
|
+
let showEra = (value?.start?.calendar.identifier === 'gregory' && value.start.era === 'BC') || (value?.end?.calendar.identifier === 'gregory' && value.end.era === 'BC');
|
|
163
|
+
let formatOpts = useMemo(() => ({
|
|
164
|
+
granularity,
|
|
165
|
+
timeZone: defaultTimeZone,
|
|
166
|
+
hideTimeZone: props.hideTimeZone,
|
|
167
|
+
hourCycle: props.hourCycle,
|
|
168
|
+
shouldForceLeadingZeros: props.shouldForceLeadingZeros,
|
|
169
|
+
showEra
|
|
170
|
+
}), [granularity, props.hourCycle, props.shouldForceLeadingZeros, defaultTimeZone, props.hideTimeZone, showEra]);
|
|
171
|
+
|
|
172
|
+
let {minValue, maxValue, isDateUnavailable} = props;
|
|
173
|
+
let builtinValidation = useMemo(() => getRangeValidationResult(
|
|
174
|
+
value,
|
|
175
|
+
minValue,
|
|
176
|
+
maxValue,
|
|
177
|
+
isDateUnavailable,
|
|
178
|
+
formatOpts
|
|
179
|
+
), [value, minValue, maxValue, isDateUnavailable, formatOpts]);
|
|
180
|
+
|
|
181
|
+
let validation = useFormValidationState({
|
|
182
|
+
...props,
|
|
183
|
+
value: controlledValue,
|
|
184
|
+
name: useMemo(() => [props.startName, props.endName], [props.startName, props.endName]),
|
|
185
|
+
builtinValidation
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
let isValueInvalid = validation.displayValidation.isInvalid;
|
|
189
|
+
let validationState: ValidationState = props.validationState || (isValueInvalid ? 'invalid' : null);
|
|
118
190
|
|
|
119
191
|
return {
|
|
192
|
+
...validation,
|
|
120
193
|
value,
|
|
121
194
|
setValue,
|
|
122
195
|
dateRange,
|
|
123
196
|
timeRange,
|
|
124
197
|
granularity,
|
|
198
|
+
hasTime,
|
|
125
199
|
setDate(part, date) {
|
|
126
200
|
setDateRange({...dateRange, [part]: date});
|
|
127
201
|
},
|
|
@@ -133,7 +207,7 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
133
207
|
},
|
|
134
208
|
setDateRange,
|
|
135
209
|
setTimeRange,
|
|
136
|
-
|
|
210
|
+
...overlayState,
|
|
137
211
|
setOpen(isOpen) {
|
|
138
212
|
// Commit the selected date range when the calendar is closed. Use a placeholder time if one wasn't set.
|
|
139
213
|
// If only the time range was set and not the date range, don't commit. The state will be preserved until
|
|
@@ -145,12 +219,13 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
145
219
|
});
|
|
146
220
|
}
|
|
147
221
|
|
|
148
|
-
setOpen(isOpen);
|
|
222
|
+
overlayState.setOpen(isOpen);
|
|
149
223
|
},
|
|
150
224
|
validationState,
|
|
225
|
+
isInvalid: isValueInvalid,
|
|
151
226
|
formatValue(locale, fieldOptions) {
|
|
152
227
|
if (!value || !value.start || !value.end) {
|
|
153
|
-
return
|
|
228
|
+
return null;
|
|
154
229
|
}
|
|
155
230
|
|
|
156
231
|
let startTimeZone = 'timeZone' in value.start ? value.start.timeZone : undefined;
|
|
@@ -162,17 +237,47 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
162
237
|
granularity: startGranularity,
|
|
163
238
|
timeZone: startTimeZone,
|
|
164
239
|
hideTimeZone: props.hideTimeZone,
|
|
165
|
-
hourCycle: props.hourCycle
|
|
240
|
+
hourCycle: props.hourCycle,
|
|
241
|
+
showEra: (value.start.calendar.identifier === 'gregory' && value.start.era === 'BC') ||
|
|
242
|
+
(value.end.calendar.identifier === 'gregory' && value.end.era === 'BC')
|
|
166
243
|
});
|
|
167
244
|
|
|
245
|
+
let startDate = value.start.toDate(startTimeZone || 'UTC');
|
|
246
|
+
let endDate = value.end.toDate(endTimeZone || 'UTC');
|
|
247
|
+
|
|
168
248
|
let startFormatter = new DateFormatter(locale, startOptions);
|
|
169
249
|
let endFormatter: Intl.DateTimeFormat;
|
|
170
|
-
if (startTimeZone === endTimeZone && startGranularity === endGranularity) {
|
|
250
|
+
if (startTimeZone === endTimeZone && startGranularity === endGranularity && value.start.compare(value.end) !== 0) {
|
|
171
251
|
// Use formatRange, as it results in shorter output when some of the fields
|
|
172
252
|
// are shared between the start and end dates (e.g. the same month).
|
|
173
253
|
// Formatting will fail if the end date is before the start date. Fall back below when that happens.
|
|
174
254
|
try {
|
|
175
|
-
|
|
255
|
+
let parts = startFormatter.formatRangeToParts(startDate, endDate);
|
|
256
|
+
|
|
257
|
+
// Find the separator between the start and end date. This is determined
|
|
258
|
+
// by finding the last shared literal before the end range.
|
|
259
|
+
let separatorIndex = -1;
|
|
260
|
+
for (let i = 0; i < parts.length; i++) {
|
|
261
|
+
let part = parts[i];
|
|
262
|
+
if (part.source === 'shared' && part.type === 'literal') {
|
|
263
|
+
separatorIndex = i;
|
|
264
|
+
} else if (part.source === 'endRange') {
|
|
265
|
+
break;
|
|
266
|
+
}
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
// Now we can combine the parts into start and end strings.
|
|
270
|
+
let start = '';
|
|
271
|
+
let end = '';
|
|
272
|
+
for (let i = 0; i < parts.length; i++) {
|
|
273
|
+
if (i < separatorIndex) {
|
|
274
|
+
start += parts[i].value;
|
|
275
|
+
} else if (i > separatorIndex) {
|
|
276
|
+
end += parts[i].value;
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
return {start, end};
|
|
176
281
|
} catch (e) {
|
|
177
282
|
// ignore
|
|
178
283
|
}
|
|
@@ -189,20 +294,15 @@ export function useDateRangePickerState<T extends DateValue>(props: DateRangePic
|
|
|
189
294
|
endFormatter = new DateFormatter(locale, endOptions);
|
|
190
295
|
}
|
|
191
296
|
|
|
192
|
-
return
|
|
297
|
+
return {
|
|
298
|
+
start: startFormatter.format(startDate),
|
|
299
|
+
end: endFormatter.format(endDate)
|
|
300
|
+
};
|
|
193
301
|
},
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
if (value && Boolean(value.start) !== Boolean(value.end)) {
|
|
199
|
-
let calendar = (value.start || value.end).calendar;
|
|
200
|
-
let placeholder = createPlaceholderDate(props.placeholderValue, granularity, calendar, defaultTimeZone);
|
|
201
|
-
setValue({
|
|
202
|
-
start: value.start || placeholder,
|
|
203
|
-
end: value.end || placeholder
|
|
204
|
-
});
|
|
205
|
-
}
|
|
302
|
+
getDateFormatter(locale, formatOptions: FormatterOptions) {
|
|
303
|
+
let newOptions = {...formatOpts, ...formatOptions};
|
|
304
|
+
let newFormatOptions = getFormatOptions({}, newOptions);
|
|
305
|
+
return new DateFormatter(locale, newFormatOptions);
|
|
206
306
|
}
|
|
207
307
|
};
|
|
208
308
|
}
|
package/src/useTimeFieldState.ts
CHANGED
|
@@ -10,23 +10,34 @@
|
|
|
10
10
|
* governing permissions and limitations under the License.
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
|
-
import {
|
|
13
|
+
import {DateFieldState, useDateFieldState} from '.';
|
|
14
14
|
import {DateValue, TimePickerProps, TimeValue} from '@react-types/datepicker';
|
|
15
|
+
import {getLocalTimeZone, GregorianCalendar, Time, toCalendarDateTime, today, toTime, toZoned} from '@internationalized/date';
|
|
16
|
+
import {useCallback, useMemo} from 'react';
|
|
15
17
|
import {useControlledState} from '@react-stately/utils';
|
|
16
|
-
import {useDatePickerFieldState} from '.';
|
|
17
|
-
import {useMemo} from 'react';
|
|
18
18
|
|
|
19
|
-
interface
|
|
20
|
-
locale
|
|
21
|
-
|
|
19
|
+
export interface TimeFieldStateOptions<T extends TimeValue = TimeValue> extends TimePickerProps<T> {
|
|
20
|
+
/** The locale to display and edit the value according to. */
|
|
21
|
+
locale: string
|
|
22
22
|
}
|
|
23
23
|
|
|
24
|
-
export
|
|
24
|
+
export interface TimeFieldState extends DateFieldState {
|
|
25
|
+
/** The current time value. */
|
|
26
|
+
timeValue: Time
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Provides state management for a time field component.
|
|
31
|
+
* A time field allows users to enter and edit time values using a keyboard.
|
|
32
|
+
* Each part of a time value is displayed in an individually editable segment.
|
|
33
|
+
*/
|
|
34
|
+
export function useTimeFieldState<T extends TimeValue = TimeValue>(props: TimeFieldStateOptions<T>): TimeFieldState {
|
|
25
35
|
let {
|
|
26
36
|
placeholderValue = new Time(),
|
|
27
37
|
minValue,
|
|
28
38
|
maxValue,
|
|
29
|
-
granularity
|
|
39
|
+
granularity,
|
|
40
|
+
validate
|
|
30
41
|
} = props;
|
|
31
42
|
|
|
32
43
|
let [value, setValue] = useControlledState<TimeValue>(
|
|
@@ -37,16 +48,22 @@ export function useTimeFieldState<T extends TimeValue>(props: TimeFieldProps<T>)
|
|
|
37
48
|
|
|
38
49
|
let v = value || placeholderValue;
|
|
39
50
|
let day = v && 'day' in v ? v : undefined;
|
|
40
|
-
let
|
|
51
|
+
let defaultValueTimeZone = props.defaultValue && 'timeZone' in props.defaultValue ? props.defaultValue.timeZone : undefined;
|
|
52
|
+
let placeholderDate = useMemo(() => {
|
|
53
|
+
let valueTimeZone = v && 'timeZone' in v ? v.timeZone : undefined;
|
|
54
|
+
|
|
55
|
+
return (valueTimeZone || defaultValueTimeZone) && placeholderValue ? toZoned(convertValue(placeholderValue), valueTimeZone || defaultValueTimeZone) : convertValue(placeholderValue);
|
|
56
|
+
}, [placeholderValue, v, defaultValueTimeZone]);
|
|
41
57
|
let minDate = useMemo(() => convertValue(minValue, day), [minValue, day]);
|
|
42
58
|
let maxDate = useMemo(() => convertValue(maxValue, day), [maxValue, day]);
|
|
43
59
|
|
|
60
|
+
let timeValue = useMemo(() => value && 'day' in value ? toTime(value) : value as Time, [value]);
|
|
44
61
|
let dateTime = useMemo(() => value == null ? null : convertValue(value), [value]);
|
|
45
62
|
let onChange = newValue => {
|
|
46
|
-
setValue(
|
|
63
|
+
setValue(day || defaultValueTimeZone ? newValue : newValue && toTime(newValue));
|
|
47
64
|
};
|
|
48
65
|
|
|
49
|
-
|
|
66
|
+
let state = useDateFieldState({
|
|
50
67
|
...props,
|
|
51
68
|
value: dateTime,
|
|
52
69
|
defaultValue: undefined,
|
|
@@ -55,8 +72,16 @@ export function useTimeFieldState<T extends TimeValue>(props: TimeFieldProps<T>)
|
|
|
55
72
|
onChange,
|
|
56
73
|
granularity: granularity || 'minute',
|
|
57
74
|
maxGranularity: 'hour',
|
|
58
|
-
placeholderValue: placeholderDate
|
|
75
|
+
placeholderValue: placeholderDate,
|
|
76
|
+
// Calendar should not matter for time fields.
|
|
77
|
+
createCalendar: () => new GregorianCalendar(),
|
|
78
|
+
validate: useCallback(() => validate?.(value as any), [validate, value])
|
|
59
79
|
});
|
|
80
|
+
|
|
81
|
+
return {
|
|
82
|
+
...state,
|
|
83
|
+
timeValue
|
|
84
|
+
};
|
|
60
85
|
}
|
|
61
86
|
|
|
62
87
|
function convertValue(value: TimeValue, date: DateValue = today(getLocalTimeZone())) {
|
package/src/utils.ts
CHANGED
|
@@ -10,24 +10,126 @@
|
|
|
10
10
|
* governing permissions and limitations under the License.
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
|
-
import {Calendar, now, Time, toCalendar, toCalendarDate, toCalendarDateTime} from '@internationalized/date';
|
|
13
|
+
import {Calendar, DateFormatter, now, Time, toCalendar, toCalendarDate, toCalendarDateTime} from '@internationalized/date';
|
|
14
14
|
import {DatePickerProps, DateValue, Granularity, TimeValue} from '@react-types/datepicker';
|
|
15
|
-
|
|
15
|
+
// @ts-ignore
|
|
16
|
+
import i18nMessages from '../intl/*.json';
|
|
17
|
+
import {LocalizedStringDictionary, LocalizedStringFormatter} from '@internationalized/string';
|
|
18
|
+
import {mergeValidation, VALID_VALIDITY_STATE} from '@react-stately/form';
|
|
19
|
+
import {RangeValue, ValidationResult} from '@react-types/shared';
|
|
20
|
+
import {useState} from 'react';
|
|
16
21
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
22
|
+
const dictionary = new LocalizedStringDictionary(i18nMessages);
|
|
23
|
+
|
|
24
|
+
function getLocale() {
|
|
25
|
+
// Match browser language setting here, NOT react-aria's I18nProvider, so that we match other browser-provided
|
|
26
|
+
// validation messages, which to not respect our provider's language.
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
return (typeof navigator !== 'undefined' && (navigator.language || navigator.userLanguage)) || 'en-US';
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export function getValidationResult(
|
|
32
|
+
value: DateValue,
|
|
33
|
+
minValue: DateValue,
|
|
34
|
+
maxValue: DateValue,
|
|
35
|
+
isDateUnavailable: (v: DateValue) => boolean,
|
|
36
|
+
options: FormatterOptions
|
|
37
|
+
): ValidationResult {
|
|
38
|
+
let rangeOverflow = value != null && maxValue != null && value.compare(maxValue) > 0;
|
|
39
|
+
let rangeUnderflow = value != null && minValue != null && value.compare(minValue) < 0;
|
|
40
|
+
let isUnavailable = (value != null && isDateUnavailable?.(value)) || false;
|
|
41
|
+
let isInvalid = rangeOverflow || rangeUnderflow || isUnavailable;
|
|
42
|
+
let errors = [];
|
|
43
|
+
|
|
44
|
+
if (isInvalid) {
|
|
45
|
+
let locale = getLocale();
|
|
46
|
+
let strings = LocalizedStringDictionary.getGlobalDictionaryForPackage('@react-stately/datepicker') || dictionary;
|
|
47
|
+
let formatter = new LocalizedStringFormatter(locale, strings);
|
|
48
|
+
let dateFormatter = new DateFormatter(locale, getFormatOptions({}, options));
|
|
49
|
+
let timeZone = dateFormatter.resolvedOptions().timeZone;
|
|
50
|
+
|
|
51
|
+
if (rangeUnderflow) {
|
|
52
|
+
errors.push(formatter.format('rangeUnderflow', {minValue: dateFormatter.format(minValue.toDate(timeZone))}));
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
if (rangeOverflow) {
|
|
56
|
+
errors.push(formatter.format('rangeOverflow', {maxValue: dateFormatter.format(maxValue.toDate(timeZone))}));
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
if (isUnavailable) {
|
|
60
|
+
errors.push(formatter.format('unavailableDate'));
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
return {
|
|
65
|
+
isInvalid,
|
|
66
|
+
validationErrors: errors,
|
|
67
|
+
validationDetails: {
|
|
68
|
+
badInput: isUnavailable,
|
|
69
|
+
customError: false,
|
|
70
|
+
patternMismatch: false,
|
|
71
|
+
rangeOverflow,
|
|
72
|
+
rangeUnderflow,
|
|
73
|
+
stepMismatch: false,
|
|
74
|
+
tooLong: false,
|
|
75
|
+
tooShort: false,
|
|
76
|
+
typeMismatch: false,
|
|
77
|
+
valueMissing: false,
|
|
78
|
+
valid: !isInvalid
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function getRangeValidationResult(
|
|
84
|
+
value: RangeValue<DateValue>,
|
|
85
|
+
minValue: DateValue,
|
|
86
|
+
maxValue: DateValue,
|
|
87
|
+
isDateUnavailable: (v: DateValue) => boolean,
|
|
88
|
+
options: FormatterOptions
|
|
89
|
+
) {
|
|
90
|
+
let startValidation = getValidationResult(
|
|
91
|
+
value?.start,
|
|
92
|
+
minValue,
|
|
93
|
+
maxValue,
|
|
94
|
+
isDateUnavailable,
|
|
95
|
+
options
|
|
96
|
+
);
|
|
97
|
+
|
|
98
|
+
let endValidation = getValidationResult(
|
|
99
|
+
value?.end,
|
|
100
|
+
minValue,
|
|
101
|
+
maxValue,
|
|
102
|
+
isDateUnavailable,
|
|
103
|
+
options
|
|
21
104
|
);
|
|
105
|
+
|
|
106
|
+
let result = mergeValidation(startValidation, endValidation);
|
|
107
|
+
if (value.end != null && value.start != null && value.end.compare(value.start) < 0) {
|
|
108
|
+
let strings = LocalizedStringDictionary.getGlobalDictionaryForPackage('@react-stately/datepicker') || dictionary;
|
|
109
|
+
result = mergeValidation(result, {
|
|
110
|
+
isInvalid: true,
|
|
111
|
+
validationErrors: [strings.getStringForLocale('rangeReversed', getLocale())],
|
|
112
|
+
validationDetails: {
|
|
113
|
+
...VALID_VALIDITY_STATE,
|
|
114
|
+
rangeUnderflow: true,
|
|
115
|
+
rangeOverflow: true,
|
|
116
|
+
valid: false
|
|
117
|
+
}
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
return result;
|
|
22
122
|
}
|
|
23
123
|
|
|
24
124
|
export type FieldOptions = Pick<Intl.DateTimeFormatOptions, 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second'>;
|
|
25
|
-
interface FormatterOptions {
|
|
125
|
+
export interface FormatterOptions {
|
|
26
126
|
timeZone?: string,
|
|
27
127
|
hideTimeZone?: boolean,
|
|
28
128
|
granularity?: DatePickerProps<any>['granularity'],
|
|
29
129
|
maxGranularity?: 'year' | 'month' | DatePickerProps<any>['granularity'],
|
|
30
|
-
hourCycle?: 12 | 24
|
|
130
|
+
hourCycle?: 12 | 24,
|
|
131
|
+
showEra?: boolean,
|
|
132
|
+
shouldForceLeadingZeros?: boolean
|
|
31
133
|
}
|
|
32
134
|
|
|
33
135
|
const DEFAULT_FIELD_OPTIONS: FieldOptions = {
|
|
@@ -39,11 +141,21 @@ const DEFAULT_FIELD_OPTIONS: FieldOptions = {
|
|
|
39
141
|
second: '2-digit'
|
|
40
142
|
};
|
|
41
143
|
|
|
144
|
+
const TWO_DIGIT_FIELD_OPTIONS: FieldOptions = {
|
|
145
|
+
year: 'numeric',
|
|
146
|
+
month: '2-digit',
|
|
147
|
+
day: '2-digit',
|
|
148
|
+
hour: '2-digit',
|
|
149
|
+
minute: '2-digit',
|
|
150
|
+
second: '2-digit'
|
|
151
|
+
};
|
|
152
|
+
|
|
42
153
|
export function getFormatOptions(
|
|
43
154
|
fieldOptions: FieldOptions,
|
|
44
155
|
options: FormatterOptions
|
|
45
156
|
): Intl.DateTimeFormatOptions {
|
|
46
|
-
|
|
157
|
+
let defaultFieldOptions = options.shouldForceLeadingZeros ? TWO_DIGIT_FIELD_OPTIONS : DEFAULT_FIELD_OPTIONS;
|
|
158
|
+
fieldOptions = {...defaultFieldOptions, ...fieldOptions};
|
|
47
159
|
let granularity = options.granularity || 'minute';
|
|
48
160
|
let keys = Object.keys(fieldOptions);
|
|
49
161
|
let startIdx = keys.indexOf(options.maxGranularity ?? 'year');
|
|
@@ -76,6 +188,10 @@ export function getFormatOptions(
|
|
|
76
188
|
opts.timeZoneName = 'short';
|
|
77
189
|
}
|
|
78
190
|
|
|
191
|
+
if (options.showEra && startIdx === 0) {
|
|
192
|
+
opts.era = 'short';
|
|
193
|
+
}
|
|
194
|
+
|
|
79
195
|
return opts;
|
|
80
196
|
}
|
|
81
197
|
|
|
@@ -125,19 +241,25 @@ export function createPlaceholderDate(placeholderValue: DateValue, granularity:
|
|
|
125
241
|
|
|
126
242
|
export function useDefaultProps(v: DateValue, granularity: Granularity): [Granularity, string] {
|
|
127
243
|
// Compute default granularity and time zone from the value. If the value becomes null, keep the last values.
|
|
128
|
-
let lastValue = useRef(v);
|
|
129
|
-
if (v) {
|
|
130
|
-
lastValue.current = v;
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
v = lastValue.current;
|
|
134
244
|
let defaultTimeZone = (v && 'timeZone' in v ? v.timeZone : undefined);
|
|
135
|
-
|
|
245
|
+
let defaultGranularity: Granularity = (v && 'minute' in v ? 'minute' : 'day');
|
|
136
246
|
|
|
137
247
|
// props.granularity must actually exist in the value if one is provided.
|
|
138
|
-
if (v && !(granularity in v)) {
|
|
248
|
+
if (v && granularity && !(granularity in v)) {
|
|
139
249
|
throw new Error('Invalid granularity ' + granularity + ' for value ' + v.toString());
|
|
140
250
|
}
|
|
141
251
|
|
|
142
|
-
|
|
252
|
+
let [lastValue, setLastValue] = useState<[Granularity, string]>([defaultGranularity, defaultTimeZone]);
|
|
253
|
+
|
|
254
|
+
// If the granularity or time zone changed, update the last value.
|
|
255
|
+
if (v && (lastValue[0] !== defaultGranularity || lastValue[1] !== defaultTimeZone)) {
|
|
256
|
+
setLastValue([defaultGranularity, defaultTimeZone]);
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
if (!granularity) {
|
|
260
|
+
granularity = v ? defaultGranularity : lastValue[0];
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
let timeZone = v ? defaultTimeZone : lastValue[1];
|
|
264
|
+
return [granularity, timeZone];
|
|
143
265
|
}
|