@mui/x-date-pickers
Version:
The community edition of the Date and Time Picker components (MUI X).
304 lines (302 loc) • 12.6 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.StaticDatePicker = void 0;
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var React = _interopRequireWildcard(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _shared = require("../DatePicker/shared");
var _dateViewRenderers = require("../dateViewRenderers");
var _useStaticPicker = require("../internals/hooks/useStaticPicker");
var _validateDate = require("../internals/utils/validation/validateDate");
var _valueManagers = require("../internals/utils/valueManagers");
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 && {}.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:
*
* - [DatePicker](https://mui.com/x/react-date-pickers/date-picker/)
* - [Validation](https://mui.com/x/react-date-pickers/validation/)
*
* API:
*
* - [StaticDatePicker API](https://mui.com/x/api/date-pickers/static-date-picker/)
*/
const StaticDatePicker = exports.StaticDatePicker = /*#__PURE__*/React.forwardRef(function StaticDatePicker(inProps, ref) {
const defaultizedProps = (0, _shared.useDatePickerDefaultizedProps)(inProps, 'MuiStaticDatePicker');
const displayStaticWrapperAs = defaultizedProps.displayStaticWrapperAs ?? 'mobile';
const viewRenderers = (0, _extends2.default)({
day: _dateViewRenderers.renderDateViewCalendar,
month: _dateViewRenderers.renderDateViewCalendar,
year: _dateViewRenderers.renderDateViewCalendar
}, defaultizedProps.viewRenderers);
// Props with the default values specific to the static variant
const props = (0, _extends2.default)({}, defaultizedProps, {
viewRenderers,
displayStaticWrapperAs,
yearsPerRow: defaultizedProps.yearsPerRow ?? (displayStaticWrapperAs === 'mobile' ? 3 : 4),
slotProps: (0, _extends2.default)({}, defaultizedProps.slotProps, {
toolbar: (0, _extends2.default)({
hidden: displayStaticWrapperAs === 'desktop'
}, defaultizedProps.slotProps?.toolbar)
})
});
const {
renderPicker
} = (0, _useStaticPicker.useStaticPicker)({
props,
valueManager: _valueManagers.singleItemValueManager,
valueType: 'date',
validator: _validateDate.validateDate,
ref
});
return renderPicker();
});
StaticDatePicker.propTypes = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the TypeScript types and run "yarn proptypes" |
// ----------------------------------------------------------------------
/**
* 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,
className: _propTypes.default.string,
/**
* Formats the day of week displayed in the calendar header.
* @param {TDate} date The date of the day of week provided by the adapter.
* @returns {string} The name to display.
* @default (date: TDate) => adapter.format(date, 'weekdayShort').charAt(0).toUpperCase()
*/
dayOfWeekFormatter: _propTypes.default.func,
/**
* The default value.
* Used when the component is not controlled.
*/
defaultValue: _propTypes.default.object,
/**
* 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,
/**
* If `true`, today's date is rendering without highlighting with circle.
* @default false
*/
disableHighlightToday: _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,
/**
* Force static wrapper inner components to be rendered in mobile or desktop mode.
* @default "mobile"
*/
displayStaticWrapperAs: _propTypes.default.oneOf(['desktop', 'mobile']),
/**
* If `true`, the week number will be display in the calendar.
*/
displayWeekNumber: _propTypes.default.bool,
/**
* The day view will show as many weeks as needed after the end of the current month to match this value.
* Put it to 6 to have a fixed number of weeks in Gregorian calendars
*/
fixedWeekNumber: _propTypes.default.number,
/**
* 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.default.bool,
/**
* Locale for components texts.
* Allows overriding texts coming from `LocalizationProvider` and `theme`.
*/
localeText: _propTypes.default.object,
/**
* Maximal selectable date.
*/
maxDate: _propTypes.default.object,
/**
* Minimal selectable date.
*/
minDate: _propTypes.default.object,
/**
* Months rendered per row.
* @default 3
*/
monthsPerRow: _propTypes.default.oneOf([3, 4]),
/**
* 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 component requests to be closed.
* Can be fired when selecting (by default on `desktop` mode) or clearing a value.
* @deprecated Please avoid using as it will be removed in next major version.
*/
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 on month change.
* @template TDate
* @param {TDate} month The new month.
*/
onMonthChange: _propTypes.default.func,
/**
* Callback fired on view change.
* @template TView
* @param {TView} view The new view.
*/
onViewChange: _propTypes.default.func,
/**
* Callback fired on year change.
* @template TDate
* @param {TDate} year The new year.
*/
onYearChange: _propTypes.default.func,
/**
* The default visible view.
* Used when the component view is not controlled.
* Must be a valid option from `views` list.
*/
openTo: _propTypes.default.oneOf(['day', 'month', 'year']),
/**
* 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.object,
/**
* 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.default.func,
/**
* Disable specific date.
*
* Warning: This function can be called multiple times (for example 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.default.func,
/**
* Disable specific month.
* @template TDate
* @param {TDate} month The month to test.
* @returns {boolean} If `true`, the month will be disabled.
*/
shouldDisableMonth: _propTypes.default.func,
/**
* Disable specific year.
* @template TDate
* @param {TDate} year The year to test.
* @returns {boolean} If `true`, the year will be disabled.
*/
shouldDisableYear: _propTypes.default.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.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]),
/**
* 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 documentation} 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.object,
/**
* The visible view.
* Used when the component view is controlled.
* Must be a valid option from `views` list.
*/
view: _propTypes.default.oneOf(['day', 'month', 'year']),
/**
* Define custom view renderers for each section.
* If `null`, the section will only have field editing.
* If `undefined`, internally defined view will be used.
*/
viewRenderers: _propTypes.default.shape({
day: _propTypes.default.func,
month: _propTypes.default.func,
year: _propTypes.default.func
}),
/**
* Available views.
*/
views: _propTypes.default.arrayOf(_propTypes.default.oneOf(['day', 'month', 'year']).isRequired),
/**
* Years rendered per row.
* @default 3
*/
yearsPerRow: _propTypes.default.oneOf([3, 4])
};