New Major Release
See the v7.x Upgrade Guide for more information.
@rjsf/antd
- BREAKING CHANGE: Remove support for
antd5: the peer dependency range is now^6.7.0, since earlier antd 6 releases crash@rjsf/antdforms on first render or don't understand alabelAlignof'start'or'end', andErrorListandCyclicSchemaExpandTemplatealways passAlertitstitleprop. See the upgrade guide (#5264, #5763) - Change
DateWidget/DateTimeWidgetto show aformat: "iso-date-time"value as a naive local date-time instead of converting it to a UTC ISO string, and a stored value that carries an offset as the wall-clock time it represents (#5270, #3930) - BREAKING CHANGE: Fix
BaseInputTemplatenever callingonChangeOverridefor a numeric field: such a field now renders anInputwithtype="number", so the override receives theChangeEvent, as in every other theme. See the upgrade guide (#5285, #5303) - Add
ui:options.optgroupssupport toSelectWidget, grouping its options through rc-select's nestedoptions(#5301) - Change
WrapIfAdditionalTemplateto render an additional property's key as a select of the namespropertyNames.enumallows instead of a free-text input, and fix adeprecatedadditional property offering its decoration as a key name or renaming itself to it (#5321, #4682) - BREAKING CHANGE: Change the default
Formexport to aThemedFormgeneric over the form data, and keep each component's own generic type in theTheme,TemplatesandWidgetsexports instead ofany;generateForm()returns aThemedForm<T, S, F>and the other generators default tounknown. See the upgrade guide (#5311) - Fix
FieldTemplateshowing a field'sui:helpin place of its validation errors, so a field withui:helpshowed no error message; both now show (#5351, #5326) - Fix
FieldTemplatedropping aui:helpgiven as a React element, along with the field's errors (#5351, #5326) - Add
FieldHelpTemplateto the theme's templates, keeping help text in antd's description color rather than its error tint when the field has errors; restyling.help-block's color for that case needs!important(#5351, #5326) - Fix
RadioWidget's object options andFieldTemplate's object/array selects, and makeSelectWidgetreport its form data value on focus and blur (#5350, #5309, #5317) - Fix
realValueoptions whoseString()matches, such as1and'1', sharing a DOM value (#5400, #5315) - Fix
AltDateWidgetrendering no hour, minute or second selects foralt-datetime, emitting a date-only value, and letting its Now and Clear buttons change areadonlyordisabledfield (#5410) - Fix
TextareaWidgetreplacing aui:options.rowsof0with 4 rows; it now gets the browser's default height, as with@rjsf/core'sTextareaWidget(#5387) - Fix
FieldErrorTemplategiving every React element error the same...-[object Object]key and a repeated string error the same key twice (#5382) - Fix
ObjectFieldTemplategiving a property no column span whenformContext.colSpanhas no valid entry for it, the default span counting hidden properties, and keying a property by another widget or type than it renders with, such as a boolean shown as a select (#5450, #5611, #5791, #5447, #5516) - BREAKING CHANGE: Fix
AltDateWidget's date parts having no accessible name: each select is named by the label, even a hidden one, and its part, such asWhen, year, and described by the field's description, help and errors. See the upgrade guide (#5418, #5355, #5357) - Fix
SelectWidgetnot giving thearia-labelandaria-describedbyit is passed to its control (#5418, #5355, #5357) - Fix
CheckboxesWidget's options staying enabled in adisabledfield, where a click still changed the form data, andCheckboxesWidget's andRadioWidget's in areadonlyfield underreadonlyAsDisabled(#5487) - Change the theme to declare its presentation, so
ui:label: falsenow hides every field's description, a checkbox's included, as in every other theme, andWrapIfAdditionalTemplatelabels the key throughhasAdditionalKeyLabel()(#5531, #5490) - Fix
FieldHelpTemplaterepeating the field's id for ananyOf/oneOfoption's ownui:help;aria-describedbylists an option's own description and help among the field's in the order they are drawn (#5531, #5490, #5794, #5720) - Fix
TitleFieldrendering thetitleId()it is handed as afornaming nothing rather than as an id: it puts it on a<span>around the title's text, inside the<label>, so an object's option selector is named "Pet"; its click handler is gone (#5531, #5544, #5490) - Fix
CheckboxWidgetcarrying the nativerequiredattribute where the schema doesn't demandtrue, so a requiredbooleanleft unchecked now submits asfalse(#5531, #5388, #5490) - Fix
SelectWidget's selected option description rendering under an id other than the one the select is described by;aria-describedbylists it before the field's description and help, the order they are drawn in (#5531, #5718, #5490, #5367) - Change
BaseInputTemplate,PasswordWidget,TextareaWidget,DateWidgetandCheckboxWidgetto bearia-invalidwhile errors show and described only by what renders;RadioWidgetandCheckboxesWidgetname their group by the label, andRangeWidget's handle is named by it (#5544, #5490) - Fix
FieldTemplatemarking a label required for a widget declareduncheckedIsFalsewhere the schema doesn't demandtrue; it now reads the plan'slabel.requiredMarker(#5543, #5388, #5490) - Fix
FieldTemplate'sdescriptionLocation: 'tooltip'pointingaria-describedbyat a description that doesn't exist, losing a checkbox's description, and adding the icon to the control's name (#5544, #5490) - Fix
ArrayFieldTemplatedrawing theui:titleananyOf/oneOfoption repeats a second time, and dropping an optional array's data control where it draws no heading, as underui:label: false(#5544, #5490) - Fix
MultiSchemaFieldTemplaterendering an empty<div>for a selector it isn't given, as while an optionalanyOf/oneOffield has no data (#5543, #5401, #5490) - Fix
ObjectFieldTemplatedropping the optional data control where it draws no heading, as underui:label: false, and rendering an empty column where there is no control (#5531, #5490) - BREAKING CHANGE: Change
FieldTemplateto draw a radio, checkboxes or range field's label with nofor, as core's does, so a selector aimed atlabel[for=…]for such a field should aim atlabel:has(#root_color__label). See the upgrade guide (#5544, #5490) - Change
RadioWidgetunderui:autofocusto focus its checked radio, or the first a user can choose, andCheckboxesWidgetthe first checkbox a user can choose (#5544, #5490) - BREAKING CHANGE: Change
AltDateWidget's date parts to sit in agroupwith the field's id, named by the label, which has nofor, each partaria-invalidwhile errors show, solabel[for="root_when"]should belabel:has(#root_when__label). See the upgrade guide (#5544, #5490, #5542) - Fix
AltDateWidget's Now and Clear buttons staying enabled when the field is disabled (#5544, #5490) - Fix
DateWidgetandPasswordWidgetignoring anameGenerator: their input'snameis nowhtmlName, as in the other widgets (#5544, #5490) - Fix
WrapIfAdditionalTemplate's key input having no name underui:label: false,SelectWidgetnot beingaria-requiredfor a required field, andPasswordWidget,TextareaWidget,DateWidgetandRadioWidget's radios (a read-only field's excepted) not beingrequiredfor one (#5544, #5490) - BREAKING CHANGE: Change
FieldTemplateto put the label id on a<span>around the label's text, apart from antd's*and:, so a group or slider handle named by it is namedColorrather than* Color:. See the upgrade guide (#5544, #5490) - Fix
BaseInputTemplate,PasswordWidget,TextareaWidget,DateWidgetandWrapIfAdditionalTemplate's key input staying editable for aui:readonlyfield underreadonlyAsDisabled: false,DateWidgetopening its popup or drawing its clear icon there (#5544, #5882, #5490, #5603) - Fix a read-only
RadioWidgetbeingrequiredand changing on click (#5544, #5490) - Add
blockas the theme'sglobalUiOptionsKeys, typed by the newAntdGlobalUISchemaOptionsandUiSchematypes, so a globalblockreachesRemoveButtonoutside aLayoutGridFieldtoo (#5611, #5607) - Fix
ObjectFieldTemplateshowing no add button for an object naming noadditionalPropertiesin a form whoseadditionalPropertiesWhenAbsentis'allow'(#5620, #2137) - Change
FieldTemplateto set its form item's error status from the field's own errors, thehasErrorsprop, so ananyOf/oneOfoption follows its ownui:hideError; a custom field rendering it by hand passeshasErrorswith itserrors(#5646) - Add
aria-invalidand a description by its row's errors toWrapIfAdditionalTemplate's key input, the free-text one and thepropertyNamesselect alike, while the object forbids that key, and give itsForm.Itemantd'serrorstatus (#5640, #4630) - Fix the widgets ignoring a
<ConfigProvider componentDisabled>: every widget,IconButton's buttons andAltDateWidget's Now and Clear are disabled under it, andSelectWidget's andRangeWidget's hidden inputs post nothing (#5487, #5625, #5506, #5593, #5597) - Add antd
HiddenWidgetandRatingWidgets that honor<ConfigProvider componentDisabled>(#5625, #5506, #5593, #5597) - Fix a read-only
CheckboxWidgetbeingrequired, and a read-onlyRadioWidget,CheckboxWidget,CheckboxesWidgetorSelectWidgetleft enabled not beingaria-readonly(#5625, #5506, #5593, #5597) - Fix
BaseInputTemplate,TextareaWidget,PasswordWidgetandDateWidgetignoringui:autofocus(#5625, #5597) - Fix
SelectWidgetandRangeWidgetposting nothing in a native submit ornew FormData(form): they render hidden inputs underhtmlName, andSelectWidgetno longer putsnameon its root<div>(#5625, #5597) - BREAKING CHANGE: Change an additional property's key input id to
root_foo__keyfromroot_foo-key, built by the newadditionalKeyId(). See the upgrade guide (#5626) - BREAKING CHANGE: Fix
ObjectFieldTemplategiving a column to a property hidden bydeprecatedHandling: 'hide'or aui:definitionshidden widget: it now leaves the property out, as it does one with its ownui:widget: 'hidden'. See@rjsf/antdand@rjsf/mantineleave out a property hidden bydeprecatedHandlingorui:definitions(#5617, fixes #5507) - Fix
RangeWidget's slider handle not being described by its field's errors, description and help, or markedaria-invalidwhile errors show (#5715, fixes #5560) - BREAKING CHANGE: Change
GridTemplateto read a column'sspanas twelfths of a row, doubled into antd's 24 columns, sospan: 12is now a whole row rather than half; a half step such as4.5spans an odd 24th, one finer than a half step is rounded to the nearest one with a warning, and aspanover 12 logs a warning to halve it; a column with aflexprop or aflex,flexBasisorwidthstyle of its own keeps it in place of itsspan, logging a warning that itsspanis ignored. See the upgrade guide (#5707, #5651) - Fix a layout grid
ui:rownested in anotherui:rowshrinking to its content rather than taking a line of its own:GridTemplategives a row without aflex,flexBasis,flexGroworwidthstyle of its own aflexof1 1 100%, ahead of the rest of itsstyle(#5707, #5651) - Fix
SelectWidgetleaving a select no label names, such as an untitled root or array item select, without an accessible name; it is named by itsui:placeholder, elseTranslatableString.SelectPlaceholder("Select ...") (#5713, #5711) - Fix
RadioWidgetleaving aradiogroupno label names, such as an untitled field's, without an accessible name; it is named by itsui:placeholder, elseTranslatableString.RadioGroupName("Choose an option") (#5713, #5586) - Fix renaming an
additionalPropertieskey remounting its field, which lost what its widget held, such as analt-date's partly picked date (#5733, #5595) - Fix the text input rendering a stray
0beside it when its value is0andallowClearTextInputsis set (#5682) - Change a text input holding
false, which it shows, to offer the clear button for it (#5682) - Fix
RangeWidgetdrawing a numeric string, and posting it, at its minimum (#5682) - Fix
RangeWidgetandInputNumberwriting a number into a string field, which then failed validation and, forInputNumber, lost the digits past a number's precision: they now write a numeric string, as core's range input does (#5682) - Change the number input to show nothing, and offer no clear button, for a boolean or object value (#5682)
- Change
PasswordWidgetto show a value of0orfalse, where it was empty (#5682) - BREAKING CHANGE: Change the alt-date and alt-datetime widgets to show a number or
Datevalue as empty, where they showed that date, since they can only write a string back. See the upgrade guide (#5682) - Fix
BaseInputTemplatedropping apattern,inputMode,acceptormultiplea widget passes it as a prop, so the file input of an array took one file at a time, and anumberfield a widget passes anonChangeOverridegetting a native number input that blocked a decimal rather than the text input the other themes render (#5684) - Fix
WrapIfAdditionalTemplateleaving the key input and the remove button enabled for a property it is handed no rename or remove callback for, such as the root (#5684) - BREAKING CHANGE: Change
AltDateWidgetto show the default years for ayearsRangereaching before 100, such as[50, 2030], where it offered that range and wrote a year before 100 as 19xx. See the upgrade guide (#5685) - Fix
AltDateWidgetspacing its date parts by aNaNgutter whenformContext.rowGutteris a pair, a responsive object or a CSS length: they now take half of each side of a pair, and half of a single gutter both ways, as they did of a number, thoughRowapplies a single gutter horizontally only. A numeric string such as'16', whichRowturns into invalid CSS, now gives no spacing, asRowdraws none for it, where it gave half its number (#5686) - Add the
AntdFormContexttype, theformContextoptions the antd theme reads (#5686) - Fix
RangeWidgetfor an Ajv$datareference inminimum,maximumormultipleOf, which set the range's bound or step to the object and now leaves it at its default, and read a numeric-string bound such asminimum: '5'as its number (#5688) - BREAKING CHANGE: Change
WrapIfAdditionalTemplateto readADDITIONAL_PROPERTY_FLAGby its truth rather than its presence, so a schema with it set toundefinedorfalserenders as a plain field, with no key input or remove button. See the upgrade guide (#5689) - Fix a required
anyOf/oneOffield showing two*s with a titled object or array option selected: only the field's label is marked now (#5743, #5573) - BREAKING CHANGE: Fix
CheckboxesWidgetgiving a screen reader no cue that a checked box is required: a required group whoseminItemsis at least 1, or withui:required: true, is now named with "required", and a required group with neither, which submits[], no longer shows a*. See the upgrade guide (#5743, #5573) - BREAKING CHANGE: Change
ObjectFieldTemplateandArrayFieldTemplateto start an object and an array heading, like a field label above its control, andformContext.labelAlignto align field labels too. See the upgrade guide (#5763, #5745) - BREAKING CHANGE: Change
ObjectFieldTemplateto key a property informContext.colSpanby whatSchemaFieldrenders it as: its widget, the field its$idnames, or an untypedanyOfoption's type. See the upgrade guide (#5791, #5516) - Fix a field's
aria-describedbylisting its description before its help, whileFieldTemplatedraws the help first, below the control (#5794, #5720) - Fix
ArrayFieldTemplateandObjectFieldTemplateleaving an object's or an array's group unnamed and undescribed by the field's errors, description and help (#5795, #5723) - BREAKING CHANGE: Fix a required multiple
SelectWidgetblocking a submit of the[]its schema accepts: an array rendered as one widget holding[]is now required, and shows a*, only where itsminItemsis at least 1 orui:required: trueasks for it. See the upgrade guide (#5822, #5744) - Add support for importing and rendering
Formfrom a React Server Component, such as a Next.js App Router page, without wrapping it in a'use client'module of your own (#5863, #5761) - Add the IDs
antd-span-twelfthsandantd-span-own-widthto the warnings for a layout grid columnspanover 12 and for one ignored beside the column's ownflexor width, ending their messages, sosetWarningOptions()can make them throw (#5868, #5775) - Fix
TitleFieldkeeping a title's trailing colon whenformContext.colonisnull,0or'', where the field's label drops it (#5882, #5603) - Fix
BaseInputTemplate,CheckboxWidget,CheckboxesWidget,DateWidget,PasswordWidget,RadioWidget,RangeWidget,SelectWidgetandTextareaWidgetnot callingonFocusandonBlurfor a read-only field, as@rjsf/coredoes (#5882, #5603) - Fix
FieldErrorTemplatedrawing an empty item for an empty error message (#5882, #5603) - BREAKING CHANGE: Change
ObjectFieldTemplateto title an expandable object's Add button after the object's title or name, such asAdd Address. See the upgrade guide (#5899, #3596)
@rjsf/bootstrap3
- Add
@rjsf/bootstrap3, a theme that keeps the Bootstrap 3 markup@rjsf/corerendered through v6, with a layout grid column'sspanas itscol-xs-*class unless it has one of its own, which it warns about, as it does about aspanthat isn't a whole number, deprecated from the start and removed in v8 (#5635, #5707, #5616, #5651) - Fix a required
anyOf/oneOffield showing two*s with a titled object or array option selected: only the field's label is marked now (#5743, #5573) - BREAKING CHANGE: Fix
CheckboxesWidgetgiving a screen reader no cue that a checked box is required: a required group whoseminItemsis at least 1, or withui:required: true, is now named with "required", and a required group with neither, which submits[], no longer shows a*. See the upgrade guide (#5743, #5573) - Fix
ArrayFieldTemplateandObjectFieldTemplateleaving an object's or an array's group undescribed by the field's errors, description and help (#5795, #5723) - BREAKING CHANGE: Fix a required multiple
SelectWidgetblocking a submit of the[]its schema accepts: an array rendered as one widget holding[]is now required, and shows a*, only where itsminItemsis at least 1 orui:required: trueasks for it. See the upgrade guide (#5822, #5744) - Add support for importing and rendering
Formfrom a React Server Component, such as a Next.js App Router page, without wrapping it in a'use client'module of your own (#5863, #5761) - BREAKING CHANGE: Change
AddButtonto take thetitleit is passed, which titles an expandable object's Add button after the object, such asAdd Address, and to fall back toAdd Iteminstead ofAdd. See the upgrade guide (#5899, #3596)
@rjsf/chakra-ui
- Fix the widgets deleting non-style keys from the uiSchema's
ui:options.chakra:getChakra()returns a filtered copy rather than changing the caller's object (#5285) - Fix
ChakraUiSchemaaccepting anything, since itsOmit<UiSchema, 'ui:options'>erased every named member (#5285) - Change
BaseInputTemplateto render anumber/integerfield as<input type="text">with a numericinputMode, apatternand atitle, withoutstep,minormax; setui:options.inputType: 'number'or use theupdownwidget for a native number input (#5303, #4038) - Add
ui:options.optgroupssupport toSelectWidget, grouping its options withSelect.ItemGroup/Select.ItemGroupLabel(#5301) - BREAKING CHANGE: Remove
chakra-react-selectfrompeerDependencies; it no longer needs to be installed alongside@rjsf/chakra-ui. See the upgrade guide (#5301) - Fix
NativeSelectWidgetignoringui:enumDisabled, leaving every option selectable (#5301) - Change
WrapIfAdditionalTemplateto render an additional property's key as a select of the namespropertyNames.enumallows instead of a free-text input, and fix adeprecatedadditional property offering its decoration as a key name or renaming itself to it (#5321, #4682) - BREAKING CHANGE: Fix
BaseInputTemplate,CheckboxesWidget,NativeSelectWidget,SelectWidget,TextareaWidgetandUpDownWidgetstaying flaggedinvalidunderui:hideError. See the upgrade guide (#5324, #3684) - BREAKING CHANGE: Fix
CheckboxesWidgetflagging itsCheckboxGroupinvalidwhenever a required field was empty, before validation and despiteui:hideError; it now follows the field's visible errors, which mark every checkboxaria-invalid. See the upgrade guide (#5324, #3684) - BREAKING CHANGE: Change the default
Formexport to aThemedFormgeneric over the form data, and keep each component's own generic type in theTheme,TemplatesandWidgetsexports instead ofany;generateForm()returns aThemedForm<T, S, F>and the other generators default tounknown. See the upgrade guide (#5311) - Fix
RadioWidget's andCheckboxesWidget's object options, and makeSelectWidgetreport its form data value on focus and blur and offer an empty string option in therealValueformat (#5350, #5317) - Fix
realValueoptions whoseString()matches, such as1and'1', sharing a DOM value (#5400, #5315) - Fix
AltDateWidgetrendering no hour, minute or second selects foralt-datetime, emitting a date-only value, and letting its Now and Clear buttons change areadonlyfield, or adisabledone rendered by a customFieldTemplate(#5410) - Fix
UpDownWidgetreporting''rather thanundefinedtoonFocus/onBlurwhen an increment or decrement trigger is focused (#5379) - BREAKING CHANGE: Fix
AltDateWidget's date parts having no accessible name: each select is named by the label, even a hidden one, and its part, such asWhen, year, and described by the field's description, help and errors. See the upgrade guide (#5418, #5355, #5357) - Change
SelectWidgetto put itsaria-labelandaria-describedbyon its trigger rather than its root (#5418, #5355, #5357) - Change
getChakra()to returnJsxStylePropsinstead ofField.RootProps, soFieldset.RootandField.Rootboth accept it; reading a non-style member off the result, which was alwaysundefined, no longer compiles (#5488) - BREAKING CHANGE: Fix the
chakraoption never reaching a widget: widgets now apply it, including achakraset throughui:globalOptionsorui:chakra. See the upgrade guide (#5488) - BREAKING CHANGE: Change
getChakra()to take the widget's mergedoptionsinstead of a uiSchema. See the upgrade guide (#5488) - BREAKING CHANGE: Change the
chakraoption of the theme'sUiSchematype toJsxStyleProps, so a non-style prop such asinvalidoronClickin the root'sui:optionsno longer compiles. See the upgrade guide (#5488) - Fix
getChakra()dropping Chakra style props that share a name with an HTML attribute, such ascolor,width,heightanddisplay, and remove the@emotion/is-prop-validdependency (#5488) - Change the widgets to draw their own label,
CheckboxWidgetits description too, and name ananyOf/oneOffield by its option selector;WrapIfAdditionalTemplatelabels the key throughhasAdditionalKeyLabel()(#5531, #5545, #5490) - Fix
FieldHelpTemplaterepeating the field's id for ananyOf/oneOfoption's ownui:help(#5531, #5490) - Fix the fallback UI's value having no label: the theme declares
FallbackFieldas drawing its own label (#5531, #5490) - Fix
CheckboxWidgetcarrying the nativerequiredattribute where the schema doesn't demandtrue, so a requiredbooleanleft unchecked now submits asfalse(#5531, #5388, #5490) - Fix
SelectWidget's trigger missing the plan'saria-labelledby, so an object's option selector is now named by the object's heading (#5531, #5490) - Fix an
anyOf/oneOfoption's control not being styled invalid in any widget while the field above draws its errors, andCheckboxWidget's box never being styled invalid (#5545, #5490) - Change the widgets to put
aria-invalidand only the descriptions that render on the element a user focuses:BaseInputTemplate's,TextareaWidget's,UpDownWidget's andCheckboxWidget's input,RangeWidget's thumb, each option,RadioWidget'sradiogroupandNativeSelectWidget(#5545, #5490) - Fix
RadioWidgetignoringui:autofocus(#5545, #5490) - Fix
RadioWidget'sradiogroupbeing named by the field's description or an id no element had: it is named by the label it draws, by the plan'saria-labelunderui:label: false, or left unnamed, and draws no label holding only a required field's*(#5545, #5490) - Fix
FieldTemplatedrawing no label forRatingWidget,AltDateWidget,AltDateTimeWidgetand other widgets that leave it the label; a widget of your own under those keys that draws its own should be declaredlabel: 'self'(#5545, #5388, #5490) - BREAKING CHANGE: Change
TitleFieldto put its title id on a<span>around the title's text, with a required heading's*outside it, so a selector or style targeting#…__titlenow targets the<span>inside the<h5>. See the upgrade guide (#5545, #5490) - Fix
ArrayFieldTemplatedrawing theui:titleananyOf/oneOfoption repeats a second time, and dropping an optional array's data control where it draws no heading, as underui:label: false(#5531, #5490) - Fix
MultiSchemaFieldTemplaterendering an empty<div>for a selector it isn't given, as while an optionalanyOf/oneOffield has no data (#5543, #5401, #5490) - Fix
FieldErrorTemplaterepeatingerrorId()for each message of a field with several errors; it renders them in one element, each on its own line (#5545, #5490) - Fix
ObjectFieldTemplatedropping the optional data control where it draws no heading, as underui:label: false, and rendering an empty grid item where there is no control (#5531, #5490) - Fix
SelectWidgetrendering its select's control twice, soselect:<id>:controlappeared twice on the page (#5545, #5490) - Fix
FieldTemplate's fieldset pointingaria-labelledbyat a legend that renders only for a description, so a control or group named by the template's label is no longer announced inside a fieldset of the same name (#5545, #5490) - BREAKING CHANGE: Change every widget's control to be named by its label and carry the field's id on the element a user focuses, and a radio group's or slider's label to have no
for; selectors aimed at Ark's generated ids, such asselect:root_color:trigger, should aim at the field's id. See the upgrade guide (#5545, #5490) - BREAKING CHANGE: Change radio and checkbox
<input>s to take theiroptionId(), sofocusOnFirstErrorreaches them. See the upgrade guide (#5545, #5490) - Fix
RangeWidget's thumb ignoringui:autofocus(#5545, #5490) - Fix
RangeWidget's label missing its required*, its dimming for a disabled or read-only field and its invalid state while errors show, asUpDownWidget's has them (#5545, #5490) - Fix
CheckboxesWidget's fieldset pointingaria-labelledbyat an id no element has when it draws no label; the group carrying the field's id is named by its label, drawn outside a<legend>so the name is announced once (#5545, #5490) - Fix
AltDateWidget's andAltDateTimeWidget's labelfornaming an id no element had: the date parts' fieldset is named by the label, and each part is described by the field andaria-invalidwhile errors show (#5545, #5542, #5490) - Fix
CheckboxWidget's input pointingaria-labelledbyat a label that isn't rendered (#5545, #5542, #5490) - Fix
RangeWidgetandUpDownWidgetsubmitting under the field's id rather thanhtmlName, andCheckboxesWidgetignoringui:autofocus;TitleField's required marker carrieschakra-field__requiredIndicatorand thefieldrecipe's style, as a label's does (#5545, #5490) - Fix
SelectWidgetandRangeWidgetbeneath a radio option selector repeating the field's label id,WrapIfAdditionalTemplate's key select and input being unnamed underui:label: false, andNativeSelectWidgethaving noname; it now takeshtmlName(#5545, #5490) - Fix
SelectWidget's trigger and listbox being unnamed where no label names them: they take the field's label, placeholder or translated prompt, and a click on the label focuses the trigger instead of opening the listbox (#5545, #5490) - Fix
CheckboxWidgetnot falling back to the schemadescriptionfor an emptyui:description(#5545, #5490) - Fix
RadioWidget's group not beingrequiredandCheckboxesWidget's label missing a required*(#5545, #5490) - Fix
SelectWidget,UpDownWidget,CheckboxWidgetandAltDateWidget's first date part ignoringui:autofocus(#5545, #5490) - Fix a click on
RadioWidget's orRangeWidget's label not focusing a radio or the thumb (#5545, #5490) - Fix
AltDateWidget's Now and Clear buttons staying enabled when the field is disabled (#5545, #5490) - Fix
UpDownWidgetshowing a stored0as empty, and showing the old number again after the form clears or resets it (#5563) - Fix
UpDownWidgetreporting a change, which ranonChangeand live validation, when it loses focus or takes Enter without being edited (#5563) - Fix
UpDownWidgetclamping a number past ±Number.MAX_SAFE_INTEGERto that bound on blur, which reported a change nobody made (#5563) - Change the theme to declare where its widgets draw their own label,
labelPlacement: 'above'for every widget and selector and'beside'for the checkbox, so a customArrayFieldItemTemplategetsdisplayLabel: truefor an item whose widget draws its label above it (#5538) - BREAKING CHANGE: Change
AltDateWidgetto hand an unset date part on asundefinedrather than'', asuseAltDateWidgetProps()now returns it, so a customSelectWidget,onFocusandonBlurseeundefined. See the upgrade guide (#5604, #5378) - Add
chakraas the theme'sglobalUiOptionsKeys, so achakrainui:globalOptionsreaches every widget'soptions, a custom widget's included; the theme'sUiSchematype types it and takes aUserExtensionsparameter, andChakraGlobalUISchemaOptionsis exported (#5611, #5607) - Fix
ObjectFieldTemplateshowing no add button for an object naming noadditionalPropertiesin a form whoseadditionalPropertiesWhenAbsentis'allow'(#5620, #2137) - Change
FieldTemplateto set its fieldset'sinvalidstate from the field's own errors, thehasErrorsprop, so ananyOf/oneOfoption follows its ownui:hideError(#5646) - Add
aria-invalidand a description by its row's errors toWrapIfAdditionalTemplate's key input, the free-text one and thepropertyNamesselect alike, while the object forbids that key (#5640, #4630) - Add the
keyNotAllowedpropFieldTemplatehandsWrapIfAdditionalTemplate; a customWrapIfAdditionalTemplatethat spreads its leftover props onto an element should leave it out (#5640, #4630) - BREAKING CHANGE: Change an additional property's key input id to
root_foo__keyfromroot_foo-key, built by the newadditionalKeyId(). See the upgrade guide (#5626) - Change
__createChakraFrameProviderto take{ children: ReactNode }rather thananyand its returned component to take{ document?: Document }, and to throw an error saying it must be rendered inside a frame that provides a document rather than failing ondocument.head(#5410) - Fix
ObjectFieldTemplateleaving an empty grid cell for a property hidden bydeprecatedHandling: 'hide'or aui:definitionshidden widget (#5617, fixes #5507) - BREAKING CHANGE: Change
GridTemplateto read a column'sspanas itscolSpanunless it has acolSpanof its own, logging a warning that itsspanis ignored, and to lay aui:rowwithouttemplateColumns,templateAreas,gridTemplateorgrid, as a prop or in itsstyleorcss, out on 12 tracks, each child full width unless it spans fewer, and warn about a columnspanthat isn't a whole number. See the upgrade guide (#5707, #5651) - Fix
NativeSelectWidgetleaving a select no label names, such as an untitled root or array item select, without an accessible name; it is named by itsui:placeholder, elseTranslatableString.SelectPlaceholder("Select ...") (#5713, #5711) - Fix
RadioWidgetleaving aradiogroupno label names, such as an untitled field's, without an accessible name; it is named by itsui:placeholder, elseTranslatableString.RadioGroupName("Choose an option") (#5713, #5586) - Fix renaming an
additionalPropertieskey remounting its field, which lost what its widget held, such as analt-date's partly picked date (#5733, #5595) - Fix the text input rendering a stray
0beside it when its value is0andallowClearTextInputsis set (#5682) - Change a text input holding
falseto show that value and offer the clear button for it, where it was empty (#5682) - Change an empty
RangeWidgetto leave its name out of a native form submit, and to commit its minimum when a press or a key leaves the thumb there (#5682) - Fix
RangeWidgetwriting a number into a string field, which then failed validation: it now writes a numeric string, as core's range input does (#5682) - BREAKING CHANGE: Change the alt-date and alt-datetime widgets to show a number or
Datevalue as empty, where they showed that date, since they can only write a string back. See the upgrade guide (#5682) - Fix
BaseInputTemplatedropping apattern,inputMode,acceptormultiplea widget passes it as a prop, so the file input of an array took one file at a time (#5684) - Fix
WrapIfAdditionalTemplateleaving the key input and the remove button enabled for a property it is handed no rename or remove callback for, such as the root (#5684) - BREAKING CHANGE: Change
AltDateWidgetto show the default years for ayearsRangereaching before 100, such as[50, 2030], where it offered that range and wrote a year before 100 as 19xx. See the upgrade guide (#5685) - Fix
RangeWidgetfor an Ajv$datareference inminimum,maximumormultipleOf, which set the range's bound or step to the object and now leaves it at its default, and read a numeric-string bound such asminimum: '5'as its number (#5688) - BREAKING CHANGE: Change
WrapIfAdditionalTemplateto readADDITIONAL_PROPERTY_FLAGby its truth rather than its presence, so a schema with it set toundefinedorfalserenders as a plain field, with no key input or remove button. See the upgrade guide (#5689) - BREAKING CHANGE: Fix a required
anyOf/oneOffield showing no*with anullor untitled object option selected, or one on the option rather than the field: the selector's label is marked now, and the option's isn't, though its control staysrequired. A custom widget drawing its own label marks it fromtemplateMarksRequired(). See the upgrade guide (#5743, #5573) - BREAKING CHANGE: Fix
CheckboxesWidgetgiving a screen reader no cue that a checked box is required: a required group whoseminItemsis at least 1, or withui:required: true, is now named with "required", and a required group with neither, which submits[], no longer shows a*. See the upgrade guide (#5743, #5573) - Fix
RangeWidgetreporting no value to the form'sonFocusandonBlur(#5752, #5600) - Fix
CheckboxWidget'saria-describedbylisting its description before the field's help, whichFieldTemplatedraws above the checkbox (#5794, #5720) - BREAKING CHANGE: Change
ObjectFieldTemplateto render an object's title, description and contents inside adivwithrole="group"carrying the field'sid, named by the title and described by the field's errors, description and help. See the upgrade guide (#5795, #5723) - BREAKING CHANGE: Change
ArrayFieldTemplateto give the element around an array's title, description and itemsrole="group"and the field'sid, named by the title and described by the field's errors, description and help. See the upgrade guide (#5795, #5723) - BREAKING CHANGE: Fix a required multiple
SelectWidgetblocking a submit of the[]its schema accepts: an array rendered as one widget holding[]is now required, and shows a*, only where itsminItemsis at least 1 orui:required: trueasks for it. See the upgrade guide (#5822, #5744) - Add support for importing and rendering
Formfrom a React Server Component, such as a Next.js App Router page, without wrapping it in a'use client'module of your own (#5863, #5761) - Fix
FieldErrorTemplatedrawing an empty item for an empty error message (#5882, #5603) - BREAKING CHANGE: Change
AddButtonto an icon button titledAdd Item, without its visibleAdd Itemtext, andObjectFieldTemplateto title an expandable object's Add button after the object's title or name, such asAdd Address. See the upgrade guide (#5899, #3596)
@rjsf/core
- BREAKING CHANGE: Change
GridTypeandOperatorsfromenums toas constobjects with same-named union types, exported from the package root now that deep imports are removed; values andGridType.ROWaccess are unchanged, but a member used as a type must be writtentypeof GridType.ROW. See the upgrade guide (#5244, #5674, #5599) - BREAKING CHANGE: Change
withTheme()to return a plain function component instead of aforwardRef-wrapped one. See the upgrade guide (#5260, #5266) - BREAKING CHANGE: Change
FormProps['onSubmit']'s event type toSubmitEvent<HTMLFormElement>instead ofFormEvent<any>. See the upgrade guide (#5260, #5266) - BREAKING CHANGE: Remove the deprecated
FormmethodsgetUsedFormData(),getFieldNames()andomitExtraData()(useSchemaUtils.omitExtraData()). See the upgrade guide (#5262) - BREAKING CHANGE: Remove the deprecated
removeEmptyOptionalObjectsprop. See the upgrade guide (#5262) - BREAKING CHANGE: Remove boolean
liveValidate/liveOmitvalues (use'onChange'). See the upgrade guide (#5262) - BREAKING CHANGE: Remove the deprecated
ui:rootFieldIddirective (useidPrefix). See the upgrade guide (#5262) - BREAKING CHANGE: Change the
extraErrorsBlockSubmitprop toextraErrorsAreWarnings:extraErrorsnow block submission unlessextraErrorsAreWarningsistrue. See the upgrade guide (#5268, #4964) - Fix a
customErrora field or widget raises throughonChangebeing dropped on submit; it now blocks submission like schema errors do (#5268, #5438) - BREAKING CHANGE: Remove the private
_internalFormWrapperprop fromFormPropsandThemeProps; usetagNameto render another element in place of<form>. See the upgrade guide (#5271) - BREAKING CHANGE: Remove the
experimental_prefix fromFormProps:experimental_defaultFormStateBehavioris nowdefaultFormStateBehaviorandexperimental_customMergeAllOfis nowcustomMergeAllOf. See the upgrade guide (#5267) - BREAKING CHANGE: Change
getTestRegistry()to be exported from the@rjsf/core/testingentry point, the only one that needs@rjsf/validator-ajv8, now an optional peer dependency. See the upgrade guide (#5272) - BREAKING CHANGE: Change
TimeWidgetandDateTimeWidgetto write aformat: "time"/"date-time"value with seconds and the browser's UTC offset (14:30:00-04:00, not14:30), as RFC 3339 requires;iso-time/iso-date-timeget seconds but no offset. See the upgrade guide (#5270, #3930) - BREAKING CHANGE: Remove
getDefaultRegistry(); use the newgenerateTheme(),generateFields(),generateWidgets(),generateTemplates()orgenerateButtonTemplates(), or import one of the newly exported components directly. See the upgrade guide (#5266) - BREAKING CHANGE: Change the
Form.getRegistry()static to abuildRegistry()export from@rjsf/coretaking the same arguments. See the upgrade guide (#5266) - BREAKING CHANGE: Change the
dataparameter of theonBlurandonFocusprops fromanytounknown, so a handler that types it (e.g.value: string) needs a type guard. See the upgrade guide (#5266) - BREAKING CHANGE: Change markdown to opt-in:
Formrenders plain text unless you registertemplates.MarkdownTemplatefrom@rjsf/core/markdown, andmarkdown-to-jsxis now an optional peer. See the upgrade guide (#5263) - BREAKING CHANGE: Change markdown rendering to no longer parse raw HTML. See the upgrade guide (#5263)
- BREAKING CHANGE: Change
FileWidget's file information to followui:enableMarkdownInDescription. See the upgrade guide (#5263) - BREAKING CHANGE: Remove
RichDescription.TEST_IDSandRichHelp.TEST_IDS; useMarkdownTemplate.TEST_IDS.markdownfrom@rjsf/core/markdown. AddMarkdownTemplateto@rjsf/core's component exports. See the upgrade guide (#5263) - Fix
ui:placeholderbeing ignored on multi-select arrays, file arrays, custom array widgets and boolean fields (#5285) - Fix a
ui:FieldTemplateorui:FieldErrorTemplateoverride being ignored on aLayoutMultiSchemaField(#5285) - Fix
FileWidgetwiping the selection when a picker re-fireschangewith an empty file list after its dialog is cancelled;useFileWidgetPropsnow reads an empty selection as a cleared value (#5285) - BREAKING CHANGE: Change fields, widgets and templates to identify a field by a
fieldPathstring (friends[0].firstName) and anidinstead offieldPathId, whichFieldProps['onChange'],childFieldPathIdandIChangeEventdrop. See the upgrade guide (#5280, #5217) - BREAKING CHANGE: Change
IChangeEventto a standalone interface with every memberreadonlyandformDatatypedEventFormData<T>; copy the event'sformDatainto your own state instead of assigning into the event. See the upgrade guide (#5298, #5311) - Change
Formto applyui:emptyValueandui:initialValueto its defaults, a new array row, an added property and the properties an item of an array'sdefaultleaves out included, and to enforceui:required: truewherever the field renders, on submit and in live validation alike, with precompiled validators too, counting[]on a group of checkboxes as no answer and reading theanyOf/oneOfoption shown and any option inside it, whoseui:requireddefaults to the field's, and to mark a checkbox it asks of, witharia-required, while it holds no value (#5277, #5743, #5870, #5898, #4983, #5573, #5918, #5894) - Change
SchemaFieldandLayoutGridFieldto take a field's required state from its ownui:required, notui:globalOptionsor a grid cell's config (#5277, #5344, #4983) - Add a one-time warning when a falsy
ui:required, such asfalseornull, makes a schema-required field optional withoutui:initialValueorui:emptyValue(#5277, #5379, #4983) - Add
CoreUiOptionsChecks, describing@rjsf/core's built-in widgets, fields andui:options, to pass asStrictUiSchema'sCheckstype argument (#5275, #5372, #4916, #5726, #5610, #5742, #5392) - BREAKING CHANGE: Remove the
experimental_componentUpdateStrategyprop:FormandSchemaFieldcompare props shallowly, so function props such ascustomValidate, templates andformContextmust be stable references. See the upgrade guide (#5297, #5438, #5217) - BREAKING CHANGE: Change the
formDatapassed toonChangeand the other callbacks to share unchanged subtrees with the previous value, theformDatayou passed included; treat it as immutable. See the upgrade guide (#5297, #5556, #5217) - Change
FormandLayoutGridFieldto keep unchanged state anduiSchemareferences, so typing in one field re-renders no sibling (#5297, #5217) - Fix a
oneOf/anyOfof constants with notyperendering as an unsupported field; it now renders a select, inferring thetypefrom the constants (boolean constants keepbooleanand defaultui:widgettoselect) (#5305, #4666) - BREAKING CHANGE: Fix
BooleanFieldignoring a constantanyOfand falling back to plain Yes/No options; a boolean with constant options under bothanyOfandoneOfnow shows theanyOftitles. See the upgrade guide (#5305, #4666) - Fix
BooleanFieldlabelling every non-trueconstantNo, so an untitledoneOfofnull,trueandfalseshowednullandfalsealike (#5305, #4666) - Fix
NumberFielddropping a leading sign while typing, so-0.5,-0,+5and-.5are no longer rewritten mid-typing; a lone-.now resolves to-0(#5303, #4038) - Change
BaseInputTemplateto render anumber/integerfield as<input type="text">with a numericinputMode,patternandtitleinstead of<input type="number">, withoutstep,minormax; a widget's ownpatternorinputModestill wins (#5303, #4038) - Add
ui:options.optgroupsto groupSelectWidgetoptions under<optgroup>s; a multiple select still reports its values in enum order (#5301, #1813, #580) - Add a dropdown for an
additionalProperties/patternPropertieskey whenpropertyNamesenumerates the allowed names, leaving out names already used; the add button takes the first free name, preferring one a field can be rendered for and the schema doesn't forbid, and hides once all are taken.WrapIfAdditionalTemplategets apropertyNamesEnumprop (#5321, #5429, #4682, #5330) - Add a
keyNameprop toFieldTemplate, from whichWrapIfAdditionalTemplatenow reads an additional property's key instead of thelabel(#5321, #4682) - Fix
MultiSchemaField's option selector andArrayField's multi-select and file widgets showing their error state underui:hideError;ArrayFieldandObjectFieldnow also passhideErrorto their templates (#5324, #3684) - BREAKING CHANGE: Fix
LayoutMultiSchemaFieldpassing itsFieldTemplateneitherrawErrorsnorhideError, so a layout grid field's label and control now get error styling and a customFieldTemplatecan tell errors are hidden. See the upgrade guide (#5324, #5406, #5327, #3684) - Add
errorSchematoFieldTemplateProps, holding all the field's errors even underui:hideError, so a template that renders errors itself can reach them (#5324, #5606, #3684) - Fix a custom
ArrayFieldTemplatereceiving noerrorSchemafor an ordinary (non-tuple) array (#5324, #3684) - Fix a schema allowing several types (
type: ['string', 'number']), or an unconstrainedadditionalPropertiesentry, being stuck on one type: withuseFallbackUiForUnsupportedTypeon,SchemaFieldrendersFallbackField, whose type selector offers the allowed types (#5323, #5238) - Change
FallbackField's type selector to offerintegerandnulland start on the current data's type (#5323, #5238) - Change
FallbackFieldto convert the value on a type switch without inventing data: a value with no reading in the new type clears instead of becoming0or[object Object], abooleanarray item oradditionalPropertiesentry becomesfalse, and old errors clear (#5323, #5804, #5238) - Fix
FallbackField's value field dropping the schema's other keywords (properties,items,format,minimum…) and crashing on aui:widgetthe chosen type has no widget for (#5323, #5238) - Fix
FallbackFieldrendering its label or help twice and marking its type selector required (#5323, #5238) - Fix
FallbackFieldfalling out of step with the allowed types or outside data, and its value field losing focus on each change (#5323, #5238) - Fix a schema pairing several types with an
anyOf/oneOfkeeping the options on the first type:FallbackFieldnow renders the option selector within the type selector, dropping it whennullis chosen; a list with an option naming its owntypehas that type selector only within options naming none (#5323, #5724, #5238, #5390) - Fix the fallback UI renaming an untitled multi-type property
Value, and anobjectorbooleanunion losing itstitleanddescription(#5323) - Change
FallbackFieldto let aui:widgetgiven as a component render a multi-type union itself, as aui:fielddoes, instead of wrapping it in a type selector (#5323) - Fix
FallbackField's type selector leaving the type it is on when the user clears anadditionalPropertiesentry or array item, clears it to itsui:emptyValue, or picks a type that clears it (#5323, #5804, #5784) - Change
FallbackFieldto build its schemas anduiSchemaonly whenuseFallbackUiForUnsupportedTypeis on (#5323) - Fix a multi-type union with an
anyOf/oneOfthat renders as optional data controls showing its label before it has data, unlike the sameanyOfwithout the union (#5323) - Fix the fallback UI's type selector showing a
Typelabel whenui:options.labelisfalse(#5323) - Change a
ui:widgetgiven as a component to render within the type selector for a schema with no type of its own (an unrecognizedtypeor an unconstrainedadditionalPropertiesentry), rather than replacing it as for a union (#5323) - BREAKING CHANGE: Change clearing a custom error a field raised through
onChange(value, path, errorSchema)to also remove it from theErrorListTemplate, where it stayed until the next validation. See the upgrade guide (#5312) - BREAKING CHANGE: Change
noValidateto also turn offliveValidate='onBlur', which used to validate and show errors regardless. See the upgrade guide (#5312) - Remove
Form's internalgetStateFromProps()method, which was never part ofFormRef(#5438) - Fix
extraErrorsand a field's custom errors being added to the error list again on every change that raises a custom error while validation errors show (#5312, #5041) - Fix a later
extraErrorschange bringing back the previous schema's validation errors after theschemachanged ornoValidatewas set (#5312) - Fix live validation of data replaced from outside, or re-run for a changed validation callback, showing different errors than typing the same value would (#5312, #5556)
- BREAKING CHANGE: Change
FormRef.validate()to take only the form data, and dropFormRef'sSandFtype parameters; to validate against another schema, callschemaUtils.getValidator().validateFormData(). See the upgrade guide (#5312, #5438) - Fix the
ErrorListand theonChangepayload keeping an error the changed field no longer showed when new props were applied without live validation (#5341) - Fix an
ErrorSchemaa field raises throughonChangebeing lost on a path with a validator error: it replaces the validator's errors below that path,{}clears them, and it is not listed twice withextraErrors(#5341, #5556) - Fix
ArrayFieldadding, copying, moving or removing an item dropping the array's own errors, such asminItems(#5341) - Fix an additional property added from outside the form after mount not rendering (#5339)
- Fix a field edit being dropped when the form data root is
nullorundefined; it now creates the object or array the field lives in (#5339) - BREAKING CHANGE: Remove
editfromIChangeEvent; it only restated whether you passedformDataorinitialFormData, so check your own props. See the upgrade guide (#5339) - Fix a throwing
customValidate,onChange,onSubmitoronErrortaking the form down: the error comes out of theFormRefcall or event that caused it, or is reported as uncaught for a field's change, blur or focus (#5438) - BREAKING CHANGE: Change the
Tgeneric's default tounknownandF's toFormContextType: a handler with no type argument getsunknownform data, so pass a type toFormorIChangeEvent, or passformDataforFormto infer it. See the upgrade guide (#5311, #5438) - BREAKING CHANGE: Change
withTheme()to return the newThemedForm<T, S, F>type, a component generic over its form data likeForm, instead ofComponentType<FormProps<T, S, F>>; statics such asdisplayNameleave the returned type. See the upgrade guide (#5311) - BREAKING CHANGE: Change
IChangeEvent.formDatato a required member typedEventFormData<T>, whichFormRef.getFormData()also returns:Tfor an object or array root,T | undefinedfor a scalar. See the upgrade guide (#5311, #5438, #5556) - BREAKING CHANGE: Change
withTheme()to use only the theme'sfields,widgetsandtemplates, ignoring other props such asnoHtml5Validate; pass those to the themedForm. See the upgrade guide (#5311) - Change
FormRef.setFieldValue()to take the field's value asunknowninstead ofT, so a typed form's ref can set a field (#5311, #5438) - Change
SchemaFieldandMultiSchemaFieldto log each uiSchema misconfiguration warning once per page instead of on every render, naming the field by its id andfieldPath(#5344, #3051) - Fix a
FieldTemplatethat checksrawHelpdropping aui:helpgiven as a React element;SchemaFieldnow passes it asrawHelp(#5351, #5326) - Fix a
ui:helpon a layout grid's discriminatedoneOf/anyOfcell not rendering in any theme (#5351, #5606, #5326) - Change
ObjectFieldandArrayFieldto share one frozen emptyuiSchemawhen none is passed, so a customObjectFieldTemplateorArrayFieldTemplatewriting to it now throws aTypeError(#5366) - Fix a re-render that only rebuilt
validatororcustomMergeAllOfresetting data the user cleared or switched to its default; a realvalidatorchange now needs a newkey(#5376, #5556, #5294) - Fix
liveValidate: 'onBlur'showing errors before any blur when the form data was replaced from outside, and merging everyextraErrorsentry in twice there (#5376) - Fix live validation dropping every
extraErrorsentry when the form data was replaced from outside (#5376, #5556) - Fix
extraErrorsandcustomErrorsbeing duplicated when a re-render underliveValidate: 'onChange'changed only props such asclassName(#5376, #4408) - Fix live validation running against the old schema after
validator,customMergeAllOfordefaultFormStateBehaviorchanged (#5376) - Change
ObjectFieldto pass the object's own errors toObjectFieldTemplateasrawErrors, asArrayFielddoes (#5354, #5332) - Change
SchemaFieldto stop passing a field's own errors asrawErrorsto the field beside aoneOf/anyOfselector, which shows them, while anArrayFieldthere still keeps them as it changes items;MultiSchemaFieldpasses the field'sidtoMultiSchemaFieldTemplate(#5354, #5332) - BREAKING CHANGE: Change a schema with both
anyOfandoneOfto render from itsanyOf, and a select over object or array constants to render throughStringField. See the upgrade guide (#5350, #5309, #5317) - Fix
OptionalDataControlsField's Add button storing{}instead of[]for ananyOf/oneOfwhose options are all arrays (#5361, #5316) - Fix a
$idnamingFallbackFieldreplacing a non-selectanyOf/oneOfwith an unsupported-field box whileuseFallbackUiForUnsupportedTypeis off; the option selector renders instead (#5362, #5333) - Fix
ui:fieldReplacesAnyOrOneOfhiding theanyOf/oneOfoptions for aui:fieldthat resolves toFallbackFieldor to no registered field, where an object union rendered nothing (#5362, #5333) - Fix a
ui:fieldresolving toFallbackFieldexhausting the browser's memory; it renders one type selector over one value field (#5362, #5538, #5611, #5333) - Fix the fallback UI's type selector offering all seven types for a schema whose
type,enumorconstnarrows them (#5362, #5333) - Change the fallback UI to render a schema allowing a single type as the plain field for that type, without a type selector or the
FallbackFieldTemplatewrapper's blank row (#5362, #5611, #5333) - Fix a
ui:fieldor$idnamingFallbackFieldwrapping a typeless non-selectanyOf/oneOfin a selector of all seven types, where switching type changed nothing on screen but cast the value away (#5362, #5333) - Fix a schema that only implies its type, such as
propertieswith notype, reached through aui:fieldor$idnamingFallbackField, rendering a selector of all seven types or nothing instead of its properties;getSchemaOwnTypes()now agrees withgetSchemaType()(#5362, #5611, #5333) - Fix a
ui:fieldthat replaces theanyOf/oneOfoptions being rendered again inside each option that has no uiSchema of its own (#5362, #5333) - Fix a schema whose only allowed type is
null, such as['foo', 'null']beside ananyOf, rendering neither its options nor a field for them with the fallback UI on (#5362, #5333) - Fix
realValueoptions with the sameString(), such as1and'1', sharing a DOM value, and the examples<datalist>rendering duplicate keys, suggestingnull, object or array values, or rendering when empty (#5400, #5315) - BREAKING CHANGE: Change
BooleanFieldto label booleanenumvaluesui:enumNamesdoesn't name Yes/No, and applyui:enumNamesonly toenumvalues. See the upgrade guide (#5364, #5636, #5727, #5319) - Change
BooleanFieldto applyui:enumOrderto its Yes/No options (#5364, #5636, #5319) - Change
BooleanFieldto keep a constant option's emptytitle(#5364, #5636, #5319) - Fix the
formDatahanded tocustomValidateignoring the form'scustomMergeAllOfanddefaultFormStateBehaviorwhen computing defaults (#5340, #4385) - BREAKING CHANGE: Fix a layout grid's discriminated
oneOf/anyOfcell missing itsFieldTemplateprops: it gets therjsf-field*andui:classNamesclasses andui:style, which its selector no longer gets, honorsui:widget: 'hidden'and renders its description. See the upgrade guide (#5406, #5327) - Add
getFieldClassNames()andomitConsumedStyling(), whichSchemaFielduses for itsFieldTemplate's classes and styling, so a custom field rendering its ownFieldTemplatecan match therjsf-field*contract (#5406, #5606, #5327) - BREAKING CHANGE: Change a layout grid's discriminated
oneOf/anyOfcell to honorui:disabled, in both directions, and adeprecatedschema like any other field, through the newgetDeprecatedHandling(). See the upgrade guide (#5606, #5327) - Fix
IconButtonputting a React elementiconinto aglyphicon-[object Object]class name instead of rendering it (#5382) - Fix a new
additionalPropertiesentry with anintegeror nullabletypelist (['number', 'null']…) defaulting to the stringNew Valueinstead of0orfalse(#5379, #5428) - Change
RichDescriptionandRichHelpto pass a frozen emptyuiSchematoMarkdownTemplatewhen none is passed, so a customMarkdownTemplatewriting to it now throws aTypeError(#5379) - Fix a non-boolean falsy
ui:label, such as0ornull, not hiding an object field's title and description or the fallback UI's type selector label (#5379) - Fix a precompiled form throwing in
MultiSchemaFieldwhentransformChangerefuses or rewrites an option switch, and read athenbeside the kept option as adding to it rather than overriding its keywords. See the upgrade guide (#5371, #5536, #5556, #5338, #5373) - Fix a
ui:fieldorLayoutGridFieldcellrendergiven as amemo(),forwardRef()orlazy()component not rendering. One that isn't a usable component now logs a warning, once per uiSchema entry however many items or extra keys it reaches, and its field renders as if noui:fieldwere given;nullorfalsestill opts the field out (#5433, #5611, #5823, #5363, #5658) - Fix a
typelist of three or more entries starting withnull, such as['null', 'string', 'number'], renderingNullField: it renders the field of its first non-null type, or of another listed type when only that one has the field's widget, such asStringFieldfor atextarea(#5428, #5331) - Change the type selector of
useFallbackUiForUnsupportedTypeto start atypelist holding no value on the type itsui:widgetrenders, and a value of an unlisted type on a type whose field can show it, and fix a globalwidgetthe selected type lacks throwingNo widget(#5428, #5331) - Fix a fixed-items
ArrayFieldthrowingCannot read properties of nullfor anullheld by atypelist such as['null', 'array'](#5428, #5331) - Fix adding a property to an
ObjectFieldholding a string, as atypelist such as['null', 'object', 'string']allows, spreading the string's characters into the new object (#5428, #5331) - Change a new
additionalPropertiesentry under anenumor a constantanyOf/oneOfto start on the first option not inui:enumDisabledunless its type's default is such an option, soenum: ['a', 'b']starts at'a'rather thanNew Value(#5428, #5331) - Fix checking an option of a multi-select
ArrayFieldholdingnull, as atypelist such as['null', 'array']allows, writing thenullinto the array beside the checked option (#5428, #5331) - Fix
ObjectFieldseeding a new property withnull, which only anullfield can render: it now seeds from the subschema that renders it (a matchingpatternProperties,additionalPropertiesorunevaluatedProperties), honoring itsconst,defaultand type (#5429, #5330) - Change
ObjectFieldto seednullfor a name anunevaluatedProperties: falseor a matchingfalsepatternPropertiessubschema forbids, as it did foradditionalProperties: false(#5429, #5330) - BREAKING CHANGE: Change
ObjectFieldto seed a new property from anadditionalPropertieswith a$refbeside other keywords by layering those keywords over the referenced schema rather than discarding them, so{ type: 'string', $ref: '#/definitions/aNumber' }seeds a string. See the upgrade guide (#5429, #5330) - Fix
ObjectFieldnot rendering the data's extra keys, nor offering the add button, for an object whose only keyword describing them isunevaluatedProperties(#5429, #5330) - Fix
ObjectFieldleavingNew Valuein a field that can't show it when a new, unedited property is renamed onto a name another subschema describes, such as a numeric pattern (#5429, #5481, #5330) - Fix
ObjectFieldsettling anifinside a new property's subschema against an empty object rather than thedefaultthe property is about to hold (#5429, #5330) - Fix
FallbackFieldsilencing anunevaluatedProperties: falseon a union-typed object and offering an add button for keys the schema forbids (#5429, #5330) - BREAKING CHANGE: Change
Formto a function component: type its ref asFormRef<T>and read data through its methods or the event rather thanstate,setState()orformElement. See the upgrade guide (#5438, #5556) - BREAKING CHANGE: Change
Formto apply each edit as it is made:onChangenow runs before the inputs show the value, and a later edit in the same event builds on the one before. This also undoes some of 6.11.1's change handling. See the upgrade guide (#5438, #5556, #5750, #5748) - BREAKING CHANGE: Change the
reactpeer dependency floor from>=19to>=19.2, the release that added<Activity>, whose hidden contentFormtreats as unmounted. See the upgrade guide (#5438, #5556) - Fix a
dependenciesorif/then/elseswap keeping the old branch'sdefaultfor an object- or array-typed property: the new subschema'sdefaultnow replaces a value still equal to the old one, while an edited value is kept (#5464, #5537, #5349) - Fix
setFieldValue('', data)on a form that isn't live-validated keeping the errors of a replaced root string, number or array or a root that changed type, and a root object's own errors, such asminProperties, staying after a property changes (#5469, #5034) - BREAKING CHANGE: Change an error a field raises through
onChangeto be kept apart from the validator's errors, so it survives a parent passingformDataback and the next validation, and an empty raise clears it. See the upgrade guide (#5470, #5556, #5347, #5348) - BREAKING CHANGE: Change the
errorSchemaa field passes toonChangeto hold only the errors it raises, so one matching anextraErrorsmessage survives clearingextraErrors. See the upgrade guide (#5471, #5348) - Fix a field's raised errors staying behind when
ArrayFielditems move, optional data or an additional property is removed or renamed, or an option switches, so a stale raise no longer blocks submit (#5471, #5348) - Fix a field's raised error not showing at once under
noValidate(#5471, #5348) - Fix
Formlisting anextraErrorsmessage twice, in theErrorList, on its field and in theerrorspassed toonErrorandonChange, when the validator reports the same message at the same path (#5443, #5442) - Fix
DateTimeWidgetshowing0as empty,trueas a 1970 date, and crashing on a valueDatecan't convert; an invalid date, text that isn't a date or a year before 1 now gives an empty input (#5473, #5431) - BREAKING CHANGE: Fix
AltDateWidget's date parts having no accessible name: each select is named by the field's label and part, such asWhen, year, and described by its description, help and errors. See the upgrade guide (#5418, #5355, #5357) - Fix
SelectWidgetnot passing itsaria-labelandaria-describedbyto its<select>(#5418, #5355, #5357) - Fix
AnyOfFieldcommitting an option that no longer describes changed data for a render, and aui:titleofnullhiding the schematitleof a field or option label;AnyOfField,LayoutMultiSchemaFieldandFallbackFieldno longer opt out of the React Compiler (#5482) - Change
SchemaFieldto memoize the retrievedanyOf/oneOfoptions anduiOptions, so a re-render changing neither schema nor data no longer makesAnyOfFieldandOneOfFieldretrieve every option again (#5482) - BREAKING CHANGE: Change
AnyOfFieldandOneOfFieldto render theoptionsthey are handed as they are, sinceSchemaFieldnow retrieves each option once; a custom field rendering them with raw option schemas has to retrieve each first. See the upgrade guide (#5482) - Fix
Formclearing array and scalar values a sibling edit didn't affect, matching v6, while a conditional that flipped still filters, keeping the #5250 fix (#5460, #5556, #5537, #5451) - Add the
itemLabelarray option, naming the item property, or'.'for strings and numbers, that titles each item's move, copy and remove buttons, such asRemove report.pdf;ArrayFieldItemButtonsTemplatereceives the titles asitemButtonProps(#5474, #4424) - Fix
DateTimeWidgetwiping a value whose local year has five or six digits, such as the epoch1e15, on edit; a year past 9999 now stays on screen and failsdate-timeformat validation, following up #5473 (#5510) - BREAKING CHANGE: Change a non-object field's selected
anyOf/oneOfoption, and one of another type thanobjectunder atypelist namingobject, to render with every keyword of the field that describes its value, not onlyrequiredandtype, such asitemsorformat, while the field keeps itstitle,descriptionanddefault. See [the upgrade guide](https://rjsf-team.github.io/react-jsonschema-form/docs/migration-guides/v7.x%20upgrade%20guide#a-non-object-fields-anyofoneof-option-renders-with-its-parents-keyword