@rjsf/core 5.1.0 → 5.2.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import React, { Component } from 'react';
-import { StrictRJSFSchema, RJSFSchema, FormContextType, ValidatorType, UiSchema, RegistryFieldsType, TemplatesType, RegistryWidgetsType, RJSFValidationError, CustomValidator, ErrorSchema, ErrorTransformer, IdSchema, SchemaUtilsType, ValidationData, Registry, PathSchema } from '@rjsf/utils';
+import { ReactNode, FormEvent, ElementType, Ref, Component, RefObject, ComponentType } from 'react';
+import { StrictRJSFSchema, RJSFSchema, FormContextType, ValidatorType, UiSchema, RegistryFieldsType, TemplatesType, RegistryWidgetsType, RJSFValidationError, CustomValidator, ErrorSchema, ErrorTransformer, Registry, IdSchema, SchemaUtilsType, ValidationData, PathSchema } from '@rjsf/utils';
 
 /** The properties that are passed to the `Form` */
 interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> {
@@ -8,7 +8,7 @@ interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     /** An implementation of the `ValidatorType` interface that is needed for form validation to work */
     validator: ValidatorType<T, S, F>;
     /** The optional children for the form, if provided, it will replace the default `SubmitButton` */
-    children?: React.ReactNode;
+    children?: ReactNode;
     /** The uiSchema for the form */
     uiSchema?: UiSchema<T, S, F>;
     /** The data for the form, used to prefill a form with existing data */
@@ -40,8 +40,8 @@ interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     /** The dictionary of registered fields in the form */
     fields?: RegistryFieldsType<T, S, F>;
     /** The dictionary of registered templates in the form; Partial allows a subset to be provided beyond the defaults */
-    templates?: Partial<Omit<TemplatesType<T, S, F>, "ButtonTemplates">> & {
-        ButtonTemplates?: Partial<TemplatesType<T, S, F>["ButtonTemplates"]>;
+    templates?: Partial<Omit<TemplatesType<T, S, F>, 'ButtonTemplates'>> & {
+        ButtonTemplates?: Partial<TemplatesType<T, S, F>['ButtonTemplates']>;
     };
     /** The dictionary of registered widgets in the form */
     widgets?: RegistryWidgetsType<T, S, F>;
@@ -58,7 +58,7 @@ interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
      * and its data are valid. It will be passed a result object having a `formData` attribute, which is the valid form
      * data you're usually after. The original event will also be passed as a second parameter
      */
-    onSubmit?: (data: IChangeEvent<T, S, F>, event: React.FormEvent<any>) => void;
+    onSubmit?: (data: IChangeEvent<T, S, F>, event: FormEvent<any>) => void;
     /** Sometimes you may want to trigger events or modify external state when a field has been touched, so you can pass
      * an `onBlur` handler, which will receive the id of the input that was blurred and the field value
      */
@@ -92,7 +92,7 @@ interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
      * nesting forms. However, native browser form behaviour, such as submitting when the `Enter` key is pressed, may no
      * longer work
      */
-    tagName?: React.ElementType;
+    tagName?: ElementType;
     /** The value of this prop will be passed to the `target` HTML attribute on the form */
     target?: string;
     /** Formerly the `validate` prop; Takes a function that specifies custom validation rules for the form */
@@ -123,7 +123,7 @@ interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     /** When this prop is set to `top` or 'bottom', a list of errors (or the custom error list defined in the `ErrorList`) will also
      * show. When set to false, only inline input validation errors will be shown. Set to `top` by default
      */
-    showErrorList?: false | "top" | "bottom";
+    showErrorList?: false | 'top' | 'bottom';
     /** A function can be passed to this prop in order to make modifications to the default errors resulting from JSON
      * Schema validation
      */
@@ -131,6 +131,12 @@ interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     /** If set to true, then the first field with an error will receive the focus when the form is submitted with errors
      */
     focusOnFirstError?: boolean;
+    /** Optional string translation function, if provided, allows users to change the translation of the RJSF internal
+     * strings. Some strings contain replaceable parameter values as indicated by `%1`, `%2`, etc. The number after the
+     * `%` indicates the order of the parameter. The ordering of parameters is important because some languages may choose
+     * to put the second parameter before the first in its translation.
+     */
+    translateString?: Registry['translateString'];
     /**
      * _internalFormWrapper is currently used by the semantic-ui theme to provide a custom wrapper around `<Form />`
      * that supports the proper rendering of those themes. To use this prop, one must pass a component that takes two
@@ -146,10 +152,10 @@ interface FormProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
      *
      * Use at your own risk as this prop is private and may change at any time without notice.
      */
-    _internalFormWrapper?: React.ElementType;
+    _internalFormWrapper?: ElementType;
     /** Support receiving a React ref to the Form
      */
-    ref?: React.Ref<Form<T, S, F>>;
+    ref?: Ref<Form<T, S, F>>;
 }
 /** The data that is contained within the state for the `Form` */
 interface FormState<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> {
@@ -181,16 +187,16 @@ interface FormState<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
 /** The event data passed when changes have been made to the form, includes everything from the `FormState` except
  * the schema validation errors. An additional `status` is added when returned from `onSubmit`
  */
-interface IChangeEvent<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends Omit<FormState<T, S, F>, "schemaValidationErrors" | "schemaValidationErrorSchema"> {
+interface IChangeEvent<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends Omit<FormState<T, S, F>, 'schemaValidationErrors' | 'schemaValidationErrorSchema'> {
     /** The status of the form when submitted */
-    status?: "submitted";
+    status?: 'submitted';
 }
 /** The `Form` component renders the outer form and all the fields defined in the `schema` */
 declare class Form<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends Component<FormProps<T, S, F>, FormState<T, S, F>> {
     /** The ref used to hold the `form` element, this needs to be `any` because `tagName` or `_internalFormWrapper` can
      * provide any possible type here
      */
-    formElement: React.RefObject<any>;
+    formElement: RefObject<any>;
     /** Constructs the `Form` from the `props`. Will setup the initial state from the props. It will also call the
      * `onChange` handler if the initially provided `formData` is modified to add missing default values as part of the
      * state construction.
@@ -277,7 +283,7 @@ declare class Form<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends F
      *
      * @param event - The submit HTML form event
      */
-    onSubmit: (event: React.FormEvent<any>) => void;
+    onSubmit: (event: FormEvent<any>) => void;
     /** Returns the registry for the form */
     getRegistry(): Registry<T, S, F>;
     /** Provides a function that can be used to programmatically submit the `Form` */
@@ -304,14 +310,14 @@ declare class Form<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends F
 /** The properties for the `withTheme` function, essentially a subset of properties from the `FormProps` that can be
  * overridden while creating a theme
  */
-type ThemeProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Pick<FormProps<T, S, F>, "fields" | "templates" | "widgets" | "_internalFormWrapper">;
+type ThemeProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Pick<FormProps<T, S, F>, 'fields' | 'templates' | 'widgets' | '_internalFormWrapper'>;
 /** A Higher-Order component that creates a wrapper around a `Form` with the overrides from the `WithThemeProps` */
-declare function withTheme<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(themeProps: ThemeProps<T, S, F>): React.ComponentType<FormProps<T, S, F>>;
+declare function withTheme<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(themeProps: ThemeProps<T, S, F>): ComponentType<FormProps<T, S, F>>;
 
 /** The default registry consists of all the fields, templates and widgets provided in the core implementation,
  * plus an empty `rootSchema` and `formContext. We omit schemaUtils here because it cannot be defaulted without a
  * rootSchema and validator. It will be added into the computed registry later in the Form.
  */
-declare function getDefaultRegistry<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(): Omit<Registry<T, S, F>, "schemaUtils">;
+declare function getDefaultRegistry<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(): Omit<Registry<T, S, F>, 'schemaUtils'>;
 
 export { FormProps, FormState, IChangeEvent, ThemeProps, Form as default, getDefaultRegistry, withTheme };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/core",
-  "version": "5.1.0",
+  "version": "5.2.1",
   "description": "A simple React component capable of building HTML forms out of a JSON schema.",
   "scripts": {
     "build": "rimraf dist && dts build --rollupTypes --format cjs,esm,umd",
@@ -39,6 +39,7 @@
   "dependencies": {
     "lodash": "^4.17.15",
     "lodash-es": "^4.17.15",
+    "markdown-to-jsx": "^7.1.9",
     "nanoid": "^3.3.4",
     "prop-types": "^15.7.2"
   },
@@ -52,9 +53,9 @@
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-react": "^7.18.6",
     "@babel/register": "^7.18.9",
-    "@rjsf/utils": "^5.1.0",
-    "@rjsf/validator-ajv6": "^5.1.0",
-    "@rjsf/validator-ajv8": "^5.1.0",
+    "@rjsf/utils": "^5.2.1",
+    "@rjsf/validator-ajv6": "^5.2.1",
+    "@rjsf/validator-ajv8": "^5.2.1",
     "@types/lodash": "^4.14.191",
     "@types/react": "^17.0.39",
     "@types/react-dom": "^17.0.11",
@@ -93,5 +94,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6befd6731723b59564631f0475941403ec1c6fd2"
+  "gitHead": "461f74b2f51c17e1cdaa327f63ef0fd88060fde0"
 }