Pular para o conteúdo

CalendarPicker API

Documentação da API para o componente React CalendarPicker . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import CalendarPicker from '@mui/lab/CalendarPicker';
// ou
import { CalendarPicker } from '@mui/lab';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Nome do componente

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

Propriedades

NomeTipoPadrãoDescrição
onChange*func
Callback fired on date change
defaultCalendarMonthany
Default calendar month displayed when value={null}.
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.
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.

O ref é encaminhado para o elemento raiz.

CSS

Nome da regraClasse globalDescrição
root.MuiCalendarPicker-rootEstilos aplicados ao elemento raiz.
viewTransitionContainer.MuiCalendarPicker-viewTransitionContainerEstilos aplicados a the transition group element.

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Demonstrações