@rjsf/utils - npm Package Versions

5.2.0

@rjsf/antd

• Updated ErrorList, IconButtons, WrapIfAdditionalTemplate and AltDateWidget to use the new translateString() function to support localization

@rjsf/bootstrap-4

• Updated AddButton, ErrorList, IconButtons and WrapIfAdditionalTemplate to use the new translateString() function to support localization

@rjsf/chakra-ui

• Updated AddButton, ErrorList, IconButtons, WrapIfAdditionalTemplate and AltDateWidget to use the new translateString() function to support localization

@rjsf/core

• Updated ArrayField, BooleanField, MultiSchemaField, ObjectField, SchemaField, AddButton, IconButtons, ErrorList, WrapIfAdditionalTemplate and AltDateWidget and FileWidget to use the new translateString() function to support localization
  • Also updated Form to take a new optional translateString prop and getDefaultRegistry() to set translateString to englishStringTranslator()

@rjsf/fluent-ui

• Updated AddButton, ColorWidget, ErrorList, IconButtons and UpDownWidget to use the new translateString() function to support localization

@rjsf/material-ui

• Updated AddButton, ErrorList, IconButtons and WrapIfAdditionalTemplate to use the new translateString() function to support localization
• Patch RangeWidget to support 0 as range slider value, fixing #3458

@rjsf/mui

• Updated AddButton, ErrorList, IconButtons and WrapIfAdditionalTemplate to use the new translateString() function to support localization
• Patch RangeWidget to support 0 as range slider value, fixing #3458

@rjsf/semantic-ui

• Updated AddButton, ErrorList, IconButtons and WrapIfAdditionalTemplate to use the new translateString() function to support localization

Dev / docs / playground

• Updated the utility-functions documentation for the enums and englishStringTranslator() & replaceStringParameters() functions
• Updated the form-props documentation for the new, optional translateString prop on Form
• Updated the playground's numbers example to use a range slider with a valid negative and 0 value

5.1.0

@rjsf/bootstrap-4

• Updated the AltDateTimeWidget in @rjsf/core to add className="list-inline-item" to the LI tags

@rjsf/chakra-ui

• Fixed the SelectWidget to allow the proper display of the selected value, fixing #3422

@rjsf/core

• Fixed Form to remove passing excludeObjectChildren to getDefaultFormState(), fixing #3424 and #675
• Added new feature prop focusOnFirstError, that if true, will cause the first field with an error to be focused on when a submit has errors

@rjsf/utils

• Updated computeDefaults() to fix additionalProperties defaults not being propagated, fixing #2593
  • Also made sure to properly deal with empty anyOf/oneOf lists by simply returning undefined
  • Add support for adding an empty object when that object is marked as required in a schema

Dev / docs / playground

• Updated the playground to add a control for focusOnFirstError and the form-props documentation for it as well

5.0.2

@rjsf/utils

• Added the idPrefix, idSeparator and rawErrors optional props to FieldProps since they were missing

Dev / docs / playground

• Migrated latest documentation to Docusaurus, which is deployed to GitHub Pages.
• Updated readthedocs.io documentation site to guide users to the new docs site.
• Updated links in documentation and package README files to point to new site.
• Updated the custom-widgets-field documentation for the new FieldProps

5.0.1

• Updated the peerDependencies in all packages to remove the -beta.x tags from the @rjsf/xxxx packages

5.0.0

@rjsf/antd

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/bootstrap-4

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/chakra-ui

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/core

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/fluent-ui

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/material-ui

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/mui

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/semantic-ui

• Updated CheckboxesWidget, RadioWidget and SelectWidget to use indexes as values to support enumOptions with object values, fixing #1494

@rjsf/utils

• Added enumOptionsIndexForValue(), enumOptionsIsSelected(), enumOptionsValueForIndex() functions to support fixing #1494
  • Updated enumOptionsDeselectValue(), enumOptionsSelectValue() and optionId() to use indexes instead of values
  • Deleted the processSelectValue() that was added in the beta and is no longer needed
• Updated getSchemaType() to remove the inference of type from anyOf/oneOf, fixing #3412

Dev / docs / playground

• Updated the utility-functions documentation for the new and updated methods mentioned above, as well as deleting the documentation for processSelectValue()
• Updated the playground to add a new Enum Objects example to highlight the use of indexes for enumOptions
• Updated 5.x migration guide to document the change from values to indexes for the enumOptions based controls.

5.0.0-beta.20

@rjsf/antd

• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

@rjsf/bootstrap-4

• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

@rjsf/chakra-ui

• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

@rjsf/core

• Updated MultiSchemaField to pass undefined as the value to the widget when the selectedOption is -1, supporting SelectWidget implementations that allow the user to clear the selected value of the anyOf/oneOf field.
• Updated Form to support receiving an optional ref prop.
• Updated Form to restore providing empty root level objects, fixing #3391
• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

@rjsf/fluent-ui

• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

@rjsf/material-ui

• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

@rjsf/mui

• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

@rjsf/semantic-ui

• Fixed schema.examples to deduplicate when schema.default exists in the examples, fixing #3393

5.0.0-beta.19

@rjsf/core

• Updated MultiSchemaField to cache options with refs in state and to output better labels for options without them when a title is available in either the schema or uiSchema
• Improved fix for #2691 to remove the breaking change caused by the original fix #2980 as follows:
  • Added a new ui:fieldReplacesAnyOrOneOf flag to the uiSchema that when true will allow users to opt-out of the anyOf/oneOf wrapping of a custom field

@rjsf/utils

• Updated toPathSchema() to handle oneOf/anyOf by picking the closest option and generating the path for it, fixing #2262
• Added new uiSchema only flag ui:fieldReplacesAnyOrOneOf that, if true allows the user to opt-out of the anyOf/oneOf wrapping of a custom field

Dev / docs / playground

• Updated the uiSchema documentation for ui:fieldReplacesAnyOrOneOf

5.0.0-beta.18

@rjsf/core

• Updated MultiSchemaField to utilize the new getClosestMatchingOption() and sanitizeDataForNewSchema() functions, fixing the following issues:
  • #3236
  • #2978
  • #2944
  • #2202
  • #2183
  • #2086
  • #2069
  • #1661
  • And probably others
• Updated ObjectField to deal with additionalProperties with oneOf/anyOf, fixing #2538
• Updated Form, MultiSchemaField, ObjectField and SchemaField to properly support making formData optional, fixing #3305

@rjsf/material-ui

• Fix shrinking of SelectWidget label only if value is not empty, fixing #3369

@rjsf/mui

• Fix shrinking of SelectWidget label only if value is not empty, fixing #3369

@rjsf/utils

• Added new getClosestMatchingOption(), getFirstMatchingOption() and sanitizeDataForNewSchema() schema-based utility functions
  • Deprecated getMatchingOption() and updated all calls to it in other utility functions to use getFirstMatchingOption()
• Updated stubExistingAdditionalProperties() to deal with additionalProperties with oneOf/anyOf, fixing #2538
• Updated getSchemaType() to grab the type of the first element of a oneOf/anyOf, fixing #1654
• Updated all props or function parameters of the generic type T to allow for them to be optionally provided, fixing #3305
  • This was done in both the types file and the actual implementation code

@rjsf/validator-ajv6

• Updated places where formData was required as a function argument to make it optional, fixing #3305

@rjsf/validator-ajv8

• Updated places where formData was required as a function argument to make it optional, fixing #3305

Dev / docs / playground

• Updated the playground to onFormDataEdited() to only change the formData in the state if the JSON.stringify() of the old and new values are different, partially fixing #3236
• Updated the playground npm start command to always use the --force option to avoid issues where changes made to other packages weren't getting picked up due to vite caching
• Updated the documentation for utility-functions and the 5.x upgrade guide to add the new utility functions and to document the deprecation of getMatchingOption()
  • Also updated utility-functions, making all optional parameters without a default (as denoted by the syntax [<parameter>]: <type>) to add | undefined onto the type to make it clear it supports passing in undefined as a value.

5.0.0-beta.17

@rjsf/antd

• Enable searching in the SelectWidget by the label that the user sees rather than by the value
• Added support for new style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/bootstrap-4

• Added support for new style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200
• Updated CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/chakra-ui

• Added support for new style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200
• Updated CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/core

• Updated SchemaField to handle the new style prop in the uiSchema similarly to classNames, passing it to the FieldTemplate and removing it from being passed down to children.
  • Also, added support for new style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper
  • This partially fixes #1200
• Updated CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/fluent-ui

• Added support for new style prop on FieldTemplate rendering them on the outermost wrapper, partially fixing #1200
• Updated CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/material-ui

• Updated SelectWidget to support additional TextFieldProps in a manner similar to how BaseInputTemplate does
• Added support for new style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200
• Updated CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/mui

• Updated SelectWidget to support additional TextFieldProps in a manner similar to how BaseInputTemplate does
• Added support for new style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200
• Updated CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/semantic-ui

• Added support for new style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200
• Updated CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141
• Updated all the user "input" controls to have an aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
  • Also updated the generation of ids for the title, description, error, examples, options and help blocks using the associated new id generation utilty functions

@rjsf/utils

• Updated the FieldTemplateProps, WrapIfAdditionalTemplateProps and UIOptionsBaseType types to add style?: StyleHTMLAttributes<any>, partially fixing #1200
• Added enumOptionsDeselectValue() and enumOptionsSelectValue() as a loose refactor of the duplicated functions in the various CheckboxesWidget implementations
• Updated the FieldTemplateProps, WrapIfAdditionalTemplateProps and UIOptionsBaseType types to add style?: StyleHTMLAttributes<any>, partially fixing #1200
• Added new ariaDescribedByIds(), descriptionId(), errorId(), examplesId(), helpId() optionId() and titleId() id generator functions

