跳转到内容

CalendarPicker API

API documentation for the React CalendarPicker component. Learn about the available props, and the CSS API.

Import

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

Component name

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

属性

名称类型默认值描述
onChange*func
Callback fired on date change
defaultCalendarMonthany
Default calendar month displayed when value={null}.
disabledboolfalse
loadingboolfalse
If true renders LoadingComponent in calendar instead of calendar view. Can be used to preload information and show it in calendar.
maxDateany
Max selectable date. @DateIOType
minDateany
Min selectable date. @DateIOType
onMonthChangefunc
Callback firing on month change. @DateIOType
onViewChangefunc
Callback fired on view change.
openTo'day'
| 'month'
| 'year'
'day'
Initially open view.
readOnlyboolfalse
reduceAnimationsbooltypeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)
Disable heavy animations.
renderLoadingfunc() => <span data-mui-test="loading-progress">...</span>
Component displaying when passed loading true.
shouldDisableDatefunc
Disable specific date. @DateIOType
shouldDisableYearfunc
Disable specific years dynamically. Works like shouldDisableDate but for year selection view @DateIOType.
view'day'
| 'month'
| 'year'
Controlled open view.
viewsArray<'day'
| 'month'
| 'year'>
['year', 'day']
Views for calendar picker.

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

CSS

Rule nameGlobal class描述
root.MuiCalendarPicker-rootStyles applied to the root element.
viewTransitionContainer.MuiCalendarPicker-viewTransitionContainerStyles applied to the transition group element.

You can override the style of the component using one of these customization options:

Demos