454 lines
16 KiB
JavaScript
454 lines
16 KiB
JavaScript
import _extends from "@babel/runtime/helpers/esm/extends";
|
|
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
|
|
const _excluded = ["desktopModeMediaQuery"];
|
|
import * as React from 'react';
|
|
import PropTypes from 'prop-types';
|
|
import useMediaQuery from '@mui/material/useMediaQuery';
|
|
import { useThemeProps } from '@mui/material/styles';
|
|
import { refType } from '@mui/utils';
|
|
import { DesktopDateTimePicker } from '../DesktopDateTimePicker';
|
|
import { MobileDateTimePicker } from '../MobileDateTimePicker';
|
|
import { DEFAULT_DESKTOP_MODE_MEDIA_QUERY } from '../internals/utils/utils';
|
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
/**
|
|
* Demos:
|
|
*
|
|
* - [DateTimePicker](https://mui.com/x/react-date-pickers/date-time-picker/)
|
|
* - [Validation](https://mui.com/x/react-date-pickers/validation/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [DateTimePicker API](https://mui.com/x/api/date-pickers/date-time-picker/)
|
|
*/
|
|
const DateTimePicker = /*#__PURE__*/React.forwardRef(function DateTimePicker(inProps, ref) {
|
|
const props = useThemeProps({
|
|
props: inProps,
|
|
name: 'MuiDateTimePicker'
|
|
});
|
|
const {
|
|
desktopModeMediaQuery = DEFAULT_DESKTOP_MODE_MEDIA_QUERY
|
|
} = props,
|
|
other = _objectWithoutPropertiesLoose(props, _excluded);
|
|
|
|
// defaults to `true` in environments where `window.matchMedia` would not be available (i.e. test/jsdom)
|
|
const isDesktop = useMediaQuery(desktopModeMediaQuery, {
|
|
defaultMatches: true
|
|
});
|
|
if (isDesktop) {
|
|
return /*#__PURE__*/_jsx(DesktopDateTimePicker, _extends({
|
|
ref: ref
|
|
}, other));
|
|
}
|
|
return /*#__PURE__*/_jsx(MobileDateTimePicker, _extends({
|
|
ref: ref
|
|
}, other));
|
|
});
|
|
process.env.NODE_ENV !== "production" ? DateTimePicker.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 true on desktop, false on mobile
|
|
*/
|
|
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,
|
|
/**
|
|
* Class name applied to the root element.
|
|
*/
|
|
className: PropTypes.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.bool,
|
|
/**
|
|
* 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,
|
|
/**
|
|
* Formats the day of week displayed in the calendar header.
|
|
* @param {string} day The day of week provided by the adapter. Deprecated, will be removed in v7: Use `date` instead.
|
|
* @param {TDate} date The date of the day of week provided by the adapter.
|
|
* @returns {string} The name to display.
|
|
* @default (_day: string, date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
|
|
*/
|
|
dayOfWeekFormatter: PropTypes.func,
|
|
/**
|
|
* Default calendar month displayed when `value` and `defaultValue` are empty.
|
|
* @deprecated Consider using `referenceDate` instead.
|
|
*/
|
|
defaultCalendarMonth: PropTypes.any,
|
|
/**
|
|
* The default value.
|
|
* Used when the component is not controlled.
|
|
*/
|
|
defaultValue: PropTypes.any,
|
|
/**
|
|
* CSS media query when `Mobile` mode will be changed to `Desktop`.
|
|
* @default '@media (pointer: fine)'
|
|
* @example '@media (min-width: 720px)' or theme.breakpoints.up("sm")
|
|
*/
|
|
desktopModeMediaQuery: PropTypes.string,
|
|
/**
|
|
* If `true`, the picker 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,
|
|
/**
|
|
* If `true`, today's date is rendering without highlighting with circle.
|
|
* @default false
|
|
*/
|
|
disableHighlightToday: PropTypes.bool,
|
|
/**
|
|
* Do not ignore date part when validating min/max time.
|
|
* @default false
|
|
*/
|
|
disableIgnoringDatePartForTimeValidation: PropTypes.bool,
|
|
/**
|
|
* If `true`, the open picker button will not be rendered (renders only the field).
|
|
* @default false
|
|
*/
|
|
disableOpenPicker: 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,
|
|
/**
|
|
* If `true`, the week number will be display in the calendar.
|
|
*/
|
|
displayWeekNumber: PropTypes.bool,
|
|
/**
|
|
* Calendar will show more weeks in order to match this value.
|
|
* Put it to 6 for having fix number of week in Gregorian calendars
|
|
* @default undefined
|
|
*/
|
|
fixedWeekNumber: PropTypes.number,
|
|
/**
|
|
* Format of the date when rendered in the input(s).
|
|
* Defaults to localized format based on the used `views`.
|
|
*/
|
|
format: PropTypes.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.oneOf(['dense', 'spacious']),
|
|
/**
|
|
* Pass a ref to the `input` element.
|
|
*/
|
|
inputRef: refType,
|
|
/**
|
|
* The label content.
|
|
*/
|
|
label: PropTypes.node,
|
|
/**
|
|
* If `true`, calls `renderLoading` instead of rendering the day calendar.
|
|
* Can be used to preload information and show it in calendar.
|
|
* @default false
|
|
*/
|
|
loading: PropTypes.bool,
|
|
/**
|
|
* Locale for components texts.
|
|
* Allows overriding texts coming from `LocalizationProvider` and `theme`.
|
|
*/
|
|
localeText: PropTypes.object,
|
|
/**
|
|
* Maximal selectable date.
|
|
*/
|
|
maxDate: PropTypes.any,
|
|
/**
|
|
* Maximal selectable moment of time with binding to date, to set max time in each day use `maxTime`.
|
|
*/
|
|
maxDateTime: PropTypes.any,
|
|
/**
|
|
* Maximal selectable time.
|
|
* The date part of the object will be ignored unless `props.disableIgnoringDatePartForTimeValidation === true`.
|
|
*/
|
|
maxTime: PropTypes.any,
|
|
/**
|
|
* Minimal selectable date.
|
|
*/
|
|
minDate: PropTypes.any,
|
|
/**
|
|
* Minimal selectable moment of time with binding to date, to set min time in each day use `minTime`.
|
|
*/
|
|
minDateTime: 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,
|
|
/**
|
|
* Months rendered per row.
|
|
* @default 3
|
|
*/
|
|
monthsPerRow: PropTypes.oneOf([3, 4]),
|
|
/**
|
|
* Name attribute used by the `input` element in the Field.
|
|
*/
|
|
name: PropTypes.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.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.func,
|
|
/**
|
|
* Callback fired when the popup requests to be closed.
|
|
* Use in controlled mode (see `open`).
|
|
*/
|
|
onClose: PropTypes.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.func,
|
|
/**
|
|
* Callback fired on month change.
|
|
* @template TDate
|
|
* @param {TDate} month The new month.
|
|
*/
|
|
onMonthChange: PropTypes.func,
|
|
/**
|
|
* Callback fired when the popup requests to be opened.
|
|
* Use in controlled mode (see `open`).
|
|
*/
|
|
onOpen: PropTypes.func,
|
|
/**
|
|
* Callback fired when the selected sections change.
|
|
* @param {FieldSelectedSections} newValue The new selected sections.
|
|
*/
|
|
onSelectedSectionsChange: PropTypes.func,
|
|
/**
|
|
* Callback fired on view change.
|
|
* @template TView
|
|
* @param {TView} view The new view.
|
|
*/
|
|
onViewChange: PropTypes.func,
|
|
/**
|
|
* Callback fired on year change.
|
|
* @template TDate
|
|
* @param {TDate} year The new year.
|
|
*/
|
|
onYearChange: PropTypes.func,
|
|
/**
|
|
* Control the popup or dialog open state.
|
|
* @default false
|
|
*/
|
|
open: PropTypes.bool,
|
|
/**
|
|
* The default visible view.
|
|
* Used when the component view is not controlled.
|
|
* Must be a valid option from `views` list.
|
|
*/
|
|
openTo: PropTypes.oneOf(['day', 'hours', 'meridiem', 'minutes', 'month', 'seconds', 'year']),
|
|
/**
|
|
* Force rendering in particular orientation.
|
|
*/
|
|
orientation: PropTypes.oneOf(['landscape', 'portrait']),
|
|
readOnly: PropTypes.bool,
|
|
/**
|
|
* If `true`, disable heavy animations.
|
|
* @default `@media(prefers-reduced-motion: reduce)` || `navigator.userAgent` matches Android <10 or iOS <13
|
|
*/
|
|
reduceAnimations: PropTypes.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.any,
|
|
/**
|
|
* Component displaying when passed `loading` true.
|
|
* @returns {React.ReactNode} The node to render when loading.
|
|
* @default () => <span data-mui-test="loading-progress">...</span>
|
|
*/
|
|
renderLoading: PropTypes.func,
|
|
/**
|
|
* 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.oneOfType([PropTypes.oneOf(['all', 'day', 'hours', 'meridiem', 'minutes', 'month', 'seconds', 'weekDay', 'year']), PropTypes.number, PropTypes.shape({
|
|
endIndex: PropTypes.number.isRequired,
|
|
startIndex: PropTypes.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.func,
|
|
/**
|
|
* Disable specific date.
|
|
*
|
|
* Warning: This function can be called multiple times (e.g. when rendering date calendar, checking if focus can be moved to a certain date, etc.). Expensive computations can impact performance.
|
|
*
|
|
* @template TDate
|
|
* @param {TDate} day The date to test.
|
|
* @returns {boolean} If `true` the date will be disabled.
|
|
*/
|
|
shouldDisableDate: PropTypes.func,
|
|
/**
|
|
* Disable specific month.
|
|
* @template TDate
|
|
* @param {TDate} month The month to test.
|
|
* @returns {boolean} If `true`, the month will be disabled.
|
|
*/
|
|
shouldDisableMonth: 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,
|
|
/**
|
|
* Disable specific year.
|
|
* @template TDate
|
|
* @param {TDate} year The year to test.
|
|
* @returns {boolean} If `true`, the year will be disabled.
|
|
*/
|
|
shouldDisableYear: PropTypes.func,
|
|
/**
|
|
* If `true`, days outside the current month are rendered:
|
|
*
|
|
* - if `fixedWeekNumber` is defined, renders days to have the weeks requested.
|
|
*
|
|
* - if `fixedWeekNumber` is not defined, renders day to fill the first and last week of the current month.
|
|
*
|
|
* - ignored if `calendars` equals more than `1` on range pickers.
|
|
* @default false
|
|
*/
|
|
showDaysOutsideCurrentMonth: PropTypes.bool,
|
|
/**
|
|
* If `true`, disabled digital clock items will not be rendered.
|
|
* @default false
|
|
*/
|
|
skipDisabled: 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]),
|
|
/**
|
|
* Amount of time options below or at which the single column time renderer is used.
|
|
* @default 24
|
|
*/
|
|
thresholdToRenderTimeInASingleColumn: PropTypes.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.shape({
|
|
hours: PropTypes.number,
|
|
minutes: PropTypes.number,
|
|
seconds: PropTypes.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.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(['day', 'hours', 'meridiem', 'minutes', 'month', 'seconds', 'year']),
|
|
/**
|
|
* 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.shape({
|
|
day: PropTypes.func,
|
|
hours: PropTypes.func,
|
|
meridiem: PropTypes.func,
|
|
minutes: PropTypes.func,
|
|
month: PropTypes.func,
|
|
seconds: PropTypes.func,
|
|
year: PropTypes.func
|
|
}),
|
|
/**
|
|
* Available views.
|
|
*/
|
|
views: PropTypes.arrayOf(PropTypes.oneOf(['day', 'hours', 'minutes', 'month', 'seconds', 'year']).isRequired),
|
|
/**
|
|
* Years rendered per row.
|
|
* @default 4 on desktop, 3 on mobile
|
|
*/
|
|
yearsPerRow: PropTypes.oneOf([3, 4])
|
|
} : void 0;
|
|
export { DateTimePicker }; |