382 lines
16 KiB
JavaScript
382 lines
16 KiB
JavaScript
"use strict";
|
|
|
|
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.DesktopTimePicker = void 0;
|
|
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
|
|
var React = _interopRequireWildcard(require("react"));
|
|
var _propTypes = _interopRequireDefault(require("prop-types"));
|
|
var _utils = require("@mui/base/utils");
|
|
var _utils2 = require("@mui/utils");
|
|
var _valueManagers = require("../internals/utils/valueManagers");
|
|
var _TimeField = require("../TimeField");
|
|
var _shared = require("../TimePicker/shared");
|
|
var _useUtils = require("../internals/hooks/useUtils");
|
|
var _validateTime = require("../internals/utils/validation/validateTime");
|
|
var _icons = require("../icons");
|
|
var _useDesktopPicker = require("../internals/hooks/useDesktopPicker");
|
|
var _extractValidationProps = require("../internals/utils/validation/extractValidationProps");
|
|
var _timeViewRenderers = require("../timeViewRenderers");
|
|
var _timeUtils = require("../internals/utils/time-utils");
|
|
var _dateTimeUtils = require("../internals/utils/date-time-utils");
|
|
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
|
|
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
|
|
/**
|
|
* Demos:
|
|
*
|
|
* - [TimePicker](https://mui.com/x/react-date-pickers/time-picker/)
|
|
* - [Validation](https://mui.com/x/react-date-pickers/validation/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [DesktopTimePicker API](https://mui.com/x/api/date-pickers/desktop-time-picker/)
|
|
*/
|
|
const DesktopTimePicker = exports.DesktopTimePicker = /*#__PURE__*/React.forwardRef(function DesktopTimePicker(inProps, ref) {
|
|
const localeText = (0, _useUtils.useLocaleText)();
|
|
const utils = (0, _useUtils.useUtils)();
|
|
|
|
// Props with the default values common to all time pickers
|
|
const defaultizedProps = (0, _shared.useTimePickerDefaultizedProps)(inProps, 'MuiDesktopTimePicker');
|
|
const {
|
|
shouldRenderTimeInASingleColumn,
|
|
views: resolvedViews,
|
|
timeSteps
|
|
} = (0, _dateTimeUtils.resolveTimeViewsResponse)(defaultizedProps);
|
|
const renderTimeView = shouldRenderTimeInASingleColumn ? _timeViewRenderers.renderDigitalClockTimeView : _timeViewRenderers.renderMultiSectionDigitalClockTimeView;
|
|
const viewRenderers = (0, _extends2.default)({
|
|
hours: renderTimeView,
|
|
minutes: renderTimeView,
|
|
seconds: renderTimeView,
|
|
meridiem: renderTimeView
|
|
}, defaultizedProps.viewRenderers);
|
|
const ampmInClock = defaultizedProps.ampmInClock ?? true;
|
|
const actionBarActions = shouldRenderTimeInASingleColumn ? [] : ['accept'];
|
|
// Need to avoid adding the `meridiem` view when unexpected renderer is specified
|
|
const shouldHoursRendererContainMeridiemView = viewRenderers.hours?.name === _timeViewRenderers.renderMultiSectionDigitalClockTimeView.name;
|
|
const views = !shouldHoursRendererContainMeridiemView ? resolvedViews.filter(view => view !== 'meridiem') : resolvedViews;
|
|
|
|
// Props with the default values specific to the desktop variant
|
|
const props = (0, _extends2.default)({}, defaultizedProps, {
|
|
ampmInClock,
|
|
timeSteps,
|
|
viewRenderers,
|
|
format: (0, _timeUtils.resolveTimeFormat)(utils, defaultizedProps),
|
|
// Setting only `hours` time view in case of single column time picker
|
|
// Allows for easy view lifecycle management
|
|
views: shouldRenderTimeInASingleColumn ? ['hours'] : views,
|
|
slots: (0, _extends2.default)({
|
|
field: _TimeField.TimeField,
|
|
openPickerIcon: _icons.ClockIcon
|
|
}, defaultizedProps.slots),
|
|
slotProps: (0, _extends2.default)({}, defaultizedProps.slotProps, {
|
|
field: ownerState => (0, _extends2.default)({}, (0, _utils.resolveComponentProps)(defaultizedProps.slotProps?.field, ownerState), (0, _extractValidationProps.extractValidationProps)(defaultizedProps), {
|
|
ref
|
|
}),
|
|
toolbar: (0, _extends2.default)({
|
|
hidden: true,
|
|
ampmInClock
|
|
}, defaultizedProps.slotProps?.toolbar),
|
|
actionBar: (0, _extends2.default)({
|
|
actions: actionBarActions
|
|
}, defaultizedProps.slotProps?.actionBar)
|
|
})
|
|
});
|
|
const {
|
|
renderPicker
|
|
} = (0, _useDesktopPicker.useDesktopPicker)({
|
|
props,
|
|
valueManager: _valueManagers.singleItemValueManager,
|
|
valueType: 'time',
|
|
getOpenDialogAriaText: props.localeText?.openTimePickerDialogue ?? localeText.openTimePickerDialogue,
|
|
validator: _validateTime.validateTime
|
|
});
|
|
return renderPicker();
|
|
});
|
|
DesktopTimePicker.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.default.bool,
|
|
/**
|
|
* Display ampm controls under the clock (instead of in the toolbar).
|
|
* @default true on desktop, false on mobile
|
|
*/
|
|
ampmInClock: _propTypes.default.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.default.bool,
|
|
/**
|
|
* Class name applied to the root element.
|
|
*/
|
|
className: _propTypes.default.string,
|
|
/**
|
|
* If `true`, the popover or modal will close after submitting the full date.
|
|
* @default `true` for desktop, `false` for mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop).
|
|
*/
|
|
closeOnSelect: _propTypes.default.bool,
|
|
/**
|
|
* Overridable components.
|
|
* @default {}
|
|
* @deprecated Please use `slots`.
|
|
*/
|
|
components: _propTypes.default.object,
|
|
/**
|
|
* The props used for each component slot.
|
|
* @default {}
|
|
* @deprecated Please use `slotProps`.
|
|
*/
|
|
componentsProps: _propTypes.default.object,
|
|
/**
|
|
* The default value.
|
|
* Used when the component is not controlled.
|
|
*/
|
|
defaultValue: _propTypes.default.any,
|
|
/**
|
|
* If `true`, the picker and text field are disabled.
|
|
* @default false
|
|
*/
|
|
disabled: _propTypes.default.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.default.bool,
|
|
/**
|
|
* Do not ignore date part when validating min/max time.
|
|
* @default false
|
|
*/
|
|
disableIgnoringDatePartForTimeValidation: _propTypes.default.bool,
|
|
/**
|
|
* If `true`, the open picker button will not be rendered (renders only the field).
|
|
* @default false
|
|
*/
|
|
disableOpenPicker: _propTypes.default.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.default.bool,
|
|
/**
|
|
* Format of the date when rendered in the input(s).
|
|
* Defaults to localized format based on the used `views`.
|
|
*/
|
|
format: _propTypes.default.string,
|
|
/**
|
|
* Density of the format when rendered in the input.
|
|
* Setting `formatDensity` to `"spacious"` will add a space before and after each `/`, `-` and `.` character.
|
|
* @default "dense"
|
|
*/
|
|
formatDensity: _propTypes.default.oneOf(['dense', 'spacious']),
|
|
/**
|
|
* Pass a ref to the `input` element.
|
|
*/
|
|
inputRef: _utils2.refType,
|
|
/**
|
|
* The label content.
|
|
*/
|
|
label: _propTypes.default.node,
|
|
/**
|
|
* Locale for components texts.
|
|
* Allows overriding texts coming from `LocalizationProvider` and `theme`.
|
|
*/
|
|
localeText: _propTypes.default.object,
|
|
/**
|
|
* Maximal selectable time.
|
|
* The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
|
|
*/
|
|
maxTime: _propTypes.default.any,
|
|
/**
|
|
* Minimal selectable time.
|
|
* The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
|
|
*/
|
|
minTime: _propTypes.default.any,
|
|
/**
|
|
* Step over minutes.
|
|
* @default 1
|
|
*/
|
|
minutesStep: _propTypes.default.number,
|
|
/**
|
|
* Name attribute used by the `input` element in the Field.
|
|
*/
|
|
name: _propTypes.default.string,
|
|
/**
|
|
* Callback fired when the value is accepted.
|
|
* @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.
|
|
* @param {TValue} value The value that was just accepted.
|
|
*/
|
|
onAccept: _propTypes.default.func,
|
|
/**
|
|
* 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 TError The validation error type. Will be either `string` or a `null`. Can be in `[start, end]` format in case of range value.
|
|
* @param {TValue} value The new value.
|
|
* @param {FieldChangeHandlerContext<TError>} context The context containing the validation result of the current value.
|
|
*/
|
|
onChange: _propTypes.default.func,
|
|
/**
|
|
* Callback fired when the popup requests to be closed.
|
|
* Use in controlled mode (see `open`).
|
|
*/
|
|
onClose: _propTypes.default.func,
|
|
/**
|
|
* Callback fired when the error associated to the current value changes.
|
|
* If the error has a non-null value, then the `TextField` will be rendered in `error` state.
|
|
*
|
|
* @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 TError The validation error type. Will be either `string` or a `null`. Can be in `[start, end]` format in case of range value.
|
|
* @param {TError} error The new error describing why the current value is not valid.
|
|
* @param {TValue} value The value associated to the error.
|
|
*/
|
|
onError: _propTypes.default.func,
|
|
/**
|
|
* Callback fired when the popup requests to be opened.
|
|
* Use in controlled mode (see `open`).
|
|
*/
|
|
onOpen: _propTypes.default.func,
|
|
/**
|
|
* Callback fired when the selected sections change.
|
|
* @param {FieldSelectedSections} newValue The new selected sections.
|
|
*/
|
|
onSelectedSectionsChange: _propTypes.default.func,
|
|
/**
|
|
* Callback fired on view change.
|
|
* @template TView
|
|
* @param {TView} view The new view.
|
|
*/
|
|
onViewChange: _propTypes.default.func,
|
|
/**
|
|
* Control the popup or dialog open state.
|
|
* @default false
|
|
*/
|
|
open: _propTypes.default.bool,
|
|
/**
|
|
* The default visible view.
|
|
* Used when the component view is not controlled.
|
|
* Must be a valid option from `views` list.
|
|
*/
|
|
openTo: _propTypes.default.oneOf(['hours', 'meridiem', 'minutes', 'seconds']),
|
|
/**
|
|
* Force rendering in particular orientation.
|
|
*/
|
|
orientation: _propTypes.default.oneOf(['landscape', 'portrait']),
|
|
readOnly: _propTypes.default.bool,
|
|
/**
|
|
* If `true`, disable heavy animations.
|
|
* @default `@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13
|
|
*/
|
|
reduceAnimations: _propTypes.default.bool,
|
|
/**
|
|
* The date used to generate the new value when both `value` and `defaultValue` are empty.
|
|
* @default The closest valid date-time using the validation props, except callbacks like `shouldDisable<...>`.
|
|
*/
|
|
referenceDate: _propTypes.default.any,
|
|
/**
|
|
* The currently selected sections.
|
|
* This prop accept four formats:
|
|
* 1. If a number is provided, the section at this index will be selected.
|
|
* 2. If an object with a `startIndex` and `endIndex` properties are provided, the sections between those two indexes will be selected.
|
|
* 3. If a string of type `FieldSectionType` is provided, the first section with that name will be selected.
|
|
* 4. If `null` is provided, no section will be selected
|
|
* If not provided, the selected sections will be handled internally.
|
|
*/
|
|
selectedSections: _propTypes.default.oneOfType([_propTypes.default.oneOf(['all', 'day', 'hours', 'meridiem', 'minutes', 'month', 'seconds', 'weekDay', 'year']), _propTypes.default.number, _propTypes.default.shape({
|
|
endIndex: _propTypes.default.number.isRequired,
|
|
startIndex: _propTypes.default.number.isRequired
|
|
})]),
|
|
/**
|
|
* 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.default.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.default.func,
|
|
/**
|
|
* If `true`, disabled digital clock items will not be rendered.
|
|
* @default false
|
|
*/
|
|
skipDisabled: _propTypes.default.bool,
|
|
/**
|
|
* The props used for each component slot.
|
|
* @default {}
|
|
*/
|
|
slotProps: _propTypes.default.object,
|
|
/**
|
|
* Overridable component slots.
|
|
* @default {}
|
|
*/
|
|
slots: _propTypes.default.object,
|
|
/**
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object, _propTypes.default.bool])), _propTypes.default.func, _propTypes.default.object]),
|
|
/**
|
|
* Amount of time options below or at which the single column time renderer is used.
|
|
* @default 24
|
|
*/
|
|
thresholdToRenderTimeInASingleColumn: _propTypes.default.number,
|
|
/**
|
|
* The time steps between two time unit options.
|
|
* For example, if `timeStep.minutes = 8`, then the available minute options will be `[0, 8, 16, 24, 32, 40, 48, 56]`.
|
|
* When single column time renderer is used, only `timeStep.minutes` will be used.
|
|
* @default{ hours: 1, minutes: 5, seconds: 5 }
|
|
*/
|
|
timeSteps: _propTypes.default.shape({
|
|
hours: _propTypes.default.number,
|
|
minutes: _propTypes.default.number,
|
|
seconds: _propTypes.default.number
|
|
}),
|
|
/**
|
|
* 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.default.string,
|
|
/**
|
|
* The selected value.
|
|
* Used when the component is controlled.
|
|
*/
|
|
value: _propTypes.default.any,
|
|
/**
|
|
* The visible view.
|
|
* Used when the component view is controlled.
|
|
* Must be a valid option from `views` list.
|
|
*/
|
|
view: _propTypes.default.oneOf(['hours', 'meridiem', 'minutes', 'seconds']),
|
|
/**
|
|
* Define custom view renderers for each section.
|
|
* If `null`, the section will only have field editing.
|
|
* If `undefined`, internally defined view will be the used.
|
|
*/
|
|
viewRenderers: _propTypes.default.shape({
|
|
hours: _propTypes.default.func,
|
|
meridiem: _propTypes.default.func,
|
|
minutes: _propTypes.default.func,
|
|
seconds: _propTypes.default.func
|
|
}),
|
|
/**
|
|
* Available views.
|
|
*/
|
|
views: _propTypes.default.arrayOf(_propTypes.default.oneOf(['hours', 'minutes', 'seconds']).isRequired)
|
|
}; |