@rjsf/validator-ajv8

• Remove alias for ajv -> ajv8 in package.json. This fixes #3215.
• Updated AJV8Validator#transformRJSFValidationErrors to return more human-readable error messages. The ajv8 ErrorObject message is enhanced by replacing the error message field with either the uiSchema's ui:title field if one exists or the parentSchema title if one exists. Fixes #3246

Dev / docs / playground

• In the playground, change Vite preserveSymlinks to true, which provides an alternative fix for #3228 since the prior fix caused #3215.
• Updated the custom-templates.md and uiSchema.md to document the new style prop
• Updated the validation.md documentation to describe the new uiSchema parameter passed to the customValidate() and transformError() functions
• Updated the utility-functions documentation to add the new enumOptionsDeselectValue() and enumOptionsSelectValue() functions and to describe the new id generator functions
• Updated the 5.x migration guide documentation to describe potential breaking id changes

5.0.0-beta.16

@rjsf/antd

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
• Updated the test for the CheckboxWidget validating that the schema.title is passed as the label, fixing #3302
• Updated the theme to accept generic types, exporting generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072
• Updated the use of the deprecated withConfigConsumer with the ConfigConsumer component instead, fixing #3336

@rjsf/bootstrap-4

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
• Updated CheckboxWidget to get the required state of the checkbox from the schemaRequiresTrueValue() utility function rather than the required prop, fixing #3317
• Updated the test for the CheckboxWidget validating that the schema.title is passed as the label, fixing #3302
• Updated the theme to accept generic types, exporting generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072

@rjsf/chakra-ui

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
• Updated CheckboxWidget to get the required state of the checkbox from the schemaRequiresTrueValue() utility function rather than the required prop, fixing #3317
• Updated the test for the CheckboxWidget validating that the schema.title is passed as the label, fixing #3302
• Updated the theme to accept generic types, exporting generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072

@rjsf/core

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
  • Also, passed registry into the SubmitButton inside of the Form as part of this fix
• Updated ArrayField to pass the new totalItems and canAdd props to the ArrayFieldItemTemplate instances, fixing #3315
  • Also refactored the near duplicate logic for onAddClick and onAddIndexClick into a new _handleAddClick() function, fixing #3316
• Fix passing of generic types to a few helper methods, partially fixing #3072
• Updated the types for ValidatorType, CustomValidator and ErrorTransformer to add the new generics, as well as passing uiSchema to the validateFormData() call, partially fixing #3170

@rjsf/fluent-ui

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
• Updated the test for the CheckboxWidget validating that the schema.title is passed as the label, fixing #3302
• Updated the theme to accept generic types, exporting generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072

@rjsf/material-ui

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
• Updated the test for the CheckboxWidget validating that the schema.title is passed as the label, fixing #3302
• Updated the theme to accept generic types, exporting generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072

@rjsf/mui

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
• Updated the test for the CheckboxWidget validating that the schema.title is passed as the label, fixing #3302
• Updated the theme to accept generic types, exporting generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072

@rjsf/semantic-ui

• Updated the usage of the ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
• Updated CheckboxWidget to get the required state of the checkbox from the schemaRequiresTrueValue() utility function rather than the required prop, fixing #3317
  • Also fixed the CheckboxWidget missing label issue #3302
• Updated the test for the CheckboxWidget validating that the schema.title is passed as the label, fixing #3302
• Updated the theme to accept generic types, exporting generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072

@rjsf/utils

• Updated the SubmitButtonProps and IconButtonProps to add required registry prop, fixing - #3314
• Updated the ArrayFieldTemplateItemType to add the new totalItems and canAdd props, fixing #3315
• Updated the CustomValidator and ErrorTransformer types to take the full set of T, S, F generics in order to accept a new optional uiSchema property, partially fixing #3170
• Updated the ValidatorType to add the F generic to allow the validateFormData() function to take a new optional uiSchema parameter, partially fixing #3170
  • Updated many of the schema-based utility functions to take the additional generics as well to fulfill the ValidatorType interface change

@rjsf/validator-ajv6

• Updated the customizeValidator and AJV6Validator implementations to add the S and F generics, so that validateFormData() can accept a new optional uiSchema parameter that is passed to transformErrors() and customValidate(), partially fixing #3170

@rjsf/validator-ajv8

• Updated the customizeValidator and AJV8Validator implementations to add the F generic, so that validateFormData() can accept a new optional uiSchema parameter that is passed to transformErrors() and customValidate(), partially fixing #3170

Dev / docs / playground

• Fixed the documentation for ArrayFieldItemTemplate, SubmitButtonProps and IconButtonProps as part of the fix for #3314 and #3315
• Updated the documentation in form-props.md for children, fixing #3322
• Added new typescript.md documentation to Advanced Customization describing how to use custom generics as part of the fix for #3072
• Updated the documentation in utilty-functions.md to add the new F generic to all the places which needed them