MonthPickerInput

Source@react-form-builder/components-mantine

Introduction

The MonthPickerInput component combines an input with a month picker popover. Variants include single month, month range, and multiple months. The component requires @mantine/dates and is based on Mantine MonthPicker.

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

Components covered

• MtMonthPickerInput: Single month selection with input.
• MtMonthRangePickerInput: Month range selection with input.
• MtMonthMultiplePickerInput: Multiple months selection with input.

Differences between components

Component	Selection type	Value shape	Typical use case
MtMonthPickerInput	Single month	Date | null	Single month field with text input
MtMonthRangePickerInput	Month range	[Date, Date] | null	Start/end month range with text input
MtMonthMultiplePickerInput	Multiple months	Date[]	Choosing several months via input + popover

MtMonthPickerInput

Input-based single-month picker for cases where a textual representation is required (for example, month input with format and validation).

MtMonthRangePickerInput

Range version that uses an input field to represent the span of months. Ideal for defining report or subscription periods.

MtMonthMultiplePickerInput

Multiple-month input variant to select and display several months in a single control, using both text and popover.

Detailed component pages

• MtMonthPickerInput (single)
• MtMonthRangePickerInput
• MtMonthMultiplePickerInput

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Label	string	Label for the input
Value	Date | null (or range/multiple)	Selected month(s) (uncontrolled value)
Placeholder	string	Placeholder when no selection
Description	string	Helper text below the field
Error	string	Error message; when set, applies error styling
Size	'xs' | 'sm' | 'md' | 'lg' | 'xl'	Size of the input
Variant	'filled' | 'default' | 'unstyled'	Visual variant
Disabled	boolean	Disables the input
Clearable	boolean	If true, allows clearing the selection
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