@mui/x-date-pickers
Version:
The community edition of the Date and Time Picker components (MUI X).
370 lines (366 loc) • 13 kB
JavaScript
'use client';
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
import _extends from "@babel/runtime/helpers/esm/extends";
const _excluded = ["autoFocus", "className", "day", "disabled", "disableHighlightToday", "disableMargin", "hidden", "isAnimating", "onClick", "onDaySelect", "onFocus", "onBlur", "onKeyDown", "onMouseDown", "onMouseEnter", "outsideCurrentMonth", "selected", "showDaysOutsideCurrentMonth", "children", "today", "isFirstVisibleCell", "isLastVisibleCell"];
import * as React from 'react';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import ButtonBase from '@mui/material/ButtonBase';
import { unstable_useEnhancedEffect as useEnhancedEffect, unstable_composeClasses as composeClasses, unstable_useForkRef as useForkRef } from '@mui/utils';
import { alpha, styled, useThemeProps } from '@mui/material/styles';
import { useUtils } from "../internals/hooks/useUtils.js";
import { DAY_SIZE, DAY_MARGIN } from "../internals/constants/dimensions.js";
import { getPickersDayUtilityClass, pickersDayClasses } from "./pickersDayClasses.js";
import { jsx as _jsx } from "react/jsx-runtime";
const useUtilityClasses = ownerState => {
const {
selected,
disableMargin,
disableHighlightToday,
today,
disabled,
outsideCurrentMonth,
showDaysOutsideCurrentMonth,
classes
} = ownerState;
const isHiddenDaySpacingFiller = outsideCurrentMonth && !showDaysOutsideCurrentMonth;
const slots = {
root: ['root', selected && !isHiddenDaySpacingFiller && 'selected', disabled && 'disabled', !disableMargin && 'dayWithMargin', !disableHighlightToday && today && 'today', outsideCurrentMonth && showDaysOutsideCurrentMonth && 'dayOutsideMonth', isHiddenDaySpacingFiller && 'hiddenDaySpacingFiller'],
hiddenDaySpacingFiller: ['hiddenDaySpacingFiller']
};
return composeClasses(slots, getPickersDayUtilityClass, classes);
};
const styleArg = ({
theme
}) => _extends({}, theme.typography.caption, {
width: DAY_SIZE,
height: DAY_SIZE,
borderRadius: '50%',
padding: 0,
// explicitly setting to `transparent` to avoid potentially getting impacted by change from the overridden component
backgroundColor: 'transparent',
transition: theme.transitions.create('background-color', {
duration: theme.transitions.duration.short
}),
color: (theme.vars || theme).palette.text.primary,
'@media (pointer: fine)': {
'&:hover': {
backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / ${theme.vars.palette.action.hoverOpacity})` : alpha(theme.palette.primary.main, theme.palette.action.hoverOpacity)
}
},
'&:focus': {
backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / ${theme.vars.palette.action.focusOpacity})` : alpha(theme.palette.primary.main, theme.palette.action.focusOpacity),
[`&.${pickersDayClasses.selected}`]: {
willChange: 'background-color',
backgroundColor: (theme.vars || theme).palette.primary.dark
}
},
[`&.${pickersDayClasses.selected}`]: {
color: (theme.vars || theme).palette.primary.contrastText,
backgroundColor: (theme.vars || theme).palette.primary.main,
fontWeight: theme.typography.fontWeightMedium,
'&:hover': {
willChange: 'background-color',
backgroundColor: (theme.vars || theme).palette.primary.dark
}
},
[`&.${pickersDayClasses.disabled}:not(.${pickersDayClasses.selected})`]: {
color: (theme.vars || theme).palette.text.disabled
},
[`&.${pickersDayClasses.disabled}&.${pickersDayClasses.selected}`]: {
opacity: 0.6
},
variants: [{
props: {
disableMargin: false
},
style: {
margin: `0 ${DAY_MARGIN}px`
}
}, {
props: {
outsideCurrentMonth: true,
showDaysOutsideCurrentMonth: true
},
style: {
color: (theme.vars || theme).palette.text.secondary
}
}, {
props: {
disableHighlightToday: false,
today: true
},
style: {
[`&:not(.${pickersDayClasses.selected})`]: {
border: `1px solid ${(theme.vars || theme).palette.text.secondary}`
}
}
}]
});
const overridesResolver = (props, styles) => {
const {
ownerState
} = props;
return [styles.root, !ownerState.disableMargin && styles.dayWithMargin, !ownerState.disableHighlightToday && ownerState.today && styles.today, !ownerState.outsideCurrentMonth && ownerState.showDaysOutsideCurrentMonth && styles.dayOutsideMonth, ownerState.outsideCurrentMonth && !ownerState.showDaysOutsideCurrentMonth && styles.hiddenDaySpacingFiller];
};
const PickersDayRoot = styled(ButtonBase, {
name: 'MuiPickersDay',
slot: 'Root',
overridesResolver
})(styleArg);
const PickersDayFiller = styled('div', {
name: 'MuiPickersDay',
slot: 'Root',
overridesResolver
})(({
theme
}) => _extends({}, styleArg({
theme
}), {
// visibility: 'hidden' does not work here as it hides the element from screen readers as well
opacity: 0,
pointerEvents: 'none'
}));
const noop = () => {};
const PickersDayRaw = /*#__PURE__*/React.forwardRef(function PickersDay(inProps, forwardedRef) {
const props = useThemeProps({
props: inProps,
name: 'MuiPickersDay'
});
const {
autoFocus = false,
className,
day,
disabled = false,
disableHighlightToday = false,
disableMargin = false,
isAnimating,
onClick,
onDaySelect,
onFocus = noop,
onBlur = noop,
onKeyDown = noop,
onMouseDown = noop,
onMouseEnter = noop,
outsideCurrentMonth,
selected = false,
showDaysOutsideCurrentMonth = false,
children,
today: isToday = false
} = props,
other = _objectWithoutPropertiesLoose(props, _excluded);
const ownerState = _extends({}, props, {
autoFocus,
disabled,
disableHighlightToday,
disableMargin,
selected,
showDaysOutsideCurrentMonth,
today: isToday
});
const classes = useUtilityClasses(ownerState);
const utils = useUtils();
const ref = React.useRef(null);
const handleRef = useForkRef(ref, forwardedRef);
// Since this is rendered when a Popper is opened we can't use passive effects.
// Focusing in passive effects in Popper causes scroll jump.
useEnhancedEffect(() => {
if (autoFocus && !disabled && !isAnimating && !outsideCurrentMonth) {
// ref.current being null would be a bug in MUI
ref.current.focus();
}
}, [autoFocus, disabled, isAnimating, outsideCurrentMonth]);
// For a day outside the current month, move the focus from mouseDown to mouseUp
// Goal: have the onClick ends before sliding to the new month
const handleMouseDown = event => {
onMouseDown(event);
if (outsideCurrentMonth) {
event.preventDefault();
}
};
const handleClick = event => {
if (!disabled) {
onDaySelect(day);
}
if (outsideCurrentMonth) {
event.currentTarget.focus();
}
if (onClick) {
onClick(event);
}
};
if (outsideCurrentMonth && !showDaysOutsideCurrentMonth) {
return /*#__PURE__*/_jsx(PickersDayFiller, {
className: clsx(classes.root, classes.hiddenDaySpacingFiller, className),
ownerState: ownerState,
role: other.role
});
}
return /*#__PURE__*/_jsx(PickersDayRoot, _extends({
className: clsx(classes.root, className),
ref: handleRef,
centerRipple: true,
disabled: disabled,
tabIndex: selected ? 0 : -1,
onKeyDown: event => onKeyDown(event, day),
onFocus: event => onFocus(event, day),
onBlur: event => onBlur(event, day),
onMouseEnter: event => onMouseEnter(event, day),
onClick: handleClick,
onMouseDown: handleMouseDown
}, other, {
ownerState: ownerState,
children: !children ? utils.format(day, 'dayOfMonth') : children
}));
});
process.env.NODE_ENV !== "production" ? PickersDayRaw.propTypes = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the TypeScript types and run "pnpm proptypes" |
// ----------------------------------------------------------------------
/**
* A ref for imperative actions.
* It currently only supports `focusVisible()` action.
*/
action: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({
current: PropTypes.shape({
focusVisible: PropTypes.func.isRequired
})
})]),
/**
* If `true`, the ripples are centered.
* They won't start at the cursor interaction position.
* @default false
*/
centerRipple: PropTypes.bool,
/**
* Override or extend the styles applied to the component.
*/
classes: PropTypes.object,
className: PropTypes.string,
component: PropTypes.elementType,
/**
* The date to show.
*/
day: PropTypes.object.isRequired,
/**
* If `true`, renders as disabled.
* @default false
*/
disabled: PropTypes.bool,
/**
* If `true`, today's date is rendering without highlighting with circle.
* @default false
*/
disableHighlightToday: PropTypes.bool,
/**
* If `true`, days are rendering without margin. Useful for displaying linked range of days.
* @default false
*/
disableMargin: PropTypes.bool,
/**
* If `true`, the ripple effect is disabled.
*
* ⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure
* to highlight the element by applying separate styles with the `.Mui-focusVisible` class.
* @default false
*/
disableRipple: PropTypes.bool,
/**
* If `true`, the touch ripple effect is disabled.
* @default false
*/
disableTouchRipple: PropTypes.bool,
/**
* If `true`, the base button will have a keyboard focus ripple.
* @default false
*/
focusRipple: PropTypes.bool,
/**
* This prop can help identify which element has keyboard focus.
* The class name will be applied when the element gains the focus through keyboard interaction.
* It's a polyfill for the [CSS :focus-visible selector](https://drafts.csswg.org/selectors-4/#the-focus-visible-pseudo).
* The rationale for using this feature [is explained here](https://github.com/WICG/focus-visible/blob/HEAD/explainer.md).
* A [polyfill can be used](https://github.com/WICG/focus-visible) to apply a `focus-visible` class to other components
* if needed.
*/
focusVisibleClassName: PropTypes.string,
isAnimating: PropTypes.bool,
/**
* If `true`, day is the first visible cell of the month.
* Either the first day of the month or the first day of the week depending on `showDaysOutsideCurrentMonth`.
*/
isFirstVisibleCell: PropTypes.bool.isRequired,
/**
* If `true`, day is the last visible cell of the month.
* Either the last day of the month or the last day of the week depending on `showDaysOutsideCurrentMonth`.
*/
isLastVisibleCell: PropTypes.bool.isRequired,
onBlur: PropTypes.func,
onDaySelect: PropTypes.func.isRequired,
onFocus: PropTypes.func,
/**
* Callback fired when the component is focused with a keyboard.
* We trigger a `onFocus` callback too.
*/
onFocusVisible: PropTypes.func,
onKeyDown: PropTypes.func,
onMouseEnter: PropTypes.func,
/**
* If `true`, day is outside of month and will be hidden.
*/
outsideCurrentMonth: PropTypes.bool.isRequired,
/**
* If `true`, renders as selected.
* @default false
*/
selected: PropTypes.bool,
/**
* 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,
style: 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]),
/**
* @default 0
*/
tabIndex: PropTypes.number,
/**
* If `true`, renders as today date.
* @default false
*/
today: PropTypes.bool,
/**
* Props applied to the `TouchRipple` element.
*/
TouchRippleProps: PropTypes.object,
/**
* A ref that points to the `TouchRipple` element.
*/
touchRippleRef: PropTypes.oneOfType([PropTypes.func, PropTypes.shape({
current: PropTypes.shape({
pulsate: PropTypes.func.isRequired,
start: PropTypes.func.isRequired,
stop: PropTypes.func.isRequired
})
})])
} : void 0;
/**
* Demos:
*
* - [DateCalendar](https://mui.com/x/react-date-pickers/date-calendar/)
* API:
*
* - [PickersDay API](https://mui.com/x/api/date-pickers/pickers-day/)
*/
export const PickersDay = /*#__PURE__*/React.memo(PickersDayRaw);