@mui/x-date-pickers
Version:
The community edition of the Date and Time Picker components (MUI X).
342 lines (341 loc) • 11.9 kB
JavaScript
'use client';
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
import _extends from "@babel/runtime/helpers/esm/extends";
const _excluded = ["className", "value", "defaultValue", "referenceDate", "disabled", "disableFuture", "disablePast", "maxDate", "minDate", "onChange", "shouldDisableMonth", "readOnly", "disableHighlightToday", "autoFocus", "onMonthFocus", "hasFocus", "onFocusedViewChange", "monthsPerRow", "timezone", "gridLabelId", "slots", "slotProps"];
import * as React from 'react';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import { useRtl } from '@mui/system/RtlProvider';
import { styled, useThemeProps } from '@mui/material/styles';
import { unstable_useControlled as useControlled, unstable_composeClasses as composeClasses, unstable_useEventCallback as useEventCallback } from '@mui/utils';
import { PickersMonth } from "./PickersMonth.js";
import { useUtils, useNow, useDefaultDates } from "../internals/hooks/useUtils.js";
import { getMonthCalendarUtilityClass } from "./monthCalendarClasses.js";
import { applyDefaultDate, getMonthsInYear } from "../internals/utils/date-utils.js";
import { singleItemValueManager } from "../internals/utils/valueManagers.js";
import { SECTION_TYPE_GRANULARITY } from "../internals/utils/getDefaultReferenceDate.js";
import { useControlledValueWithTimezone } from "../internals/hooks/useValueWithTimezone.js";
import { DIALOG_WIDTH } from "../internals/constants/dimensions.js";
import { jsx as _jsx } from "react/jsx-runtime";
const useUtilityClasses = ownerState => {
const {
classes
} = ownerState;
const slots = {
root: ['root']
};
return composeClasses(slots, getMonthCalendarUtilityClass, classes);
};
export function useMonthCalendarDefaultizedProps(props, name) {
const utils = useUtils();
const defaultDates = useDefaultDates();
const themeProps = useThemeProps({
props,
name
});
return _extends({
disableFuture: false,
disablePast: false
}, themeProps, {
minDate: applyDefaultDate(utils, themeProps.minDate, defaultDates.minDate),
maxDate: applyDefaultDate(utils, themeProps.maxDate, defaultDates.maxDate)
});
}
const MonthCalendarRoot = styled('div', {
name: 'MuiMonthCalendar',
slot: 'Root',
overridesResolver: (props, styles) => styles.root
})({
display: 'flex',
flexWrap: 'wrap',
alignContent: 'stretch',
padding: '0 4px',
width: DIALOG_WIDTH,
// avoid padding increasing width over defined
boxSizing: 'border-box'
});
/**
* Demos:
*
* - [DateCalendar](https://mui.com/x/react-date-pickers/date-calendar/)
*
* API:
*
* - [MonthCalendar API](https://mui.com/x/api/date-pickers/month-calendar/)
*/
export const MonthCalendar = /*#__PURE__*/React.forwardRef(function MonthCalendar(inProps, ref) {
const props = useMonthCalendarDefaultizedProps(inProps, 'MuiMonthCalendar');
const {
className,
value: valueProp,
defaultValue,
referenceDate: referenceDateProp,
disabled,
disableFuture,
disablePast,
maxDate,
minDate,
onChange,
shouldDisableMonth,
readOnly,
autoFocus = false,
onMonthFocus,
hasFocus,
onFocusedViewChange,
monthsPerRow = 3,
timezone: timezoneProp,
gridLabelId,
slots,
slotProps
} = props,
other = _objectWithoutPropertiesLoose(props, _excluded);
const {
value,
handleValueChange,
timezone
} = useControlledValueWithTimezone({
name: 'MonthCalendar',
timezone: timezoneProp,
value: valueProp,
defaultValue,
referenceDate: referenceDateProp,
onChange,
valueManager: singleItemValueManager
});
const now = useNow(timezone);
const isRtl = useRtl();
const utils = useUtils();
const referenceDate = React.useMemo(() => singleItemValueManager.getInitialReferenceValue({
value,
utils,
props,
timezone,
referenceDate: referenceDateProp,
granularity: SECTION_TYPE_GRANULARITY.month
}), [] // eslint-disable-line react-hooks/exhaustive-deps
);
const ownerState = props;
const classes = useUtilityClasses(ownerState);
const todayMonth = React.useMemo(() => utils.getMonth(now), [utils, now]);
const selectedMonth = React.useMemo(() => {
if (value != null) {
return utils.getMonth(value);
}
return null;
}, [value, utils]);
const [focusedMonth, setFocusedMonth] = React.useState(() => selectedMonth || utils.getMonth(referenceDate));
const [internalHasFocus, setInternalHasFocus] = useControlled({
name: 'MonthCalendar',
state: 'hasFocus',
controlled: hasFocus,
default: autoFocus ?? false
});
const changeHasFocus = useEventCallback(newHasFocus => {
setInternalHasFocus(newHasFocus);
if (onFocusedViewChange) {
onFocusedViewChange(newHasFocus);
}
});
const isMonthDisabled = React.useCallback(dateToValidate => {
const firstEnabledMonth = utils.startOfMonth(disablePast && utils.isAfter(now, minDate) ? now : minDate);
const lastEnabledMonth = utils.startOfMonth(disableFuture && utils.isBefore(now, maxDate) ? now : maxDate);
const monthToValidate = utils.startOfMonth(dateToValidate);
if (utils.isBefore(monthToValidate, firstEnabledMonth)) {
return true;
}
if (utils.isAfter(monthToValidate, lastEnabledMonth)) {
return true;
}
if (!shouldDisableMonth) {
return false;
}
return shouldDisableMonth(monthToValidate);
}, [disableFuture, disablePast, maxDate, minDate, now, shouldDisableMonth, utils]);
const handleMonthSelection = useEventCallback((event, month) => {
if (readOnly) {
return;
}
const newDate = utils.setMonth(value ?? referenceDate, month);
handleValueChange(newDate);
});
const focusMonth = useEventCallback(month => {
if (!isMonthDisabled(utils.setMonth(value ?? referenceDate, month))) {
setFocusedMonth(month);
changeHasFocus(true);
if (onMonthFocus) {
onMonthFocus(month);
}
}
});
React.useEffect(() => {
setFocusedMonth(prevFocusedMonth => selectedMonth !== null && prevFocusedMonth !== selectedMonth ? selectedMonth : prevFocusedMonth);
}, [selectedMonth]);
const handleKeyDown = useEventCallback((event, month) => {
const monthsInYear = 12;
const monthsInRow = 3;
switch (event.key) {
case 'ArrowUp':
focusMonth((monthsInYear + month - monthsInRow) % monthsInYear);
event.preventDefault();
break;
case 'ArrowDown':
focusMonth((monthsInYear + month + monthsInRow) % monthsInYear);
event.preventDefault();
break;
case 'ArrowLeft':
focusMonth((monthsInYear + month + (isRtl ? 1 : -1)) % monthsInYear);
event.preventDefault();
break;
case 'ArrowRight':
focusMonth((monthsInYear + month + (isRtl ? -1 : 1)) % monthsInYear);
event.preventDefault();
break;
default:
break;
}
});
const handleMonthFocus = useEventCallback((event, month) => {
focusMonth(month);
});
const handleMonthBlur = useEventCallback((event, month) => {
if (focusedMonth === month) {
changeHasFocus(false);
}
});
return /*#__PURE__*/_jsx(MonthCalendarRoot, _extends({
ref: ref,
className: clsx(classes.root, className),
ownerState: ownerState,
role: "radiogroup",
"aria-labelledby": gridLabelId
}, other, {
children: getMonthsInYear(utils, value ?? referenceDate).map(month => {
const monthNumber = utils.getMonth(month);
const monthText = utils.format(month, 'monthShort');
const monthLabel = utils.format(month, 'month');
const isSelected = monthNumber === selectedMonth;
const isDisabled = disabled || isMonthDisabled(month);
return /*#__PURE__*/_jsx(PickersMonth, {
selected: isSelected,
value: monthNumber,
onClick: handleMonthSelection,
onKeyDown: handleKeyDown,
autoFocus: internalHasFocus && monthNumber === focusedMonth,
disabled: isDisabled,
tabIndex: monthNumber === focusedMonth && !isDisabled ? 0 : -1,
onFocus: handleMonthFocus,
onBlur: handleMonthBlur,
"aria-current": todayMonth === monthNumber ? 'date' : undefined,
"aria-label": monthLabel,
monthsPerRow: monthsPerRow,
slots: slots,
slotProps: slotProps,
children: monthText
}, monthText);
})
}));
});
process.env.NODE_ENV !== "production" ? MonthCalendar.propTypes = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the TypeScript types and run "pnpm proptypes" |
// ----------------------------------------------------------------------
autoFocus: PropTypes.bool,
/**
* Override or extend the styles applied to the component.
*/
classes: PropTypes.object,
className: PropTypes.string,
/**
* The default selected value.
* Used when the component is not controlled.
*/
defaultValue: PropTypes.object,
/**
* If `true` picker is disabled
*/
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,
/**
* 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,
gridLabelId: PropTypes.string,
hasFocus: PropTypes.bool,
/**
* Maximal selectable date.
* @default 2099-12-31
*/
maxDate: PropTypes.object,
/**
* Minimal selectable date.
* @default 1900-01-01
*/
minDate: PropTypes.object,
/**
* Months rendered per row.
* @default 3
*/
monthsPerRow: PropTypes.oneOf([3, 4]),
/**
* Callback fired when the value changes.
* @template TDate
* @param {TDate} value The new value.
*/
onChange: PropTypes.func,
onFocusedViewChange: PropTypes.func,
onMonthFocus: PropTypes.func,
/**
* If `true` picker is readonly
*/
readOnly: PropTypes.bool,
/**
* The date used to generate the new value when both `value` and `defaultValue` are empty.
* @default The closest valid month using the validation props, except callbacks such as `shouldDisableMonth`.
*/
referenceDate: PropTypes.object,
/**
* Disable specific month.
* @template TDate
* @param {TDate} month The month to test.
* @returns {boolean} If `true`, the month will be disabled.
*/
shouldDisableMonth: PropTypes.func,
/**
* 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 documentation} 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.object
} : void 0;