YearPicker

Source@react-form-builder/components-mantine

Introduction

The YearPicker component allows users to select a year. Variants include single year, year range, and multiple years. The component requires @mantine/dates and is based on Mantine YearPicker.

It is included within the following NPM package: @react-form-builder/components-mantine.

Components covered

• MtYearPicker: Single year selection.
• MtYearRangePicker: Year range selection.
• MtYearMultiplePicker: Multiple years selection.

Differences between components

Component	Selection type	Value shape	Typical use case
MtYearPicker	Single year	Date | null	Pick one year (e.g. fiscal year)
MtYearRangePicker	Year range	[Date, Date] | null	Define a continuous span of years
MtYearMultiplePicker	Multiple years	Date[]	Choose several specific years

MtYearPicker

Single-year picker for selecting one specific year, most useful in scenarios like choosing a fiscal year or graduation year.

MtYearRangePicker

Range picker that allows selecting a start and end year. Use it when representing multi-year intervals like projects or studies.

MtYearMultiplePicker

Multiple-year picker that supports an arbitrary set of years, useful when you need to mark specific, non-contiguous years.

Detailed component pages

• MtYearPicker (single)
• MtYearRangePicker
• MtYearMultiplePicker

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Value	Date | null (or range/multiple)	Selected year(s) (uncontrolled value)
Min date	Date	Minimum selectable year
Max date	Date	Maximum selectable year
Size	'xs' | 'sm' | 'md' | 'lg' | 'xl'	Size of the picker
Disabled	boolean	Disables the picker
On change	event	Fired when the selection changes

At the bottom of the Main properties menu, you can find additional options:

• Render When: Provides conditional rendering for your component as described in the corresponding chapter.
• HTML attributes: Allows you to provide custom HTML attributes for your form.

Style properties

These are properties that allow to customize the size, color and other style properties of your component:

• For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.

• Component > Class Name: Add a class name for your component for the subsequent styling if necessary.

• Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:

  Name	Type	Description
  Width	number	Specifies the width for your component
  Height	number	Specifies the height for your component
  Margin top/right/bottom/left	number	Margin values for you component
  Color	string	Allows customizing the text color
  Background color	string	Enables customizing the background color