498 lines
18 KiB
JavaScript
498 lines
18 KiB
JavaScript
import _extends from "@babel/runtime/helpers/esm/extends";
|
|
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
|
|
const _excluded = ["ampm", "ampmInClock", "autoFocus", "components", "componentsProps", "slots", "slotProps", "value", "defaultValue", "referenceDate", "disableIgnoringDatePartForTimeValidation", "maxTime", "minTime", "disableFuture", "disablePast", "minutesStep", "shouldDisableClock", "shouldDisableTime", "showViewSwitcher", "onChange", "view", "views", "openTo", "onViewChange", "focusedView", "onFocusedViewChange", "className", "disabled", "readOnly", "timezone"];
|
|
import * as React from 'react';
|
|
import clsx from 'clsx';
|
|
import PropTypes from 'prop-types';
|
|
import { styled, useThemeProps } from '@mui/material/styles';
|
|
import { unstable_composeClasses as composeClasses, unstable_useId as useId } from '@mui/utils';
|
|
import { useUtils, useNow, useLocaleText } from '../internals/hooks/useUtils';
|
|
import { PickersArrowSwitcher } from '../internals/components/PickersArrowSwitcher';
|
|
import { convertValueToMeridiem, createIsAfterIgnoreDatePart } from '../internals/utils/time-utils';
|
|
import { useViews } from '../internals/hooks/useViews';
|
|
import { useMeridiemMode } from '../internals/hooks/date-helpers-hooks';
|
|
import { PickerViewRoot } from '../internals/components/PickerViewRoot';
|
|
import { getTimeClockUtilityClass } from './timeClockClasses';
|
|
import { Clock } from './Clock';
|
|
import { getHourNumbers, getMinutesNumbers } from './ClockNumbers';
|
|
import { useControlledValueWithTimezone } from '../internals/hooks/useValueWithTimezone';
|
|
import { singleItemValueManager } from '../internals/utils/valueManagers';
|
|
import { uncapitalizeObjectKeys } from '../internals/utils/slots-migration';
|
|
import { useClockReferenceDate } from '../internals/hooks/useClockReferenceDate';
|
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
import { jsxs as _jsxs } from "react/jsx-runtime";
|
|
const useUtilityClasses = ownerState => {
|
|
const {
|
|
classes
|
|
} = ownerState;
|
|
const slots = {
|
|
root: ['root'],
|
|
arrowSwitcher: ['arrowSwitcher']
|
|
};
|
|
return composeClasses(slots, getTimeClockUtilityClass, classes);
|
|
};
|
|
const TimeClockRoot = styled(PickerViewRoot, {
|
|
name: 'MuiTimeClock',
|
|
slot: 'Root',
|
|
overridesResolver: (props, styles) => styles.root
|
|
})({
|
|
display: 'flex',
|
|
flexDirection: 'column',
|
|
position: 'relative'
|
|
});
|
|
const TimeClockArrowSwitcher = styled(PickersArrowSwitcher, {
|
|
name: 'MuiTimeClock',
|
|
slot: 'ArrowSwitcher',
|
|
overridesResolver: (props, styles) => styles.arrowSwitcher
|
|
})({
|
|
position: 'absolute',
|
|
right: 12,
|
|
top: 15
|
|
});
|
|
const TIME_CLOCK_DEFAULT_VIEWS = ['hours', 'minutes'];
|
|
|
|
/**
|
|
* Demos:
|
|
*
|
|
* - [TimePicker](https://mui.com/x/react-date-pickers/time-picker/)
|
|
* - [TimeClock](https://mui.com/x/react-date-pickers/time-clock/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [TimeClock API](https://mui.com/x/api/date-pickers/time-clock/)
|
|
*/
|
|
export const TimeClock = /*#__PURE__*/React.forwardRef(function TimeClock(inProps, ref) {
|
|
const utils = useUtils();
|
|
const props = useThemeProps({
|
|
props: inProps,
|
|
name: 'MuiTimeClock'
|
|
});
|
|
const {
|
|
ampm = utils.is12HourCycleInCurrentLocale(),
|
|
ampmInClock = false,
|
|
autoFocus,
|
|
components,
|
|
componentsProps,
|
|
slots: innerSlots,
|
|
slotProps: innerSlotProps,
|
|
value: valueProp,
|
|
defaultValue,
|
|
referenceDate: referenceDateProp,
|
|
disableIgnoringDatePartForTimeValidation = false,
|
|
maxTime,
|
|
minTime,
|
|
disableFuture,
|
|
disablePast,
|
|
minutesStep = 1,
|
|
shouldDisableClock,
|
|
shouldDisableTime,
|
|
showViewSwitcher,
|
|
onChange,
|
|
view: inView,
|
|
views = TIME_CLOCK_DEFAULT_VIEWS,
|
|
openTo,
|
|
onViewChange,
|
|
focusedView,
|
|
onFocusedViewChange,
|
|
className,
|
|
disabled,
|
|
readOnly,
|
|
timezone: timezoneProp
|
|
} = props,
|
|
other = _objectWithoutPropertiesLoose(props, _excluded);
|
|
const slots = innerSlots != null ? innerSlots : uncapitalizeObjectKeys(components);
|
|
const slotProps = innerSlotProps != null ? innerSlotProps : componentsProps;
|
|
const {
|
|
value,
|
|
handleValueChange,
|
|
timezone
|
|
} = useControlledValueWithTimezone({
|
|
name: 'TimeClock',
|
|
timezone: timezoneProp,
|
|
value: valueProp,
|
|
defaultValue,
|
|
onChange,
|
|
valueManager: singleItemValueManager
|
|
});
|
|
const valueOrReferenceDate = useClockReferenceDate({
|
|
value,
|
|
referenceDate: referenceDateProp,
|
|
utils,
|
|
props,
|
|
timezone
|
|
});
|
|
const localeText = useLocaleText();
|
|
const now = useNow(timezone);
|
|
const {
|
|
view,
|
|
setView,
|
|
previousView,
|
|
nextView,
|
|
setValueAndGoToNextView
|
|
} = useViews({
|
|
view: inView,
|
|
views,
|
|
openTo,
|
|
onViewChange,
|
|
onChange: handleValueChange,
|
|
focusedView,
|
|
onFocusedViewChange
|
|
});
|
|
const {
|
|
meridiemMode,
|
|
handleMeridiemChange
|
|
} = useMeridiemMode(valueOrReferenceDate, ampm, setValueAndGoToNextView);
|
|
const isTimeDisabled = React.useCallback((rawValue, viewType) => {
|
|
const isAfter = createIsAfterIgnoreDatePart(disableIgnoringDatePartForTimeValidation, utils);
|
|
const shouldCheckPastEnd = viewType === 'hours' || viewType === 'minutes' && views.includes('seconds');
|
|
const containsValidTime = ({
|
|
start,
|
|
end
|
|
}) => {
|
|
if (minTime && isAfter(minTime, end)) {
|
|
return false;
|
|
}
|
|
if (maxTime && isAfter(start, maxTime)) {
|
|
return false;
|
|
}
|
|
if (disableFuture && isAfter(start, now)) {
|
|
return false;
|
|
}
|
|
if (disablePast && isAfter(now, shouldCheckPastEnd ? end : start)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
};
|
|
const isValidValue = (timeValue, step = 1) => {
|
|
if (timeValue % step !== 0) {
|
|
return false;
|
|
}
|
|
if (shouldDisableClock != null && shouldDisableClock(timeValue, viewType)) {
|
|
return false;
|
|
}
|
|
if (shouldDisableTime) {
|
|
switch (viewType) {
|
|
case 'hours':
|
|
return !shouldDisableTime(utils.setHours(valueOrReferenceDate, timeValue), 'hours');
|
|
case 'minutes':
|
|
return !shouldDisableTime(utils.setMinutes(valueOrReferenceDate, timeValue), 'minutes');
|
|
case 'seconds':
|
|
return !shouldDisableTime(utils.setSeconds(valueOrReferenceDate, timeValue), 'seconds');
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
};
|
|
switch (viewType) {
|
|
case 'hours':
|
|
{
|
|
const valueWithMeridiem = convertValueToMeridiem(rawValue, meridiemMode, ampm);
|
|
const dateWithNewHours = utils.setHours(valueOrReferenceDate, valueWithMeridiem);
|
|
const start = utils.setSeconds(utils.setMinutes(dateWithNewHours, 0), 0);
|
|
const end = utils.setSeconds(utils.setMinutes(dateWithNewHours, 59), 59);
|
|
return !containsValidTime({
|
|
start,
|
|
end
|
|
}) || !isValidValue(valueWithMeridiem);
|
|
}
|
|
case 'minutes':
|
|
{
|
|
const dateWithNewMinutes = utils.setMinutes(valueOrReferenceDate, rawValue);
|
|
const start = utils.setSeconds(dateWithNewMinutes, 0);
|
|
const end = utils.setSeconds(dateWithNewMinutes, 59);
|
|
return !containsValidTime({
|
|
start,
|
|
end
|
|
}) || !isValidValue(rawValue, minutesStep);
|
|
}
|
|
case 'seconds':
|
|
{
|
|
const dateWithNewSeconds = utils.setSeconds(valueOrReferenceDate, rawValue);
|
|
const start = dateWithNewSeconds;
|
|
const end = dateWithNewSeconds;
|
|
return !containsValidTime({
|
|
start,
|
|
end
|
|
}) || !isValidValue(rawValue);
|
|
}
|
|
default:
|
|
throw new Error('not supported');
|
|
}
|
|
}, [ampm, valueOrReferenceDate, disableIgnoringDatePartForTimeValidation, maxTime, meridiemMode, minTime, minutesStep, shouldDisableClock, shouldDisableTime, utils, disableFuture, disablePast, now, views]);
|
|
const selectedId = useId();
|
|
const viewProps = React.useMemo(() => {
|
|
switch (view) {
|
|
case 'hours':
|
|
{
|
|
const handleHoursChange = (hourValue, isFinish) => {
|
|
const valueWithMeridiem = convertValueToMeridiem(hourValue, meridiemMode, ampm);
|
|
setValueAndGoToNextView(utils.setHours(valueOrReferenceDate, valueWithMeridiem), isFinish);
|
|
};
|
|
return {
|
|
onChange: handleHoursChange,
|
|
viewValue: utils.getHours(valueOrReferenceDate),
|
|
children: getHourNumbers({
|
|
value,
|
|
utils,
|
|
ampm,
|
|
onChange: handleHoursChange,
|
|
getClockNumberText: localeText.hoursClockNumberText,
|
|
isDisabled: hourValue => disabled || isTimeDisabled(hourValue, 'hours'),
|
|
selectedId
|
|
})
|
|
};
|
|
}
|
|
case 'minutes':
|
|
{
|
|
const minutesValue = utils.getMinutes(valueOrReferenceDate);
|
|
const handleMinutesChange = (minuteValue, isFinish) => {
|
|
setValueAndGoToNextView(utils.setMinutes(valueOrReferenceDate, minuteValue), isFinish);
|
|
};
|
|
return {
|
|
viewValue: minutesValue,
|
|
onChange: handleMinutesChange,
|
|
children: getMinutesNumbers({
|
|
utils,
|
|
value: minutesValue,
|
|
onChange: handleMinutesChange,
|
|
getClockNumberText: localeText.minutesClockNumberText,
|
|
isDisabled: minuteValue => disabled || isTimeDisabled(minuteValue, 'minutes'),
|
|
selectedId
|
|
})
|
|
};
|
|
}
|
|
case 'seconds':
|
|
{
|
|
const secondsValue = utils.getSeconds(valueOrReferenceDate);
|
|
const handleSecondsChange = (secondValue, isFinish) => {
|
|
setValueAndGoToNextView(utils.setSeconds(valueOrReferenceDate, secondValue), isFinish);
|
|
};
|
|
return {
|
|
viewValue: secondsValue,
|
|
onChange: handleSecondsChange,
|
|
children: getMinutesNumbers({
|
|
utils,
|
|
value: secondsValue,
|
|
onChange: handleSecondsChange,
|
|
getClockNumberText: localeText.secondsClockNumberText,
|
|
isDisabled: secondValue => disabled || isTimeDisabled(secondValue, 'seconds'),
|
|
selectedId
|
|
})
|
|
};
|
|
}
|
|
default:
|
|
throw new Error('You must provide the type for ClockView');
|
|
}
|
|
}, [view, utils, value, ampm, localeText.hoursClockNumberText, localeText.minutesClockNumberText, localeText.secondsClockNumberText, meridiemMode, setValueAndGoToNextView, valueOrReferenceDate, isTimeDisabled, selectedId, disabled]);
|
|
const ownerState = props;
|
|
const classes = useUtilityClasses(ownerState);
|
|
return /*#__PURE__*/_jsxs(TimeClockRoot, _extends({
|
|
ref: ref,
|
|
className: clsx(classes.root, className),
|
|
ownerState: ownerState
|
|
}, other, {
|
|
children: [/*#__PURE__*/_jsx(Clock, _extends({
|
|
autoFocus: autoFocus != null ? autoFocus : !!focusedView,
|
|
ampmInClock: ampmInClock && views.includes('hours'),
|
|
value: value,
|
|
type: view,
|
|
ampm: ampm,
|
|
minutesStep: minutesStep,
|
|
isTimeDisabled: isTimeDisabled,
|
|
meridiemMode: meridiemMode,
|
|
handleMeridiemChange: handleMeridiemChange,
|
|
selectedId: selectedId,
|
|
disabled: disabled,
|
|
readOnly: readOnly
|
|
}, viewProps)), showViewSwitcher && /*#__PURE__*/_jsx(TimeClockArrowSwitcher, {
|
|
className: classes.arrowSwitcher,
|
|
slots: slots,
|
|
slotProps: slotProps,
|
|
onGoToPrevious: () => setView(previousView),
|
|
isPreviousDisabled: !previousView,
|
|
previousLabel: localeText.openPreviousView,
|
|
onGoToNext: () => setView(nextView),
|
|
isNextDisabled: !nextView,
|
|
nextLabel: localeText.openNextView,
|
|
ownerState: ownerState
|
|
})]
|
|
}));
|
|
});
|
|
process.env.NODE_ENV !== "production" ? TimeClock.propTypes = {
|
|
// ----------------------------- Warning --------------------------------
|
|
// | These PropTypes are generated from the TypeScript type definitions |
|
|
// | To update them edit the TypeScript types and run "yarn proptypes" |
|
|
// ----------------------------------------------------------------------
|
|
/**
|
|
* 12h/24h view for hour selection clock.
|
|
* @default `utils.is12HourCycleInCurrentLocale()`
|
|
*/
|
|
ampm: PropTypes.bool,
|
|
/**
|
|
* Display ampm controls under the clock (instead of in the toolbar).
|
|
* @default false
|
|
*/
|
|
ampmInClock: PropTypes.bool,
|
|
/**
|
|
* If `true`, the main element is focused during the first mount.
|
|
* This main element is:
|
|
* - the element chosen by the visible view if any (i.e: the selected day on the `day` view).
|
|
* - the `input` element if there is a field rendered.
|
|
*/
|
|
autoFocus: PropTypes.bool,
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
*/
|
|
classes: PropTypes.object,
|
|
className: PropTypes.string,
|
|
/**
|
|
* Overridable components.
|
|
* @default {}
|
|
* @deprecated Please use `slots`.
|
|
*/
|
|
components: PropTypes.object,
|
|
/**
|
|
* The props used for each component slot.
|
|
* @default {}
|
|
* @deprecated Please use `slotProps`.
|
|
*/
|
|
componentsProps: PropTypes.object,
|
|
/**
|
|
* The default selected value.
|
|
* Used when the component is not controlled.
|
|
*/
|
|
defaultValue: PropTypes.any,
|
|
/**
|
|
* If `true`, the picker views and text field are disabled.
|
|
* @default false
|
|
*/
|
|
disabled: PropTypes.bool,
|
|
/**
|
|
* If `true`, disable values after the current date for date components, time for time components and both for date time components.
|
|
* @default false
|
|
*/
|
|
disableFuture: PropTypes.bool,
|
|
/**
|
|
* Do not ignore date part when validating min/max time.
|
|
* @default false
|
|
*/
|
|
disableIgnoringDatePartForTimeValidation: PropTypes.bool,
|
|
/**
|
|
* If `true`, disable values before the current date for date components, time for time components and both for date time components.
|
|
* @default false
|
|
*/
|
|
disablePast: PropTypes.bool,
|
|
/**
|
|
* Controlled focused view.
|
|
*/
|
|
focusedView: PropTypes.oneOf(['hours', 'minutes', 'seconds']),
|
|
/**
|
|
* Maximal selectable time.
|
|
* The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
|
|
*/
|
|
maxTime: PropTypes.any,
|
|
/**
|
|
* Minimal selectable time.
|
|
* The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
|
|
*/
|
|
minTime: PropTypes.any,
|
|
/**
|
|
* Step over minutes.
|
|
* @default 1
|
|
*/
|
|
minutesStep: PropTypes.number,
|
|
/**
|
|
* Callback fired when the value changes.
|
|
* @template TValue The value type. Will be either the same type as `value` or `null`. Can be in `[start, end]` format in case of range value.
|
|
* @template TView The view type. Will be one of date or time views.
|
|
* @param {TValue} value The new value.
|
|
* @param {PickerSelectionState | undefined} selectionState Indicates if the date selection is complete.
|
|
* @param {TView | undefined} selectedView Indicates the view in which the selection has been made.
|
|
*/
|
|
onChange: PropTypes.func,
|
|
/**
|
|
* Callback fired on focused view change.
|
|
* @template TView
|
|
* @param {TView} view The new view to focus or not.
|
|
* @param {boolean} hasFocus `true` if the view should be focused.
|
|
*/
|
|
onFocusedViewChange: PropTypes.func,
|
|
/**
|
|
* Callback fired on view change.
|
|
* @template TView
|
|
* @param {TView} view The new view.
|
|
*/
|
|
onViewChange: PropTypes.func,
|
|
/**
|
|
* The default visible view.
|
|
* Used when the component view is not controlled.
|
|
* Must be a valid option from `views` list.
|
|
*/
|
|
openTo: PropTypes.oneOf(['hours', 'minutes', 'seconds']),
|
|
/**
|
|
* If `true`, the picker views and text field are read-only.
|
|
* @default false
|
|
*/
|
|
readOnly: PropTypes.bool,
|
|
/**
|
|
* The date used to generate the new value when both `value` and `defaultValue` are empty.
|
|
* @default The closest valid time using the validation props, except callbacks such as `shouldDisableTime`.
|
|
*/
|
|
referenceDate: PropTypes.any,
|
|
/**
|
|
* Disable specific clock time.
|
|
* @param {number} clockValue The value to check.
|
|
* @param {TimeView} view The clock type of the timeValue.
|
|
* @returns {boolean} If `true` the time will be disabled.
|
|
* @deprecated Consider using `shouldDisableTime`.
|
|
*/
|
|
shouldDisableClock: PropTypes.func,
|
|
/**
|
|
* Disable specific time.
|
|
* @template TDate
|
|
* @param {TDate} value The value to check.
|
|
* @param {TimeView} view The clock type of the timeValue.
|
|
* @returns {boolean} If `true` the time will be disabled.
|
|
*/
|
|
shouldDisableTime: PropTypes.func,
|
|
showViewSwitcher: PropTypes.bool,
|
|
/**
|
|
* The props used for each component slot.
|
|
* @default {}
|
|
*/
|
|
slotProps: PropTypes.object,
|
|
/**
|
|
* Overridable component slots.
|
|
* @default {}
|
|
*/
|
|
slots: PropTypes.object,
|
|
/**
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object]),
|
|
/**
|
|
* Choose which timezone to use for the value.
|
|
* Example: "default", "system", "UTC", "America/New_York".
|
|
* If you pass values from other timezones to some props, they will be converted to this timezone before being used.
|
|
* @see See the {@link https://mui.com/x/react-date-pickers/timezone/ timezones documention} for more details.
|
|
* @default The timezone of the `value` or `defaultValue` prop is defined, 'default' otherwise.
|
|
*/
|
|
timezone: PropTypes.string,
|
|
/**
|
|
* The selected value.
|
|
* Used when the component is controlled.
|
|
*/
|
|
value: PropTypes.any,
|
|
/**
|
|
* The visible view.
|
|
* Used when the component view is controlled.
|
|
* Must be a valid option from `views` list.
|
|
*/
|
|
view: PropTypes.oneOf(['hours', 'minutes', 'seconds']),
|
|
/**
|
|
* Available views.
|
|
* @default ['hours', 'minutes']
|
|
*/
|
|
views: PropTypes.arrayOf(PropTypes.oneOf(['hours', 'minutes', 'seconds']).isRequired)
|
|
} : void 0; |