Skip to main content

betaThis is a new capability. Help us improve it and give your feedback on Slack.

Month Year Field

Two inputs (month, year) for collecting partial dates.

Preview

When did this start?
For example, 3 2025

JSON definition

{
"type": "MonthYearField",
"name": "fieldName",
"title": "Question title",
"hint": "",
"shortDescription": "",
"options": {}
}

Properties

PropertyTypeRequiredDescription
hintstringNoHint text displayed below the field label to help the user answer the question.
shortDescriptionstringNoA short description of the field used in the check-your-answers summary.

Options

PropertyTypeRequiredDescription
classesstringNoAdditional CSS classes applied to the component.
customValidationMessagestringNoA single custom message shown for any validation error on this field.
customValidationMessagesobjectNoA map of Joi error codes to custom error messages.
instructionTextstringNoAlternative text read by screen readers in place of the field title.
maxDaysInFuturenumberNoMaximum number of days in the future the entered date can be.
maxDaysInPastnumberNoMaximum number of days in the past the entered date can be.
optionalTextbooleanNoWhen true, appends '(optional)' to the field label.
requiredbooleanNoWhether the field must be filled in. Defaults to true.