@rjsf/utils - npm Package Versions

5.7.0

@rjsf/antd

• Fix #3608 by ensuring the root field is always wrapped in Form.Item
• Fix #3594 by removing the duplicate title for SelectWidget and description for CheckboxWidget

@rjsf/core

• Updated the MultiSchemaField to use the new getDiscriminatorFieldFromSchema() API
• Added new experimental_defaultFormStateBehavior prop to Form
  • to specify alternate behavior when dealing with the rendering of array fields where minItems is set but field is not required (fixes #3363) (#3602)
  • to handle setting object defaults based on the value of emptyObjectFields supporting required fields only and skipping defaults entirely, fixing #2980
• Fixed regression #3650 in FileWidget to again support adding multiple files to arrays

@rjsf/fluent-ui

• Added support for additionalProperties to fluent-ui theme, fixing #2777.
• Upgraded to 8.x version of @fluentui/react maintaining backwards compatibility to version 7, fixing #3463

@rjsf/utils

• Added two new APIs getDiscriminatorFieldFromSchema() (a refactor of code from MultiSchemaField) and hashForSchema()
  • Updated getDefaultFormState() and toPathSchema() to use getDiscriminatorFieldFromSchema() to provide a discriminator field to getClosestMatchingOption() calls.
• Refactored the retrieveSchema() internal API functions to support implementing an internal schemaParser() API for use in precompiling schemas, in support of #3543
• Fixed toPathSchema() to handle properties in an object along with anyOf/oneOf, fixing #3628 and #1628
• Refactored optional parameters for computeDefaults() into destructured props object to reduce clutter when only specifying later of the optional argument, fixing #3602
• Fixed computeDefaults() to handle $ref in an object along with anyOf/oneOf, fixing #3633

@rjsf/validator-ajv8

• Added two new APIs compileSchemaValidators() and createPrecompiledValidator() implemented to support using precompiled validators build with AJV 8, fixing #3543

Dev / docs / playground

• Added documentation to custom-templates describing how to extend the BaseInputTemplate
• Added minItems behavior for array field live setting, fixing #3602
• Upgraded playground to 8.x version of @fluentui/react, fixing #3463
• Added documentation to validation describing the new precompiled validators feature
• Added new validator-ajv8.md documentation to the api-reference directory as well as putting it into the sidebar.js

5.6.2

Dev / docs / playground

• Fixed issues with post-versioning that caused the 5.6.1 branch to not be publishable

5.6.0

@rjsf/antd

• Treat multiple as a boolean rather than comparing against undefined in the SelectWidget, fixing #3595

@rjsf/core

• Switched Form to use the new validatorDataMerge() and toErrorList() functions instead of the now deprecated schemaUtils.mergeValidatorData() and schemaUtils.getValidator().toErrorList()
• Added option to provide a callback function to focusOnFirstError (3590)
• Updated MultiSchemaField to handle the OpenAPI discriminator extension on anyOf/oneOf fields by passing it into getClosestMatchingOption() if it exists, fixing #3512
• Updated SchemaField function to use getSchemaType rather than schema.type to set the proper class name.

@rjsf/utils

• Refactored the createErrorHandler(), toErrorList(), toErrorSchema() and unwrapErrorHandler() functions from the @rjsf/validator-ajv6 and @rjsf/validator-ajv8 implementations since they were identical
  • As a result, the mergeValidationData() function was deprecated in favor of the new validationDataMerge() function that uses the refactored toErrorList() function
  • Refactored the ROOT_SCHEMA_PREFIX constant as well
• Updated ValidatorType and SchemaUtilsType to deprecate the toErrorList() and mergeValidationData() functions, respectively
• Updated the getClosestMatchingOption() and getFirstMatchingOption() to pass the new discriminatorField to the getMatchingOption() function
• Updated getMatchingOption() to use discriminatorField when it is present in the options object properties to drill into the object to detect if that one field is valid
• Updated SchemaUtilsType and the associated forward functions in createSchemaUtils to add the new discriminatorField?: string optional parameter
• Updated toIdSchema() function to use getSchemaType(schema) === 'object' rather than schema.type === 'object' to get the proper pathing for ids, fixing #2044

@rjsf/validator-ajv6

• Removed the refactored functions and constant from the AJV6Validator in favor of using the new functions and constant from @rjsf/utils

@rjsf/validator-ajv8

• Removed the refactored functions and constant from the AJV8Validator in favor of using the new functions and constant from @rjsf/utils

Dev / docs / playground

• Updated the utility-functions documentation to describe the new refactored functions as well as deprecating the mergeValidationData() function
• Updated the playground to properly restore liveSettings from shared links and added a switch for noHtml5Validation in the live settings rather than having it set to true always
  • Also added a new Blank example to help users easily paste their code

5.5.2

@rjsf/material-ui

• Switched to using TextField for the WrapIfAdditionalTemplate label key input to match the @rjsf/mui fix

@rjsf/mui

• Switched to using TextField for the WrapIfAdditionalTemplate label key input, fixing #3578

Dev / docs / playground

• Updated the templates passed into the main Form to not include undefined values, fixing #3576 and #3579

5.5.1

@rjsf/core

• Updated Form to include the top disabled property in the ui:submitButtonOptions so the submit button will be disabled when the whole form is disabled. Fixes #3264.

@rjsf/utils

• Added protections against infinite recursion of $refs for the toIdSchema(), toPathSchema() and getDefaultFormState() functions, fixing #3560
• Updated getDefaultFormState() to handle object-based additionalProperties with defaults using formData in addition to values contained in a default object, fixing #2593
• Updated internal helper withExactlyOneSubschema() inside of retrieveSchema() to use the isValid() function rather than validateFormData() when determining the one-of branch

Dev / docs / playground

• Refactored some parts of playground to make it cleaner
  • This includes fixing the spelling of the disabled flag being passed into the Form from the incorrect disable spelling
• Formatted the entire monorepo which included 6 unformatted files outside of playground
• Removed react-app-polyfill package from playgound. This ends IE11 support
• Fix a handful of broken docs links, fixing #3553

5.5.0

@rjsf/antd

• Updated tests to use centralized snapshots from core

@rjsf/bootstrap-4

• Updated tests to use centralized snapshots from core

@rjsf/chakra-ui

• Updated tests to use centralized snapshots from core

@rjsf/core

• Updated FileWidget to pass false for required once a value has been specified, fixing #3504
• Updated ObjectField to pass the errorSchema to the ObjectFieldTemplate to allow custom templates access to the errors
• Centralized snapshot tests from each theme into core, adding snapshots tests for core as well

@rjsf/fluent-ui

• Updated tests to use centralized snapshots from core

@rjsf/material-ui

• Updated tests to use centralized snapshots from core

@rjsf/mui

• Updated tests to use centralized snapshots from core

@rjsf/semantic-ui

• Updated tests to use centralized snapshots from core

@rjsf/utils

• Added errorSchema as an optional prop on ObjectFieldTemplateProps

Dev / docs / playground

• Converted the playground to use Typescript, including some refactoring of code to make that job easier
• Updated the custom-templates documentation to add errorSchema to the props for ObjectFieldTemplate

5.4.0

@rjsf/antd

• Added the ability to use a tooltip for a description
• Updated ObjectFieldTemplate to hide the titles and descriptions when displayLabel is true (including globally), fixing #3231
• Updated CheckboxWidget to show the description using the DescriptionFieldTemplate, fixing #2791
• Updated CheckboxesWidget and SelectWidget to show the label using the TitleFieldTemplate, fixing #2134

@rjsf/bootstrap-4

• Updated ObjectFieldTemplate to hide the titles and descriptions when displayLabel is true (including globally), fixing #3231
• Updated CheckboxWidget to show the description using the DescriptionFieldTemplate, fixing #2791
• Updated RangeWidget to fix the label hiding bug using labelValue()

@rjsf/chakra-ui

• Fix: MUI radio widget initializes as uncontrolled when schema has no default value, fixing #3511
• Updated ObjectFieldTemplate to hide the titles and descriptions when displayLabel is true (including globally), fixing #3231
• Updated CheckboxesWidget, CheckboxWidget, RadioWidget and SelectWidget to hide labels when hideLabel is true using the new labelValue() helper (including globally)
• Updated CheckboxWidget to show the description using the DescriptionFieldTemplate, fixing #2791

@rjsf/core

• Updated FileWidget to show a preview of images and a download link for non-images when the filePreview options is set to true in the UiSchema
• Updated ArrayField, BooleanField, MultiSelectField and StringField to pass label (read from uiSchema.title || schema.title || name) and hideLabel down to all of the Widgets they render, fixing #827, #2636, #2399 and #3531
• Updated ObjectField, ObjectFieldTemplate, ArrayFieldDescriptionTemplate, ArrayFieldTitleTemplate and CheckboxWidget to hide the titles and descriptions when hideLabel is true using the new labelValue() helper (including globally), fixing #3231
• Updated CheckboxWidget to use the labelValue() function for hiding labels

@rjsf/fluent-ui

• Updated FieldTemplate and ObjectFieldTemplate to hide the titles and descriptions when displayLabel is true (including globally), fixing #3231
• Updated BaseInputTemplate, CheckboxesWidget, CheckboxWidget, ColorWidget, DateWidget, RadioWidget, RangeWidget, SelectWidget and UpDownWidget to hide labels when hideLabel is true using the new labelValue() helper (including globally)
  • Also extracted a new FluentLabel component out of CheckboxesWidget, ColorWidget, RangeWidget and UpDownWidget
• Updated CheckboxWidget to show the description using the DescriptionFieldTemplate, fixing #2791

@rjsf/material-ui

• Fix: MUI radio widget initializes as uncontrolled when schema has no default value, fixing #3511
• Updated ObjectFieldTemplate to hide the titles and descriptions when displayLabel is true (including globally), fixing #3231
• Updated BaseInputTemplate, CheckboxesWidget, CheckboxWidget, RadioWidget, RangeWidget and SelectWidget to hide labels when hideLabel is true using the new labelValue() helper (including globally)
• Updated CheckboxWidget to show the description using the DescriptionFieldTemplate, fixing #2791

@rjsf/mui

• Fix: MUI radio widget initializes as uncontrolled when schema has no default value, fixing #3511
• Updated ObjectFieldTemplate to hide the titles and descriptions when displayLabel is true (including globally), fixing #3231
• Updated BaseInputTemplate, CheckboxesWidget, CheckboxWidget, RadioWidget, RangeWidget and SelectWidget to hide labels when hideLabel is true using the new labelValue() helper (including globally)
• Updated CheckboxWidget to show the description using the DescriptionFieldTemplate, fixing #2791

@rjsf/semantic-ui

• Updated ObjectFieldTemplate to hide the titles and descriptions when displayLabel is true (including globally), fixing #3231
• Updated BaseInputTemplate, CheckboxesWidget, CheckboxWidget, SelectWidget and TextareaWidget to hide labels when hideLabel is true using the new labelValue() helper (including globally)
• Updated CheckboxWidget to show the description using the DescriptionFieldTemplate, fixing #2791

@rjsf/utils

• Updated the UiSchema to support the optional filePreview?: boolean option and to add a new TranslatableString.PreviewLabel to the enums
• Updated the WidgetProps to add an optional hideLabel?: boolean field to better support hiding labels
• Added a new labelValue() helper function to better support hiding labels

@rjsf/validator-ajv8

• Improve toErrorList() and unwrapErrorHandler() by ensuring objects before recursing

Dev / docs / playground

• Added a new AntD Customization documentation with references to it in the form-props and uiSchema documentation
• Updated the uiSchema documentation to add the filePreview option
• Updated the widgets documentation to add the new, optional hideLabel prop
• Updated the utility-functions documentation to add the new labelValue() function

5.3.1

@rjsf/core

• Updated AltDateWidget to remove an infinite loop caused by two conflicting effects by merging them with additional checking of original value against the current value, fixing #3516

@rjsf/utils

• Updated the documentation of getTestValidator() and the schema.test.ts file to help developers

@rjsf/validator-ajv6

• Updated the documentation of getTestValidator() and the schema.test.ts file to help developers

@rjsf/validator-ajv8

• Updated the documentation of getTestValidator() and the schema.test.ts file to help developers

Dev / docs / playground

• Updated the internals documentation to use a React ref in the example, fixing #3520
• Updated the contributing documentation to describe the new development process needed for a Vite playground, fixing #3478
  • Also fixed the package.json files to remove npm start in the subdirectories and change the root one to describe the new process
• Updated the semantic-ui/uiSchema documentation to switch the default for horizontalButtons to be true per changes made in 5.3.0

5.3.0

@rjsf/antd

• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712
• Fixed package.json to properly add required dependencies explicitly which were installed implicitly

@rjsf/bootstrap-4

• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712

@rjsf/chakra-ui

• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712

@rjsf/core

• Reset function added for Programmatically Reset action. Reset function will reset form data and validation errors. Form data will set to default values.
• Implemented a new TimeWidget that works for all themes
• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712
• Also added the missing translation for the InvalidObjectField error in ObjectField
• Added support for the handling of the global UiSchema options in Form, ArrayField, ObjectField and SchemaField

@rjsf/fluent-ui

• Fix RadioWidget's onChange return value.
• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712

@rjsf/material-ui

• Updated BaseInputTemplate so that it shrinks a time formatted input
• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712

@rjsf/mui

• Updated BaseInputTemplate so that it shrinks a time formatted input
• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712

@rjsf/semantic-ui

• Added support to make a copy of an array item directly after the item selected to be copied (feature is off by default), fixing #1261 and #1712

@rjsf/utils

• Updated the widget matrix used by getWidget() to support the time to TimeWidget mapping
• Added a new TranslatableString enums CopyButton and InvalidObjectField that localizes the information extracted from ObjectField as markdown
• Updated the ArrayFieldTemplateItemType to add support for copying array items
• Refactored UIOptionsBaseType to extract the addable, orderable, removable, label and duplicateKeySuffixSeparator into a new GlobalUISchemaOptions type that adds copyable
  • Extended UIOptionsBaseType from GlobalUISchemaOptions
  • In UiSchema added a new optional ui:globalOptions prop of type GlobalUISchemaOptions and a new UI_GLOBAL_OPTIONS_KEY constant
  • Added a new optional prop globalUiOptions object of type GlobalUISchemaOptions in Registry as well as CopyButton in ButtonTemplates
• Updated getUiOptions() and getDisplayLabel() (and its SchemaUtilsType counterpart) to take an optional GlobalUISchemaOptions parameter that is used to include global options into the returned uiOptions

Dev / docs / playground

• Updated the playground to add a Programmatically Reset button to clear states which are form data and validation errors.
• Updated the Date & time example to show off the new TimeWidget.
• Updated the custom-widgets-fields and widgets documentation to mention the new TimeWidget and its support for the time format.
• Updated the documentation for custom-templates, internals, uiSchema, utility-functions and arrays for the new copy array feature as well as the global UI Schema options support
• Updated the arrays example to add examples for the new copyable feature

5.2.1

@rjsf/antd

• Updated BaseInputTemplate to favor the special onChangeOverride provided by the core FileWidget
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/bootstrap-4

• Updated BaseInputTemplate to favor the special onChangeOverride provided by the core FileWidget, deleting the theme's FileWidget, fixing #2095
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/chakra-ui

• Updated BaseInputTemplate to favor the special onChangeOverride provided by the core FileWidget
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/core

• Ensure that name is consistently passed to all Widgets through the field components, fixing #1763
• Updated the FileWidget to render the input using the BaseInputTemplate passing a special onChangeOverride function to deal with the file events, fixing #2095
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/fluent-ui

• Updated BaseInputTemplate to favor the special onChangeOverride provided by the core FileWidget
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/material-ui

• Updated BaseInputTemplate to favor the special onChangeOverride provided by the core FileWidget and to support automatically shrinking the label for the date, datetime-local and file types
  • Removed the DateWidget and DateTimeWidget since they were only created to provide the label shrinking property
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/mui

• Updated BaseInputTemplate to favor the special onChangeOverride provided by the core FileWidget and to support automatically shrinking the label for the date, datetime-local and file types
  • Removed the DateWidget and DateTimeWidget since they were only created to provide the label shrinking property
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/semantic-ui

• Updated BaseInputTemplate to favor the special onChangeOverride provided by the core FileWidget
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

@rjsf/utils

• Added the name prop to the WidgetProps type, fixing #1763
• Fixed dataURItoBlob() to handle the exception thrown by atob() when it is passed a malformed URL, returning an blob that indicates the error in the type prop
• Fixed replaceStringParameters() to improve the replaceable parameters logic so that it works properly when a parameter also contains a replaceable parameter identifier
• Removed explicit import of React, switching imports to explicit ones after fixing linting rules to not require React for JSX

Dev / docs / playground

• Updated the custom-widgets-fields documentation to ensure the new WidgetProps name prop is documented
• Added Algolia DocSearch to the documentation site