@atlaskit/datetime-picker
Version:
A date time picker allows the user to select an associated date and time.
503 lines (493 loc) • 22.1 kB
JavaScript
/* date-time-picker.tsx generated by @compiled/babel-plugin v3.0.2 */
import _extends from "@babel/runtime/helpers/extends";
import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
import _defineProperty from "@babel/runtime/helpers/defineProperty";
var _excluded = ["selectProps"],
_excluded2 = ["selectProps"];
import "./date-time-picker.compiled.css";
import { ax, ix } from "@compiled/react/runtime";
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
/// <reference types="node" />
// for typing `process`
import React, { forwardRef, useCallback, useEffect, useReducer, useRef, useState } from 'react';
// oxlint-disable-next-line @atlassian/no-restricted-imports
import { format, isValid, parseISO } from 'date-fns';
import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next/usePlatformLeafEventHandler';
import IconButton from '@atlaskit/button/icon/button';
import SelectClearIcon from '@atlaskit/icon/core/cross-circle';
import { Box, Inline } from '@atlaskit/primitives/compiled';
import { mergeStyles } from '@atlaskit/react-select/styles';
import { DateTimePickerContainer } from '../internal/date-time-picker-container';
import { formatDateTimeZoneIntoIso } from '../internal/format-date-time-zone-into-iso';
import { convertTokens } from '../internal/parse-tokens';
import DatePicker from './date-picker';
import TimePicker from './time-picker';
var packageName = "@atlaskit/datetime-picker";
var packageVersion = "18.7.2";
var analyticsAttributes = {
componentName: 'dateTimePicker',
packageName: packageName,
packageVersion: packageVersion
};
var compiledStyles = {
datePickerContainerStyles: "_i0dl1ssb _16jlkb7n _1o9zidpf",
timePickerContainerStyles: "_i0dl1ssb _16jlkb7n",
iconContainerStyles: "_1e0c1txw _4cvr1h6o _i0dl1kw7"
};
// react-select overrides (via @atlaskit/select).
var styles = {
control: function control(style) {
return _objectSpread(_objectSpread({}, style), {}, {
backgroundColor: 'transparent',
border: 2,
borderRadius: 0,
paddingLeft: 0,
':hover': {
backgroundColor: 'transparent',
cursor: 'inherit'
}
});
}
};
/**
* Two action types keep the reducer focused:
*
* - APPLY: used by user-interaction handlers. The handler computes the full
* next state (including the new ISO value) and applies it atomically. This
* guarantees a single re-render with no cascades regardless of React version.
*
* - SET_VALUE: used by the `providedValue` prop effect. The reducer owns all
* parsing logic for external value changes, including the empty-string case
* that the previous useState approach missed.
*/
export var datePickerDefaultAriaLabel = 'Date';
export var timePickerDefaultAriaLabel = 'Time';
/**
* __Date time picker__
*
* A date time picker allows the user to select an associated date and time.
*
* - [Examples](https://atlassian.design/components/datetime-picker/examples)
* - [Code](https://atlassian.design/components/datetime-picker/code)
* - [Usage](https://atlassian.design/components/datetime-picker/usage)
*/
var DateTimePicker = /*#__PURE__*/forwardRef(function (_ref, ref) {
var ariaDescribedBy = _ref['aria-describedby'],
_ref$appearance = _ref.appearance,
appearance = _ref$appearance === void 0 ? 'default' : _ref$appearance,
_ref$autoFocus = _ref.autoFocus,
autoFocus = _ref$autoFocus === void 0 ? false : _ref$autoFocus,
_ref$clearControlLabe = _ref.clearControlLabel,
clearControlLabel = _ref$clearControlLabe === void 0 ? 'clear' : _ref$clearControlLabe,
_ref$datePickerProps = _ref.datePickerProps,
datePickerPropsWithSelectProps = _ref$datePickerProps === void 0 ? {} : _ref$datePickerProps,
_ref$defaultValue = _ref.defaultValue,
defaultValue = _ref$defaultValue === void 0 ? '' : _ref$defaultValue,
_ref$id = _ref.id,
id = _ref$id === void 0 ? '' : _ref$id,
_ref$innerProps = _ref.innerProps,
innerProps = _ref$innerProps === void 0 ? {} : _ref$innerProps,
_ref$isDisabled = _ref.isDisabled,
isDisabled = _ref$isDisabled === void 0 ? false : _ref$isDisabled,
_ref$isInvalid = _ref.isInvalid,
isInvalid = _ref$isInvalid === void 0 ? false : _ref$isInvalid,
_ref$isRequired = _ref.isRequired,
isRequired = _ref$isRequired === void 0 ? false : _ref$isRequired,
_ref$name = _ref.name,
name = _ref$name === void 0 ? '' : _ref$name,
_ref$onBlur = _ref.onBlur,
onBlur = _ref$onBlur === void 0 ? function (_event) {} : _ref$onBlur,
_ref$onChange = _ref.onChange,
onChangeProp = _ref$onChange === void 0 ? function (_value) {} : _ref$onChange,
_ref$onFocus = _ref.onFocus,
onFocus = _ref$onFocus === void 0 ? function (_event) {} : _ref$onFocus,
providedParseValue = _ref.parseValue,
_ref$spacing = _ref.spacing,
spacing = _ref$spacing === void 0 ? 'default' : _ref$spacing,
_ref$locale = _ref.locale,
locale = _ref$locale === void 0 ? 'en-US' : _ref$locale,
testId = _ref.testId,
_ref$timePickerProps = _ref.timePickerProps,
timePickerPropsWithSelectProps = _ref$timePickerProps === void 0 ? {} : _ref$timePickerProps,
providedValue = _ref.value;
var _useState = useState(false),
_useState2 = _slicedToArray(_useState, 2),
isFocused = _useState2[0],
setIsFocused = _useState2[1];
/**
* Defined inside the component so the reducer closes over `providedParseValue`
* without needing to smuggle it through every action payload. React always
* calls the reducer from the latest render, so stale-closure is not a concern.
*/
var reducer = function reducer(state, action) {
switch (action.type) {
case 'APPLY':
return action.payload;
case 'SET_VALUE':
{
var newValue = action.payload;
// Explicit empty-string handling: clear all sub-fields so the date
// and time pickers visually reset when a controlled value is cleared.
if (!newValue) {
return {
value: '',
dateValue: '',
timeValue: '',
zoneValue: ''
};
}
if (providedParseValue) {
var _parsed = providedParseValue(newValue, state.dateValue, state.timeValue, state.zoneValue);
return _parsed ? _objectSpread({
value: newValue
}, _parsed) : {
value: newValue,
dateValue: state.dateValue,
timeValue: state.timeValue,
zoneValue: state.zoneValue
};
}
var parsed = parseISO(newValue);
return isValid(parsed) ? {
value: newValue,
dateValue: format(parsed, convertTokens('YYYY-MM-DD')),
timeValue: format(parsed, convertTokens('HH:mm')),
zoneValue: format(parsed, convertTokens('ZZ'))
} : {
value: newValue,
dateValue: '',
timeValue: '',
zoneValue: ''
};
}
default:
return state;
}
};
var _useReducer = useReducer(reducer, null, function () {
var _ref2;
var initialValue = (_ref2 = providedValue !== null && providedValue !== void 0 ? providedValue : defaultValue) !== null && _ref2 !== void 0 ? _ref2 : '';
var initialDate = (datePickerPropsWithSelectProps === null || datePickerPropsWithSelectProps === void 0 ? void 0 : datePickerPropsWithSelectProps.defaultValue) || '';
var initialTime = (timePickerPropsWithSelectProps === null || timePickerPropsWithSelectProps === void 0 ? void 0 : timePickerPropsWithSelectProps.defaultValue) || '';
if (!initialValue) {
return {
value: '',
dateValue: initialDate,
timeValue: initialTime,
zoneValue: ''
};
}
if (providedParseValue) {
var _parsed2 = providedParseValue(initialValue, initialDate, initialTime, '');
return _parsed2 ? _objectSpread({
value: initialValue
}, _parsed2) : {
value: initialValue,
dateValue: initialDate,
timeValue: initialTime,
zoneValue: ''
};
}
var parsed = parseISO(initialValue);
return isValid(parsed) ? {
value: initialValue,
dateValue: format(parsed, convertTokens('YYYY-MM-DD')),
timeValue: format(parsed, convertTokens('HH:mm')),
zoneValue: format(parsed, convertTokens('ZZ'))
} : {
value: initialValue,
dateValue: initialDate,
timeValue: initialTime,
zoneValue: ''
};
}),
_useReducer2 = _slicedToArray(_useReducer, 2),
dtState = _useReducer2[0],
dispatch = _useReducer2[1];
// if a previously controlled value becomes undefined, it clears the reducer
// state so the hidden input no longer keeps the stale ISO timestamp.
// Without this, components that try to clear their components by providing
// `undefined` to the `value` prop will not clear the hidden input and will
// cause unexpected issues.
var hasReceivedProvidedValue = useRef(providedValue !== undefined);
// We don't want to set the state on the first render, as it would
// needlessly be a duplicate.
var isFirstRender = useRef(true);
useEffect(function () {
if (isFirstRender.current) {
isFirstRender.current = false;
return;
}
if (providedValue !== undefined) {
hasReceivedProvidedValue.current = true;
dispatch({
type: 'SET_VALUE',
payload: providedValue
});
} else if (hasReceivedProvidedValue.current) {
hasReceivedProvidedValue.current = false;
dispatch({
type: 'SET_VALUE',
payload: ''
});
}
}, [providedValue]);
var parseValue = useCallback(function (value, providedDateValue, providedTimeValue, providedZoneValue) {
if (providedParseValue) {
var parsedFromFn = providedParseValue(value, providedDateValue, providedTimeValue, providedZoneValue);
// This handles cases found in Jira where the parse function actually does
// nothing and returns undefined. The previous `getSafeState` function
// just spread the values over the state, but if it returned `undefined`,
// it would just rely on the previous state values. Considering this is
// what is input to this function anyway, this is a safe way to handle
// this, colocate the behavior, and not rely on `getSafeState`.
return parsedFromFn || {
dateValue: providedDateValue,
timeValue: providedTimeValue,
zoneValue: providedZoneValue
};
}
var parsed = parseISO(value);
return isValid(parsed) ? {
dateValue: format(parsed, convertTokens('YYYY-MM-DD')),
timeValue: format(parsed, convertTokens('HH:mm')),
zoneValue: format(parsed, convertTokens('ZZ'))
} : {
dateValue: dtState.dateValue,
timeValue: dtState.timeValue,
zoneValue: dtState.zoneValue
};
}, [providedParseValue, dtState.dateValue, dtState.timeValue, dtState.zoneValue]);
var onDateBlur = function onDateBlur(event) {
setIsFocused(false);
onBlur(event);
if (datePickerPropsWithSelectProps !== null && datePickerPropsWithSelectProps !== void 0 && datePickerPropsWithSelectProps.onBlur) {
datePickerPropsWithSelectProps.onBlur(event);
}
};
var onTimeBlur = function onTimeBlur(event) {
setIsFocused(false);
onBlur(event);
if (timePickerPropsWithSelectProps !== null && timePickerPropsWithSelectProps !== void 0 && timePickerPropsWithSelectProps.onBlur) {
timePickerPropsWithSelectProps.onBlur(event);
}
};
var onDateFocus = function onDateFocus(event) {
setIsFocused(false);
onFocus(event);
if (datePickerPropsWithSelectProps !== null && datePickerPropsWithSelectProps !== void 0 && datePickerPropsWithSelectProps.onFocus) {
datePickerPropsWithSelectProps.onFocus(event);
}
};
var onTimeFocus = function onTimeFocus(event) {
setIsFocused(false);
onFocus(event);
if (timePickerPropsWithSelectProps !== null && timePickerPropsWithSelectProps !== void 0 && timePickerPropsWithSelectProps.onFocus) {
timePickerPropsWithSelectProps.onFocus(event);
}
};
var onDateChange = function onDateChange(newDateValue) {
var parsedValues = parseValue(dtState.value, newDateValue, dtState.timeValue, dtState.zoneValue);
onValueChange({
providedDateValue: newDateValue,
providedTimeValue: parsedValues.timeValue,
providedZoneValue: parsedValues.zoneValue
});
if (datePickerPropsWithSelectProps !== null && datePickerPropsWithSelectProps !== void 0 && datePickerPropsWithSelectProps.onChange) {
datePickerPropsWithSelectProps.onChange(newDateValue);
}
};
var onTimeChange = function onTimeChange(newTimeValue) {
var parsedValues = parseValue(dtState.value, dtState.dateValue, newTimeValue, dtState.zoneValue);
onValueChange({
providedDateValue: parsedValues.dateValue,
providedTimeValue: newTimeValue,
providedZoneValue: parsedValues.zoneValue
});
if (timePickerPropsWithSelectProps !== null && timePickerPropsWithSelectProps !== void 0 && timePickerPropsWithSelectProps.onChange) {
timePickerPropsWithSelectProps.onChange(newTimeValue);
}
};
var onClear = function onClear() {
var parsedValues = parseValue(dtState.value, dtState.dateValue, dtState.timeValue, dtState.zoneValue);
onValueChange({
providedDateValue: '',
providedTimeValue: '',
providedZoneValue: parsedValues.zoneValue
});
if (datePickerPropsWithSelectProps !== null && datePickerPropsWithSelectProps !== void 0 && datePickerPropsWithSelectProps.onChange) {
datePickerPropsWithSelectProps.onChange('');
}
if (timePickerPropsWithSelectProps !== null && timePickerPropsWithSelectProps !== void 0 && timePickerPropsWithSelectProps.onChange) {
timePickerPropsWithSelectProps.onChange('');
}
};
var onChangePropWithAnalytics = usePlatformLeafEventHandler(_objectSpread({
fn: onChangeProp,
action: 'selectedDate',
actionSubject: 'dateTimePicker'
}, analyticsAttributes));
var onValueChange = function onValueChange(_ref3) {
var providedDateValue = _ref3.providedDateValue,
providedTimeValue = _ref3.providedTimeValue,
providedZoneValue = _ref3.providedZoneValue;
if (providedDateValue && providedTimeValue) {
var isoValue = formatDateTimeZoneIntoIso(providedDateValue, providedTimeValue, providedZoneValue);
var _parseValue = parseValue(isoValue, providedDateValue, providedTimeValue, providedZoneValue),
parsedZone = _parseValue.zoneValue;
var valueWithValidZone = formatDateTimeZoneIntoIso(providedDateValue, providedTimeValue, parsedZone);
dispatch({
type: 'APPLY',
payload: {
value: valueWithValidZone,
dateValue: providedDateValue,
timeValue: providedTimeValue,
zoneValue: parsedZone
}
});
onChangePropWithAnalytics(valueWithValidZone);
// If the date or time value was cleared when there is an existing datetime value, then clear the value.
} else if (dtState.value) {
dispatch({
type: 'APPLY',
payload: {
value: '',
dateValue: providedDateValue,
timeValue: providedTimeValue,
zoneValue: providedZoneValue
}
});
onChangePropWithAnalytics('');
} else {
dispatch({
type: 'APPLY',
payload: {
value: '',
dateValue: providedDateValue,
timeValue: providedTimeValue,
zoneValue: providedZoneValue
}
});
}
};
var datePickerSelectProps = datePickerPropsWithSelectProps.selectProps,
datePickerProps = _objectWithoutProperties(datePickerPropsWithSelectProps, _excluded);
var datePickerAriaDescribedBy = datePickerProps['aria-describedby'] || ariaDescribedBy;
var datePickerLabel = datePickerProps.label || 'Date';
var mergedDatePickerSelectProps = _objectSpread(_objectSpread({}, datePickerSelectProps), {}, {
styles: mergeStyles(styles, datePickerSelectProps === null || datePickerSelectProps === void 0 ? void 0 : datePickerSelectProps.styles)
});
var timePickerSelectProps = timePickerPropsWithSelectProps.selectProps,
timePickerProps = _objectWithoutProperties(timePickerPropsWithSelectProps, _excluded2);
var timePickerAriaDescribedBy = timePickerProps['aria-describedby'] || ariaDescribedBy;
var timePickerLabel = timePickerProps.label || 'Time';
var mergedTimePickerSelectProps = _objectSpread(_objectSpread({}, timePickerSelectProps), {}, {
styles: mergeStyles(styles, timePickerSelectProps === null || timePickerSelectProps === void 0 ? void 0 : timePickerSelectProps.styles)
});
// Render DateTimePicker's IconContainer when a value has been filled
// Don't use Date or TimePicker's because they can't be customised
var isClearable = Boolean(dtState.dateValue || dtState.timeValue);
return /*#__PURE__*/React.createElement(DateTimePickerContainer, {
appearance: appearance,
isDisabled: isDisabled,
isFocused: isFocused,
isInvalid: isInvalid,
testId: testId,
innerProps: innerProps,
ref: ref
}, /*#__PURE__*/React.createElement("input", {
name: name,
type: "hidden",
value: dtState.value,
"data-testid": testId && "".concat(testId, "--input")
}), /*#__PURE__*/React.createElement(Box, {
xcss: compiledStyles.datePickerContainerStyles
}, /*#__PURE__*/React.createElement(DatePicker, {
appearance: appearance,
"aria-describedby": datePickerAriaDescribedBy,
autoFocus: datePickerProps.autoFocus || autoFocus,
dateFormat: datePickerProps.dateFormat,
defaultIsOpen: datePickerProps.defaultIsOpen,
defaultValue: datePickerProps.defaultValue,
disabled: datePickerProps.disabled,
disabledDateFilter: datePickerProps.disabledDateFilter,
formatDisplayLabel: datePickerProps.formatDisplayLabel,
hideIcon: datePickerProps.hideIcon || true,
icon: datePickerProps.icon,
id: datePickerProps.id || id,
innerProps: datePickerProps.innerProps,
inputLabel: datePickerProps.inputLabel,
inputLabelId: datePickerProps.inputLabelId,
isDisabled: datePickerProps.isDisabled || isDisabled,
isInvalid: datePickerProps.isInvalid || isInvalid,
isOpen: datePickerProps.isOpen,
isRequired: datePickerProps.isRequired || isRequired,
label: datePickerLabel,
locale: datePickerProps.locale || locale,
maxDate: datePickerProps.maxDate,
minDate: datePickerProps.minDate,
name: datePickerProps.name,
nextMonthLabel: datePickerProps.nextMonthLabel,
onBlur: onDateBlur,
onChange: onDateChange,
onFocus: onDateFocus,
openCalendarLabel: datePickerProps.openCalendarLabel,
parseInputValue: datePickerProps.parseInputValue,
placeholder: datePickerProps.placeholder,
previousMonthLabel: datePickerProps.previousMonthLabel,
selectProps: mergedDatePickerSelectProps,
shouldShowCalendarButton: datePickerProps.shouldShowCalendarButton,
spacing: datePickerProps.spacing || spacing,
testId: testId && "".concat(testId, "--datepicker") || datePickerProps.testId,
value: dtState.dateValue,
weekStartDay: datePickerProps.weekStartDay
})), /*#__PURE__*/React.createElement(Box, {
xcss: compiledStyles.timePickerContainerStyles
}, /*#__PURE__*/React.createElement(TimePicker, {
appearance: timePickerProps.appearance || appearance,
"aria-describedby": timePickerAriaDescribedBy,
autoFocus: timePickerProps.autoFocus,
defaultIsOpen: timePickerProps.defaultIsOpen,
defaultValue: timePickerProps.defaultValue,
formatDisplayLabel: timePickerProps.formatDisplayLabel,
hideIcon: timePickerProps.hideIcon || true,
id: timePickerProps.id,
innerProps: timePickerProps.innerProps,
isDisabled: timePickerProps.isDisabled || isDisabled,
isInvalid: timePickerProps.isInvalid || isInvalid,
isOpen: timePickerProps.isOpen,
isRequired: timePickerProps.isRequired || isRequired,
label: timePickerLabel,
locale: timePickerProps.locale || locale,
name: timePickerProps.name,
onBlur: onTimeBlur,
onChange: onTimeChange,
onFocus: onTimeFocus,
parseInputValue: timePickerProps.parseInputValue,
placeholder: timePickerProps.placeholder,
selectProps: mergedTimePickerSelectProps,
spacing: timePickerProps.spacing || spacing,
testId: timePickerProps.testId || testId && "".concat(testId, "--timepicker"),
timeFormat: timePickerProps.timeFormat,
timeIsEditable: timePickerProps.timeIsEditable,
times: timePickerProps.times,
value: dtState.timeValue
})), isClearable && !isDisabled ? /*#__PURE__*/React.createElement(Inline, {
xcss: compiledStyles.iconContainerStyles
}, /*#__PURE__*/React.createElement(IconButton, {
appearance: "subtle",
label: clearControlLabel,
icon: function icon(iconProps) {
return /*#__PURE__*/React.createElement(SelectClearIcon, _extends({}, iconProps, {
color: "var(--ds-text-subtlest, #6B6E76)",
size: "small"
}));
},
onClick: onClear,
testId: testId && "".concat(testId, "--icon--container"),
tabIndex: -1
})) : null);
});
export default DateTimePicker;