跳转到内容

CalendarPicker API

想要学习更多组件属性和 CSS API,可以查阅 React CalendarPicker 组件的 API 文档。

导入

import CalendarPicker from '@mui/x-date-pickers-pro/CalendarPicker';
// 或
import CalendarPicker from '@mui/x-date-pickers/CalendarPicker';
// 或
import { CalendarPicker } from '@mui/x-date-pickers-pro';
// 或
import { CalendarPicker } from '@mui/x-date-pickers';
You can learn about the difference by reading this guide on minimizing bundle size.

组件名称

The name MuiCalendarPicker can be used when providing default props or style overrides in the theme.

属性

名称类型默认值描述
onChange*func
Callback fired on date change
componentsobject{}
Overrideable components.
componentsPropsobject{}
The props used for each component slot.
defaultCalendarMonthany
Default calendar month displayed when value={null}.
disabledboolfalse
If true, the picker and text field are disabled.
disableFutureboolfalse
If true future days are disabled.
disableHighlightTodayboolfalse
If true, today's date is rendering without highlighting with circle.
disablePastboolfalse
If true past days are disabled.
getViewSwitchingButtonTextfunc
Get aria-label text for switching between views button.

Signature:
function(currentView: CalendarPickerView) => string
currentView: The view from which we want to get the button text.
returns (string): The label of the view.
leftArrowButtonTextstring
Left arrow icon aria-label text.
loadingboolfalse
If true renders LoadingComponent in calendar instead of calendar view. Can be used to preload information and show it in calendar.
maxDateany
Maximal selectable date. @DateIOType
minDateany
Minimal selectable date. @DateIOType
onMonthChangefunc
Callback firing on month change @DateIOType.

Signature:
function(month: TDate) => void | Promise
month: The new month.
returns (void | Promise): -
onViewChangefunc
Callback fired on view change.

Signature:
function(view: CalendarPickerView) => void
view: The new view.
onYearChangefunc
Callback firing on year change @DateIOType.

Signature:
function(year: TDate) => void
year: The new year.
openTo'day'
| 'month'
| 'year'
'day'
Initially open view.
readOnlyboolfalse
Make picker read only.
reduceAnimationsbooltypeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
Disable heavy animations.
renderDayfunc
Custom renderer for day. Check the PickersDay component.

Signature:
function(day: TDate, selectedDays: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
day: The day to render.
selectedDays: The days currently selected.
pickersDayProps: The props of the day to render.
returns (JSX.Element): The element representing the day.
renderLoadingfunc() => <span data-mui-test="loading-progress">...</span>
Component displaying when passed loading true.

Signature:
function() => React.ReactNode

returns (React.ReactNode): The node to render when loading.
rightArrowButtonTextstring
Right arrow icon aria-label text.
shouldDisableDatefunc
Disable specific date. @DateIOType

Signature:
function(day: TDate) => boolean
day: The date to test.
returns (boolean): Returns true if the date should be disabled.
shouldDisableMonthfunc
Disable specific months dynamically. Works like shouldDisableDate but for month selection view @DateIOType.

Signature:
function(month: TDate) => boolean
month: The month to check.
returns (boolean): If true the month will be disabled.
shouldDisableYearfunc
Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.

Signature:
function(year: TDate) => boolean
year: The year to test.
returns (boolean): Returns true if the year should be disabled.
showDaysOutsideCurrentMonthboolfalse
If true, days that have outsideCurrentMonth={true} are displayed.
view'day'
| 'month'
| 'year'
Controlled open view.
viewsArray<'day'
| 'month'
| 'year'>
['year', 'day']
Views for calendar picker.

ref 则会被传递到根元素中。

CSS

规则名称全局类名描述
root.MuiCalendarPicker-rootStyles applied to the root element.
viewTransitionContainer.MuiCalendarPicker-viewTransitionContainerStyles applied to the transition group element.

您可以使用组件自定义选项对组件进行个性化:

演示项目