WeekPickerInput
Week, multiple weeks and weeks range picker input
Source
Package
WeekPicker props
WeekPickerInput supports most of the WeekPicker props.
Features that are not listed on this page are documented there.
WeekPickerInput with uncontrolled forms
Set name to submit the first day of the selected week as YYYY-MM-DD:
Usage
The value is a date string in YYYY-MM-DD format pointing to the first day of the selected week.
The input label displays the week as a range of its first and last day:
Multiple weeks
Set type="multiple" to allow users to pick multiple weeks:
Set valueDisplay="pills" to show every selected week as a pill with a remove button,
the same way MultiSelect shows its values. Backspace in the input removes the last week:
Weeks range
Set type="range" to allow users to pick a weeks range. The label displays the range from the first day of the
first week to the last day of the last week:
First day of week
firstDayOfWeek changes the calendar layout, the emitted value and the label:
Presets
Use the presets prop to add custom week presets. Presets are displayed next to the calendar.
Any date inside the week can be used as a preset value:
To use presets with type="range", define the value as a tuple of two dates:
Controlling with useWeekPickerInput
WeekPickerInput component supports the controller pattern. Use the useWeekPickerInput hook to manage WeekPickerInput state.
The controller does not own the selected value, keep using value and onChange for it.
When the controller prop is set, the date, level and dropdown state props of the component are ignored, pass them to useWeekPickerInput instead.
The dropdown resets the displayed date and level every time it opens.
To open it on another level or date, call setLevel or setDate after openDropdown:
Dropdown closed, displayed month: none
Dropdown type
By default, the dropdown is a bottom Drawer below theme.breakpoints.sm and a popover above.
Set dropdownType to popover, modal, drawer or an object with breakpoints.
Use popoverProps, modalProps and drawerProps to pass props down to the underlying component:
Submit button
In drawer and modal dropdowns, the value is applied when the submit button is pressed.
Set applyOnSubmit={false} to apply the value on selection.
Change the button label with the submitButtonLabel prop or the same DatesProvider setting, and pass other props with submitButtonProps:
Value format
valueFormat is a dayjs format applied to the first and the last day of the week:
Value formatter
valueFormatter formats the value label with a custom function.
The same function is called for all type values, so check the value type inside it.
Example with type="multiple":
getWeekFormatter exported from @mantine/dates returns the default formatter.
Use it in your own formatter, for example to add the ISO week number:
Clearable
Set the clearable prop to display a clear button in the right section.
The clear button is not displayed when the rightSection prop is set:
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:
Week controls
Week numbers are the only focusable elements of the calendar, days can be clicked with the mouse only.
Use getWeekControlProps to change aria-label or disable specific weeks, see WeekPicker for details.
Max level
Set maxLevel to limit the level that can be reached by clicking on the header label:
Input props
WeekPickerInput component supports Input and Input.Wrapper component features and all button element props. The WeekPickerInput documentation does not include all features supported by the component – see the Input documentation to learn about all available features.
With icon
Native level select
Get element ref
Accessibility
If WeekPickerInput 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: