YearPickerInput
Inline year, multiple years and years range picker
Source
Package
YearPicker props
YearPickerInput supports most of the YearPicker props.
Read through the YearPicker documentation to learn about all component features that are not listed on this page.
YearPickerInput with uncontrolled forms
Set name to submit the first day of the selected year as YYYY-MM-DD:
Usage
Multiple dates
Set type="multiple" to allow users to pick multiple dates:
Set valueDisplay="pills" to show every selected year as a pill with a remove button,
the same way MultiSelect shows its values. Backspace in the input removes the last year:
Dates range
Set type="range" to allow users to pick a date range:
Presets
Use the presets prop to add custom year presets. Presets are displayed next to the calendar:
To use presets with type="range", define the value as a tuple of two dates:
Controlling with useYearPickerInput
YearPickerInput component supports the controller pattern. Use the useYearPickerInput hook to manage YearPickerInput state:
Dropdown closed, displayed decade: none
Every time the dropdown opens, the displayed decade is reset to the selected value (or to defaultDate
when there is no value). To open on a different decade, call next, previous or setDate right
after openDropdown, as the demo above does. YearPickerInput only displays the decade level, so
setLevel has no effect.
The controller does not own the selected value – keep using value/onChange (or your form
library) for it. When the controller prop is set, the date, defaultDate, onDateChange, popoverProps.opened and
popoverProps.onChange props are ignored – pass them to useYearPickerInput instead (dropdownOpened and
onDropdownOpenedChange replace popoverProps.opened and popoverProps.onChange).
openDropdown does nothing while the input is disabled or readOnly. With type="range", closing
the dropdown when only the first year of the range is picked clears the value, whether the dropdown is
closed by the user or with closeDropdown.
If you only need the dropdown state, popoverProps={{ opened, onChange }} controls it without a
controller in every dropdown type (popover, modal and drawer): onChange is called on every open and close, including the input click and the close
after a pick, and the input keeps opening and closing the dropdown through it.
The controller is typed as PickerInputController and its options as PickerInputControllerOptions,
both exported from @mantine/dates. The same types are used by DatePickerInput, MonthPickerInput,
YearPickerInput, WeekPickerInput and QuarterPickerInput.
Dropdown type
The dropdown opens in a bottom Drawer below theme.breakpoints.sm and in a
Popover above. Set dropdownType to 'popover', 'modal', 'drawer' or an object
with breakpoints:
Object keys can be theme.breakpoints keys or custom values in px, for example,
{ base: 'drawer', 600: 'popover' }. Use popoverProps, modalProps and drawerProps to pass props
down to the underlying component. If the viewport crosses a breakpoint while the dropdown is open,
the dropdown switches to the other type and a selection that was not applied yet is discarded.
Submit button
In drawer and modal dropdowns, the value is applied only when the submit button is pressed, and
closing the dropdown discards the selection. Set applyOnSubmit={false} to apply the value on selection:
- The label is
Saveby default – change it with thesubmitButtonLabelprop or thesubmitButtonLabelsetting of DatesProvider submitButtonPropsare passed down to the Button- With
type="range", the button is disabled until both dates are selected
Value format
Use the valueFormat prop to change the dayjs format of the value label:
Value formatter
valueFormatter is a more powerful alternative to the valueFormat prop.
It allows formatting the value label with a custom function.
The function is the same for all component types (default, multiple and range)
– you need to perform additional checks inside the function to handle different types.
Example of using a custom formatter function with type="multiple":
Clearable
Set the clearable prop to display a clear button in the right section. Note that if you set the rightSection
prop, the clear button will not be displayed.
Clear section mode
The clearSectionMode prop determines how the clear button and rightSection are rendered:
'both'(default) – render both the clear button andrightSection'rightSection'– render only the user-suppliedrightSection, ignore clear button'clear'– render only the clear button, ignorerightSection
Disabled state
Min and max dates
minDate and maxDate props define the minimum and maximum dates that can be picked.
You can specify minDate and maxDate as Date objects:
Control props
getYearControlProps prop allows passing props to the control component based on the date.
It is useful for disabling specific dates or customising styles/className.
Year label format
yearsListFormat props allow changing the format of the year label in the years list.
It accepts a dayjs format string.
Decade label format
decadeLabelFormat prop allows changing the format of the decade label in the header.
It accepts a dayjs format string.
Input props
MonthPickerInput component supports Input and Input.Wrapper component features and all button element props. The MonthPickerInput documentation does not include all features supported by the component – see the Input documentation to learn about all available features.
With icon
Get element ref
Accessibility
If YearPickerInput is used without the label prop, it will not be announced properly by screen readers:
Set aria-label to make the input accessible. In this case the label will not be visible, but screen readers will announce it:
If the label prop is set, the input will be accessible and it is not required to set aria-label: