@rjsf/utils - npm Package Versions

6.0.0-beta.7

@rjsf/core

• Fixed crash in LayoutGridField when the 'name' field is missing in the grid schema for a component

6.0.0-beta.6

@rjsf/util

• Updated the Field type to add the optional TEST_IDS?: TestIdShape prop to it to support exposing the TEST_IDS static prop on LayoutGridField, LayoutHeaderField and LayoutMultiSchemaField for external users

6.0.0-beta.5

Dev / docs / playground

• Updated the peer dependencies for all packages from 6.0.0-beta to ^6.0.0-beta to avoid npm install dependency resolution issues

6.0.0-beta.4

Dev / docs / playground

• Updated the peer dependencies for all packages from 6 to 6.0.0-beta to avoid npm install dependency resolution issues

6.0.0-beta.3

Dev / docs / playground

• Updated the peer dependencies for all packages from ^6.0.0-beta.x to 6 to avoid npm install dependency resolution issues

6.0.0-beta.2

@rjsf/antd

• Updated DescriptionField to render the description using the RichDescription field

@rjsf/chakra-ui

• Updated DescriptionField to render the description using the RichDescription field

@rjsf/core

• Added new RichDescription component, refactored from SchemaField to support Rich Text descriptions in Markdown format
• Updated DescriptionField to render the description using the RichDescription field

@rjsf/daisyui

• Updated DescriptionField to render the description using the RichDescription field
• Updated FieldTemplate to move the checkbox implementation into the CheckboxWidget adding the description for checkboxes
• Updated package.json to make the package publishable
• Updated DaisyUIFrameProvider to extract the bulk of the code into DaisyUIFrameComponent to add a useEffect() with a cleanup to remove the tailwind styles

@rjsf/fluentui-rc

• Updated DescriptionField to render the description using the RichDescription field

@rjsf/mui

• Updated DescriptionField to render the description using the RichDescription field

@rjsf/react-bootstrap

• Updated DescriptionField to render the description using the RichDescription field
• Updated CheckboxField to remove the checkbox class that breaks the UI

@rjsf/semantic-ui

• Updated DescriptionField to render the description using the RichDescription field

@rjsf/shadcn

• Updated DescriptionField to render the description using the RichDescription field

@rjsf/utils

• Updated the description field in field props to be a string | ReactElement and added enableMarkdownInDescription to the GlobalUISchemaOptions interface
• Support for bundled JSON Schemas #4505
• Fixed issue with schema references in combinators(allOf, anyOf, oneOf) could not be modified when defaults were set, fixing #4555

Dev / docs / playground

• Updated the snapshot-tests to disable getTestId() for snapshots and updated the formTests.tsx to add tests for rich text descriptions for generic fields and the CheckboxWidget
• Updated the uiSchema.md to document new enableMarkdownInDescription prop
• Updated the playground to move daisyui theme choice after chakra-ui and to stop freezing the samples to avoid an AJV validation issue
  • Also removed validator from the examples.ts to fix #4605
• Added a playground example for bundled JSON Schemas

6.0.0-beta.1

@rjsf/antd

• BREAKING CHANGE: Refactored ArrayFieldItemTemplate to use the new ArrayFieldItemButtonsTemplate
• Updated the ArrayFieldTemplate, ObjectFieldTemplate, and WrapIfAdditionalTemplate to a unique id using the buttonId() function and adding consistent marker classes
• Implemented the GridTemplate component, adding it to the templates for the theme
• BREAKING CHANGE: Removed support for version 4 of antd
• Updated ArrayFieldItemTemplate to replace Button.Group with Space.Compact since Button.Group is deprecated in antd version 5
• Upgraded to @ant-design/icon@5
• BREAKING CHANGE: Removed the addition of Bootstrap 3 classes from the SchemaField and added rjsf- prefix to marker classes, thereby changing theme FieldTemplate className prop output and associated snapshots

@rjsf/chakra-ui

• BREAKING CHANGE: upgrade from v2 to v3
• BREAKING CHANGE: remove deprecated @chakra-ui/icon in favor of lucide-react
• BREAKING CHANGE: Refactored ArrayFieldItemTemplate to use the new ArrayFieldItemButtonsTemplate
• Updated the ArrayFieldTemplate, ObjectFieldTemplate, and WrapIfAdditionalTemplate to a unique id using the buttonId() function and adding consistent marker classes
• Implemented the GridTemplate component, adding it to the templates for the theme
• BREAKING CHANGE: Removed the addition of Bootstrap 3 classes from the SchemaField and added rjsf- prefix to marker classes, thereby changing theme FieldTemplate className prop output and associated snapshots

@rjsf/core

• BREAKING CHANGE: Updated ArrayField to provide the buttonsProps to the ArrayFieldItemTemplateType
• Added ArrayFieldItemButtonsTemplate component as a refactor of all the common buttons code from all the ArrayFieldItemTemplate implementations, adding a unique id using the buttonId() function
• Refactored ArrayFieldItemTemplate to use the new ArrayFieldItemButtonsTemplate
• Updated the ArrayFieldTemplate, ObjectFieldTemplate, and WrapIfAdditionalTemplate to a unique id using the buttonId() function and adding consistent marker classes
• Implemented the GridTemplate component, adding it to the templates for the theme
• Implemented the new LayoutGridField, LayoutMultiSchemaField and LayoutHeaderField fields, adding them to the fields list
• BREAKING CHANGE: Removed support for the deprecated schema.enumNames and uiSchema.classNames as well as the deprecated acceptcharset prop on Form
• BREAKING CHANGE: Moved the addition of Bootstrap 3 classes from the SchemaField to the WrapIfAdditionalTemplate, thereby affecting all the other themes, fixing #2280
• BREAKING CHANGE: Added rjsf- prefix onto the following marker classes used in the fields and templates:
  • field, field-<schema.type>, field-error, field-hidden, field-array, field-array-of-<schema.type>, field-array-fixed-items, array-item, config-error, array-item-add, array-item-copy, array-item-move-down, array-item-move-up, array-item-remove, object-property-expand
• Added support for patternProperties #1944

@rjsf/daisyui

• Added new theme!

@rjsf/fluent-ui

• BREAKING CHANGE: Deleted this theme in favor of fluentui-rc

@rjsf/fluentui-rc

• BREAKING CHANGE: Refactored ArrayFieldItemTemplate to use the new ArrayFieldItemButtonsTemplate
• Updated the ArrayFieldTemplate, ObjectFieldTemplate, and WrapIfAdditionalTemplate to a unique id using the buttonId() function and adding consistent marker classes
• Implemented the GridTemplate component, adding it to the templates for the theme
• BREAKING CHANGE: Removed the addition of Bootstrap 3 classes from the SchemaField and added rjsf- prefix to marker classes, thereby changing theme FieldTemplate className prop output and associated snapshots

@rjsf/material-ui

• BREAKING CHANGE: Deleted this theme in favor of mui

@rjsf/mui

• BREAKING CHANGE: Refactored ArrayFieldItemTemplate to use the new ArrayFieldItemButtonsTemplate
• Updated the ArrayFieldTemplate, ObjectFieldTemplate, and WrapIfAdditionalTemplate to a unique id using the buttonId() function and adding consistent marker classes
• Updated the theme to use Grid2 instead of the deprecated Grid
• Implemented the GridTemplate component, adding it to the templates for the theme
• BREAKING CHANGE: Removed the addition of Bootstrap 3 classes from the SchemaField and added rjsf- prefix to marker classes, thereby changing theme FieldTemplate className prop output and associated snapshots

@rjsf/semantic-ui

• BREAKING CHANGE: Refactored ArrayFieldItemTemplate to use the new ArrayFieldItemButtonsTemplate
• Updated the ArrayFieldTemplate, ObjectFieldTemplate, and WrapIfAdditionalTemplate to a unique id using the buttonId() function and adding consistent marker classes
• Implemented the GridTemplate component, adding it to the templates for the theme
• BREAKING CHANGE: Removed the addition of Bootstrap 3 classes from the SchemaField and added rjsf- prefix to marker classes, thereby changing theme FieldTemplate className prop output and associated snapshots
• BREAKING CHANGE: Removed support for the v1 version of semantic-ui-react

@rjsf/shadcn

• Added new theme!

@rjsf/utils

• BREAKING CHANGE: Refactored the ArrayFieldItemTemplateType to extract out all the button related props to ArrayFieldItemButtonsTemplateType, adding buttonsProps: ArrayFieldItemButtonsTemplateType as a new prop
  • Also created a deprecated alias type ArrayFieldTemplateItemType that points to ArrayFieldItemTemplateType for backwards compatibility
• Added new GridTemplateProps type
• BREAKING CHANGE: Added two the following new, required props to TemplatesType:
  • ArrayFieldItemButtonsTemplate: ComponentType<ArrayFieldItemButtonsTemplateType<T, S, F>>;
  • GridTemplate: ComponentType<GridTemplateProps>
• BREAKING CHANGE: Updated the SchemaUtilsType to add new validator-based functions to the interface
• Added the following new non-validator utility functions:
  • buttonId<T>(id: IdSchema<T> | string, btn: 'add' | 'copy' | 'moveDown' | 'moveUp' | 'remove'): used to generate consistent ids for RJSF buttons
  • getTestIds(): TestIdShape: Returns an object of test IDs that can only be used in test mode, helpful for writing unit tests for React components
  • hashObject(object: unknown): string: Stringifies an object and returns the hash of the resulting string
  • hashString(string: string): string: Hashes a string into hex format
  • lookupFromFormContext<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(regOrFc: Registry<T, S, F> | Registry<T, S, F>['formContext'], toLookup: string, fallback?: unknown): Given a React JSON Schema Form registry or formContext object, return the value associated with toLookup
• Added the following new validator-based utility functions:
  • findFieldInSchema<T = undefined, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, rootSchema: S, path: string | string[], schema: S, formData?: T, experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>): FoundFieldType<S>: Finds the field specified by the path within the root or recursed schema
  • findSelectedOptionInXxxOf<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, rootSchema: S, schema: S, fallbackField: string,xxx: 'anyOf' | 'oneOf', formData?: T, experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>): S | undefined: Finds the option that matches the selector field in the schema or undefined if nothing is selected
  • getFromSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, rootSchema: S, schema: S, path: string | string[], defaultValue: T | S, experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>): T | S: Helper that acts like lodash's get but additionally retrieves $refs as needed to get the path for schemas
• BREAKING CHANGE: Removed support for the deprecated schema.enumNames from getOptionsList() while switching the order of its generic types
• BREAKING CHANGE: Removed the deprecated getMatchingOption() and mergeValidationData() from the library export and the SchemaUtilsType interface
• BREAKING CHANGE: Removed the deprecated toErrorList() function from the ValidatorType interface
• BREAKING CHANGE: Removed the deprecated RJSF_ADDITONAL_PROPERTIES_FLAG constant
• Updated the WrapIfAdditionalTemplateProps to include hideError and rawErrors in support of moving Bootstrap 3 marker classes out of SchemaField
• Added support for patternProperties #1944
• Updated getTemplate() to allow per-field customization using string key from Registry, fixing #3695.
• Updated TemplatesType to allow for a string key to be used to reference a custom template in the Registry, fixing #3695
• Updated tests to cover the new getTemplate() functionality

@rjsf/validator-ajv6

• BREAKING CHANGE: This deprecated validator has been removed

@rjsf/validator-ajv8

• BREAKING CHANGE: Removed the implementation of the deprecated toErrorList() function from the validator implementations

Dev / docs / playground

• Updated the playground to Chakra UI v3
• Updated the playground to remove fluent-ui theme
• Updated the custom-templates.md documentation for the changes to the ArrayFieldTemplateItem and add the two new templates
• Updated the utility-functions.md documentation to add the buttonId() function
• Added the v6.x upgrade guide.md documentation
• Updated the playground to add a Layout Grid example and made the selected example now be part of the shared export
• Replaced Lerna with Nx, updated all lerna commands to use the Nx CLI
• BREAKING CHANGE: Updated all peerDependencies to change minimal React support to >=18
• Added documentation and playground example for patternProperties
• Updated advanced-customization/custom-templates with the new feature.

5.24.10

Dev / docs / playground

• Updated all package.json files in the packages directories to remove the exports blocks, fixing #4537

5.24.9

@rjsf/antd

• Fixed ts errors in newer antd versions #4525

@rjsf/chakra-ui

• Restricted the chakra-react-select peerDependency to <6.0.0, fixing #4539

@rjsf/core

• Do not display input field in MultiSchemaField with null type

@rjsf/mui

• Fixed issue in BaseInputTemplate where input props were passed to slotProps.htmlInput, which does not work in MUI v5.

@rjsf/utils

• Fixed issue with schema combinators(allOf, anyOf, oneOf) could not be modified when defaults were set, fixing #4555

Dev / docs / playground

• Updated docs for ArrayFieldItemTemplate to include prop onCopyIndexClick, fixing #4507
• Use antd 5 in playground
• Updated docs to clarify that errors raised within a widget are not caught during form validation
• Updated docs where objects typed as RJSFValidationError were not valid (#4558)