@rjsf/utils 5.2.0 → 5.3.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import React, { StyleHTMLAttributes } from 'react';
+import React, { ReactElement, ComponentType, HTMLAttributes, StyleHTMLAttributes, ReactNode, ChangeEvent, ButtonHTMLAttributes } from 'react';
 import * as json_schema from 'json-schema';
 import { JSONSchema7 } from 'json-schema';
 
@@ -27,6 +27,8 @@ declare enum TranslatableString {
     AddButton = "Add",
     /** Add button title, used by AddButton */
     AddItemButton = "Add Item",
+    /** Copy button title, used by IconButton */
+    CopyButton = "Copy",
     /** Move down button title, used by IconButton */
     MoveDownButton = "Move down",
     /** Move up button title, used by IconButton */
@@ -53,6 +55,8 @@ declare enum TranslatableString {
     TitleOptionPrefix = "%1 option %2",
     /** Key label, where %1 will be replaced by the label as provided by WrapIfAdditionalTemplate */
     KeyLabel = "%1 Key",
+    /** Invalid object field configuration as provided by the ObjectField */
+    InvalidObjectField = "Invalid \"%1\" object field configuration: <em>%2</em>.",
     /** Unsupported field schema, used by UnsupportedField */
     UnsupportedField = "Unsupported field schema.",
     /** Unsupported field schema, where %1 will be replaced by the idSchema.$id as provided by UnsupportedField */
@@ -110,13 +114,13 @@ type RangeSpecType = {
     max?: number;
 };
 /** Properties describing a Range specification in terms of attribute that can be added to the `HTML` `<input>` */
-type InputPropsType = Omit<RangeSpecType, "step"> & {
+type InputPropsType = Omit<RangeSpecType, 'step'> & {
     /** Specifies the type of the <input> element */
     type: string;
     /** Specifies the interval between legal numbers in an input field or "any" */
-    step?: number | "any";
+    step?: number | 'any';
     /** Specifies the `autoComplete` value for an <input> element */
-    autoComplete?: HTMLInputElement["autocomplete"];
+    autoComplete?: HTMLInputElement['autocomplete'];
 };
 /** Type describing an id used for a field in the `IdSchema` */
 type FieldId = {
@@ -198,7 +202,7 @@ type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     /** The errorSchema constructed by `Form` */
     errorSchema?: ErrorSchema<T>;
     /** An array of the errors */
-    errors?: Array<string | React.ReactElement>;
+    errors?: Array<string | ReactElement>;
     /** The tree of unique ids for every child field */
     idSchema: IdSchema<T>;
     /** The schema that was passed to field */
@@ -211,7 +215,7 @@ type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
 /** The properties that are passed to an `FieldHelpTemplate` implementation */
 type FieldHelpProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The help information to be rendered */
-    help?: string | React.ReactElement;
+    help?: string | ReactElement;
     /** The tree of unique ids for every child field */
     idSchema: IdSchema<T>;
     /** The schema that was passed to field */
@@ -236,47 +240,68 @@ type RegistryWidgetsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ext
 /** The set of RJSF templates that can be overridden by themes or users */
 interface TemplatesType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> {
     /** The template to use while rendering normal or fixed array fields */
-    ArrayFieldTemplate: React.ComponentType<ArrayFieldTemplateProps<T, S, F>>;
+    ArrayFieldTemplate: ComponentType<ArrayFieldTemplateProps<T, S, F>>;
     /** The template to use while rendering the description for an array field */
-    ArrayFieldDescriptionTemplate: React.ComponentType<ArrayFieldDescriptionProps<T, S, F>>;
+    ArrayFieldDescriptionTemplate: ComponentType<ArrayFieldDescriptionProps<T, S, F>>;
     /** The template to use while rendering an item in an array field */
-    ArrayFieldItemTemplate: React.ComponentType<ArrayFieldTemplateItemType<T, S, F>>;
+    ArrayFieldItemTemplate: ComponentType<ArrayFieldTemplateItemType<T, S, F>>;
     /** The template to use while rendering the title for an array field */
-    ArrayFieldTitleTemplate: React.ComponentType<ArrayFieldTitleProps<T, S, F>>;
+    ArrayFieldTitleTemplate: ComponentType<ArrayFieldTitleProps<T, S, F>>;
     /** The template to use while rendering the standard html input */
-    BaseInputTemplate: React.ComponentType<WidgetProps<T, S, F>>;
+    BaseInputTemplate: ComponentType<BaseInputTemplateProps<T, S, F>>;
     /** The template to use for rendering the description of a field */
-    DescriptionFieldTemplate: React.ComponentType<DescriptionFieldProps<T, S, F>>;
+    DescriptionFieldTemplate: ComponentType<DescriptionFieldProps<T, S, F>>;
     /** The template to use while rendering the errors for the whole form */
-    ErrorListTemplate: React.ComponentType<ErrorListProps<T, S, F>>;
+    ErrorListTemplate: ComponentType<ErrorListProps<T, S, F>>;
     /** The template to use while rendering the errors for a single field */
-    FieldErrorTemplate: React.ComponentType<FieldErrorProps<T, S, F>>;
+    FieldErrorTemplate: ComponentType<FieldErrorProps<T, S, F>>;
     /** The template to use while rendering the errors for a single field */
-    FieldHelpTemplate: React.ComponentType<FieldHelpProps<T, S, F>>;
+    FieldHelpTemplate: ComponentType<FieldHelpProps<T, S, F>>;
     /** The template to use while rendering a field */
-    FieldTemplate: React.ComponentType<FieldTemplateProps<T, S, F>>;
+    FieldTemplate: ComponentType<FieldTemplateProps<T, S, F>>;
     /** The template to use while rendering an object */
-    ObjectFieldTemplate: React.ComponentType<ObjectFieldTemplateProps<T, S, F>>;
+    ObjectFieldTemplate: ComponentType<ObjectFieldTemplateProps<T, S, F>>;
     /** The template to use for rendering the title of a field */
-    TitleFieldTemplate: React.ComponentType<TitleFieldProps<T, S, F>>;
+    TitleFieldTemplate: ComponentType<TitleFieldProps<T, S, F>>;
     /** The template to use for rendering information about an unsupported field type in the schema */
-    UnsupportedFieldTemplate: React.ComponentType<UnsupportedFieldProps<T, S, F>>;
+    UnsupportedFieldTemplate: ComponentType<UnsupportedFieldProps<T, S, F>>;
     /** The template to use for rendering a field that allows a user to add additional properties */
-    WrapIfAdditionalTemplate: React.ComponentType<WrapIfAdditionalTemplateProps<T, S, F>>;
+    WrapIfAdditionalTemplate: ComponentType<WrapIfAdditionalTemplateProps<T, S, F>>;
     /** The set of templates associated with buttons in the form */
     ButtonTemplates: {
         /** The template to use for the main `Submit` button  */
-        SubmitButton: React.ComponentType<SubmitButtonProps<T, S, F>>;
+        SubmitButton: ComponentType<SubmitButtonProps<T, S, F>>;
         /** The template to use for the Add button used for AdditionalProperties and Array items */
-        AddButton: React.ComponentType<IconButtonProps<T, S, F>>;
+        AddButton: ComponentType<IconButtonProps<T, S, F>>;
+        /** The template to use for the Copy button used for Array items */
+        CopyButton: ComponentType<IconButtonProps<T, S, F>>;
         /** The template to use for the Move Down button used for Array items */
-        MoveDownButton: React.ComponentType<IconButtonProps<T, S, F>>;
+        MoveDownButton: ComponentType<IconButtonProps<T, S, F>>;
         /** The template to use for the Move Up button used for Array items */
-        MoveUpButton: React.ComponentType<IconButtonProps<T, S, F>>;
+        MoveUpButton: ComponentType<IconButtonProps<T, S, F>>;
         /** The template to use for the Remove button used for AdditionalProperties and Array items */
-        RemoveButton: React.ComponentType<IconButtonProps<T, S, F>>;
+        RemoveButton: ComponentType<IconButtonProps<T, S, F>>;
     };
 }
+/** The set of UiSchema options that can be set globally and used as fallbacks at an individual template, field or
+ * widget level when no field-level value of the option is provided.
+ */
+type GlobalUISchemaOptions = {
+    /** Flag, if set to `false`, new items cannot be added to array fields, unless overridden (defaults to true) */
+    addable?: boolean;
+    /** Flag, if set to `true`, array items can be copied (defaults to false) */
+    copyable?: boolean;
+    /** Flag, if set to `false`, array items cannot be ordered (defaults to true) */
+    orderable?: boolean;
+    /** Flag, if set to `false`, array items will not be removable (defaults to true) */
+    removable?: boolean;
+    /** Field labels are rendered by default. Labels may be omitted by setting the `label` option to `false` */
+    label?: boolean;
+    /** When using `additionalProperties`, key collision is prevented by appending a unique integer to the duplicate key.
+     * This option allows you to change the separator between the original key name and the integer. Default is "-"
+     */
+    duplicateKeySuffixSeparator?: string;
+};
 /** The object containing the registered core, theme and custom fields and widgets as well as the root schema, form
  * context, schema utils and templates.
  */
@@ -303,9 +328,11 @@ interface Registry<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends F
     schemaUtils: SchemaUtilsType<T, S>;
     /** The string translation function to use when displaying any of the RJSF strings in templates, fields or widgets */
     translateString: (stringKey: TranslatableString, params?: string[]) => string;
+    /** The optional global UI Options that are available for all templates, fields and widgets to access */
+    globalUiOptions?: GlobalUISchemaOptions;
 }
 /** The properties that are passed to a Field implementation */
-interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, Pick<React.HTMLAttributes<HTMLElement>, Exclude<keyof React.HTMLAttributes<HTMLElement>, "onBlur" | "onFocus" | "onChange">> {
+interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, Pick<HTMLAttributes<HTMLElement>, Exclude<keyof HTMLAttributes<HTMLElement>, 'onBlur' | 'onFocus' | 'onChange'>> {
     /** The JSON subschema object for this field */
     schema: S;
     /** The uiSchema for this field */
@@ -350,7 +377,7 @@ interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     registry: Registry<T, S, F>;
 }
 /** The definition of a React-based Field component */
-type Field<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ComponentType<FieldProps<T, S, F>>;
+type Field<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ComponentType<FieldProps<T, S, F>>;
 /** The properties that are passed to a FieldTemplate implementation */
 type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The id of the field in the hierarchy. You can use it to render a label targeting the wrapped widget */
@@ -364,17 +391,17 @@ type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F exte
     /** A component instance rendering the field description, if one is defined (this will use any custom
      * `DescriptionField` defined)
      */
-    description?: React.ReactElement;
+    description?: ReactElement;
     /** A string containing any `ui:description` uiSchema directive defined */
     rawDescription?: string;
     /** The field or widget component instance for this field row */
-    children: React.ReactElement;
+    children: ReactElement;
     /** A component instance listing any encountered errors for this field */
-    errors?: React.ReactElement;
+    errors?: ReactElement;
     /** An array of strings listing all generated error messages from encountered errors for this field */
     rawErrors?: string[];
     /** A component instance rendering any `ui:help` uiSchema directive defined */
-    help?: React.ReactElement;
+    help?: ReactElement;
     /** A string containing any `ui:help` uiSchema directive defined. **NOTE:** `rawHelp` will be `undefined` if passed
      * `ui:help` is a React component instead of a string
      */
@@ -402,7 +429,7 @@ type FieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F exte
     /** The formData for this field */
     formData?: T;
     /** The value change event handler; Can be called with a new value to change the value for this field */
-    onChange: FieldProps["onChange"];
+    onChange: FieldProps['onChange'];
     /** The key change event handler; Called when the key associated with a field is changed for an additionalProperty */
     onKeyChange: (value: string) => () => void;
     /** The property drop/removal event handler; Called when a field is removed in an additionalProperty context */
@@ -445,34 +472,36 @@ type DescriptionFieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
     /** The uiSchema object for this description field */
     uiSchema?: UiSchema<T, S, F>;
     /** The description of the field being rendered */
-    description: string | React.ReactElement;
+    description: string | ReactElement;
     /** The `registry` object */
     registry: Registry<T, S, F>;
 };
 /** The properties that are passed to a `ArrayFieldTitleTemplate` implementation */
-type ArrayFieldTitleProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<TitleFieldProps<T, S, F>, "id" | "title"> & {
+type ArrayFieldTitleProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<TitleFieldProps<T, S, F>, 'id' | 'title'> & {
     /** The title for the field being rendered */
     title?: string;
     /** The idSchema of the field in the hierarchy */
     idSchema: IdSchema<T>;
 };
 /** The properties that are passed to a `ArrayFieldDescriptionTemplate` implementation */
-type ArrayFieldDescriptionProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<DescriptionFieldProps<T, S, F>, "id" | "description"> & {
+type ArrayFieldDescriptionProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Omit<DescriptionFieldProps<T, S, F>, 'id' | 'description'> & {
     /** The description of the field being rendered */
-    description?: string | React.ReactElement;
+    description?: string | ReactElement;
     /** The idSchema of the field in the hierarchy */
     idSchema: IdSchema<T>;
 };
 /** The properties of each element in the ArrayFieldTemplateProps.items array */
 type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The html for the item's content */
-    children: React.ReactElement;
+    children: ReactElement;
     /** The className string */
     className: string;
     /** A boolean value stating if the array item is disabled */
     disabled: boolean;
     /** A boolean value stating whether new items can be added to the array */
     canAdd: boolean;
+    /** A boolean value stating whether the array item can be copied, assumed false if missing */
+    hasCopy: boolean;
     /** A boolean value stating whether the array item can be moved down */
     hasMoveDown: boolean;
     /** A boolean value stating whether the array item can be moved up */
@@ -487,6 +516,8 @@ type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJSFSchema
     totalItems: number;
     /** Returns a function that adds a new item at `index` */
     onAddIndexClick: (index: number) => (event?: any) => void;
+    /** Returns a function that copies the item at `index` into the position at `index + 1` */
+    onCopyIndexClick: (index: number) => (event?: any) => void;
     /** Returns a function that removes the item at `index` */
     onDropIndexClick: (index: number) => (event?: any) => void;
     /** Returns a function that swaps the items at `index` with `newIndex` */
@@ -540,7 +571,7 @@ type ArrayFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
 /** The properties of each element in the ObjectFieldTemplateProps.properties array */
 type ObjectFieldTemplatePropertyType = {
     /** The html for the property's content */
-    content: React.ReactElement;
+    content: ReactElement;
     /** A string representing the property name */
     name: string;
     /** A boolean value stating if the object property is disabled */
@@ -584,12 +615,18 @@ type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema,
 /** The properties that are passed to a WrapIfAdditionalTemplate implementation */
 type WrapIfAdditionalTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The field or widget component instance for this field row */
-    children: React.ReactNode;
-} & Pick<FieldTemplateProps<T, S, F>, "id" | "classNames" | "style" | "label" | "required" | "readonly" | "disabled" | "schema" | "uiSchema" | "onKeyChange" | "onDropPropertyClick" | "registry">;
+    children: ReactNode;
+} & Pick<FieldTemplateProps<T, S, F>, 'id' | 'classNames' | 'style' | 'label' | 'required' | 'readonly' | 'disabled' | 'schema' | 'uiSchema' | 'onKeyChange' | 'onDropPropertyClick' | 'registry'>;
 /** The properties that are passed to a Widget implementation */
-interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, Pick<React.HTMLAttributes<HTMLElement>, Exclude<keyof React.HTMLAttributes<HTMLElement>, "onBlur" | "onFocus">> {
-    /** The generated id for this widget */
+interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, Pick<HTMLAttributes<HTMLElement>, Exclude<keyof HTMLAttributes<HTMLElement>, 'onBlur' | 'onFocus'>> {
+    /** The generated id for this widget, used to provide unique `name`s and `id`s for the HTML field elements rendered by
+     * widgets
+     */
     id: string;
+    /** The unique name of the field, usually derived from the name of the property in the JSONSchema; Provided in support
+     * of custom widgets.
+     */
+    name: string;
     /** The JSONSchema subschema object for this widget */
     schema: S;
     /** The uiSchema for this widget */
@@ -633,7 +670,15 @@ interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extend
     registry: Registry<T, S, F>;
 }
 /** The definition of a React-based Widget component */
-type Widget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ComponentType<WidgetProps<T, S, F>>;
+type Widget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ComponentType<WidgetProps<T, S, F>>;
+/** The properties that are passed to the BaseInputTemplate */
+interface BaseInputTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends WidgetProps<T, S, F> {
+    /** A `BaseInputTemplate` implements a default `onChange` handler that it passes to the HTML input component to handle
+     * the `ChangeEvent`. Sometimes a widget may need to handle the `ChangeEvent` using custom logic. If that is the case,
+     * that widget should provide its own handler via this prop.
+     */
+    onChangeOverride?: (event: ChangeEvent<HTMLInputElement>) => void;
+}
 /** The type that defines the props used by the Submit button */
 type SubmitButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The uiSchema for this widget */
@@ -642,11 +687,11 @@ type SubmitButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F exten
     registry: Registry<T, S, F>;
 };
 /** The type that defines the props for an Icon button, extending from a basic HTML button attributes */
-type IconButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ButtonHTMLAttributes<HTMLButtonElement> & {
+type IconButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = ButtonHTMLAttributes<HTMLButtonElement> & {
     /** An alternative specification for the type of the icon button */
     iconType?: string;
     /** The name representation or actual react element implementation for the icon */
-    icon?: string | React.ReactElement;
+    icon?: string | ReactElement;
     /** The uiSchema for this widget */
     uiSchema?: UiSchema<T, S, F>;
     /** The `registry` object */
@@ -682,7 +727,7 @@ type MakeUIType<Type> = {
 /** This type represents all the known supported options in the `ui:options` property, kept separate in order to
  * remap the keys. It also contains all the properties, optionally, of `TemplatesType` except "ButtonTemplates"
  */
-type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Partial<Omit<TemplatesType<T, S, F>, "ButtonTemplates">> & {
+type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = Partial<Omit<TemplatesType<T, S, F>, 'ButtonTemplates'>> & GlobalUISchemaOptions & {
     /** Any classnames that the user wants to be applied to a field in the ui */
     classNames?: string;
     /** Any custom style that the user wants to apply to a field in the ui, applied on the same element as classNames */
@@ -698,7 +743,7 @@ type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F exten
     /** Flag, if set to `true`, will mark the field as automatically focused on a text input or textarea input */
     autofocus?: boolean;
     /** Use to mark the field as supporting auto complete on a text input or textarea input */
-    autocomplete?: HTMLInputElement["autocomplete"];
+    autocomplete?: HTMLInputElement['autocomplete'];
     /** Flag, if set to `true`, will mark all child widgets from a given field as disabled */
     disabled?: boolean;
     /** The default value to use when an input for a field is empty */
@@ -713,18 +758,10 @@ type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F exten
     readonly?: boolean;
     /** This property allows you to reorder the properties that are shown for a particular object */
     order?: string[];
-    /** Flag, if set to `false`, will mark array fields as NOT being able to be added to (defaults to true) */
-    addable?: boolean;
-    /** Flag, if set to `false`, will mark array fields as NOT being able to be ordered (defaults to true) */
-    orderable?: boolean;
-    /** Flag, if set to `false`, will mark array fields as NOT being able to be removed (defaults to true) */
-    removable?: boolean;
     /** Flag, if set to `true`, will mark a list of checkboxes as displayed all on one line instead of one per row */
     inline?: boolean;
     /** Used to change the input type (for example, `tel` or `email`) for an <input> */
     inputType?: string;
-    /** Field labels are rendered by default. Labels may be omitted by setting the `label` option to `false` */
-    label?: boolean;
     /** Provides a means to set the initial height of a textarea widget */
     rows?: number;
     /** If submitButtonOptions is provided it should match the `UISchemaSubmitButtonOptions` type */
@@ -733,10 +770,6 @@ type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F exten
      * to look up an implementation from the `widgets` list or an actual one-off widget implementation itself
      */
     widget?: Widget<T, S, F> | string;
-    /** When using `additionalProperties`, key collision is prevented by appending a unique integer to the duplicate key.
-     * This option allows you to change the separator between the original key name and the integer. Default is "-"
-     */
-    duplicateKeySuffixSeparator?: string;
 };
 /** The type that represents the Options potentially provided by `ui:options` */
 type UIOptionsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = UIOptionsBaseType<T, S, F> & {
@@ -747,12 +780,16 @@ type UIOptionsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends F
  * starting with `ui:`.
  */
 type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = GenericObjectType & MakeUIType<UIOptionsBaseType<T, S, F>> & {
-    /** Allows the form to generate a unique prefix for the `Form`'s root prefix */
-    "ui:rootFieldId"?: string;
+    /** The set of Globally relevant UI Schema options that are read from the root-level UiSchema and stored in the
+     * Registry for use everywhere.
+     */
+    'ui:globalOptions'?: GlobalUISchemaOptions;
+    /** Allows the form to generate a unique prefix for the `Form`'s root prefix  */
+    'ui:rootFieldId'?: string;
     /** Allows RJSF to override the default field implementation by specifying either the name of a field that is used
      * to look up an implementation from the `fields` list or an actual one-off `Field` component implementation itself
      */
-    "ui:field"?: Field<T, S, F> | string;
+    'ui:field'?: Field<T, S, F> | string;
     /** By default, any field that is rendered for an `anyOf`/`oneOf` schema will be wrapped inside the `AnyOfField` or
      * `OneOfField` component. This default behavior may be undesirable if your custom field already handles behavior
      * related to choosing one or more subschemas contained in the `anyOf`/`oneOf` schema.
@@ -760,9 +797,9 @@ type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormCo
      * omitted, so just one instance of the custom field will be rendered. If the flag is omitted or set to `false`,
      * your custom field will be wrapped by `AnyOfField`/`OneOfField`.
      */
-    "ui:fieldReplacesAnyOrOneOf"?: boolean;
+    'ui:fieldReplacesAnyOrOneOf'?: boolean;
     /** An object that contains all the potential UI options in a single object */
-    "ui:options"?: UIOptionsType<T, S, F>;
+    'ui:options'?: UIOptionsType<T, S, F>;
 };
 /** A `CustomValidator` function takes in a `formData`, `errors` and `uiSchema` objects and returns the given `errors`
  * object back, while potentially adding additional messages to the `errors`
@@ -851,15 +888,16 @@ interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
      *          false when computing defaults for any nested object properties.
      * @returns - The resulting `formData` with all the defaults provided
      */
-    getDefaultFormState(schema: S, formData?: T, includeUndefinedValues?: boolean | "excludeObjectChildren"): T | T[] | undefined;
+    getDefaultFormState(schema: S, formData?: T, includeUndefinedValues?: boolean | 'excludeObjectChildren'): T | T[] | undefined;
     /** Determines whether the combination of `schema` and `uiSchema` properties indicates that the label for the `schema`
      * should be displayed in a UI.
      *
      * @param schema - The schema for which the display label flag is desired
      * @param [uiSchema] - The UI schema from which to derive potentially displayable information
+     * @param [globalOptions={}] - The Global UI Schema from which to get any fallback `xxx` options
      * @returns - True if the label should be displayed or false if it should not
      */
-    getDisplayLabel(schema: S, uiSchema?: UiSchema<T, S, F>): boolean;
+    getDisplayLabel(schema: S, uiSchema?: UiSchema<T, S, F>, globalOptions?: GlobalUISchemaOptions): boolean;
     /** Determines which of the given `options` provided most closely matches the `formData`.
      * Returns the index of the option that is valid and is the closest match, or 0 if there is no match.
      *
@@ -1007,6 +1045,12 @@ declare function createSchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSch
 declare function dataURItoBlob(dataURI: string): {
     blob: Blob;
     name: string;
+} | {
+    blob: {
+        size: number;
+        type: string;
+    };
+    name: string;
 };
 
 /** Implements a deep equals using the `lodash.isEqualWith` function, that provides a customized comparator that
@@ -1040,7 +1084,7 @@ declare function englishStringTranslator(stringToTranslate: TranslatableString,
  *        unless `selected` is a single value. In that case, if the `valueIndex` value matches `selected`, returns
  *        undefined, otherwise `selected`.
  */
-declare function enumOptionsDeselectValue<S extends StrictRJSFSchema = RJSFSchema>(valueIndex: string | number, selected?: EnumOptionsType<S>["value"] | EnumOptionsType<S>["value"][], allEnumOptions?: EnumOptionsType<S>[]): EnumOptionsType<S>["value"] | EnumOptionsType<S>["value"][] | undefined;
+declare function enumOptionsDeselectValue<S extends StrictRJSFSchema = RJSFSchema>(valueIndex: string | number, selected?: EnumOptionsType<S>['value'] | EnumOptionsType<S>['value'][], allEnumOptions?: EnumOptionsType<S>[]): EnumOptionsType<S>['value'] | EnumOptionsType<S>['value'][] | undefined;
 
 /** Returns the index(es) of the options in `allEnumOptions` whose value(s) match the ones in `value`. All the
  * `enumOptions` are filtered based on whether they are a "selected" `value` and the index of each selected one is then
@@ -1053,7 +1097,7 @@ declare function enumOptionsDeselectValue<S extends StrictRJSFSchema = RJSFSchem
  * @returns - A single string index for the first `value` in `allEnumOptions`, if not `multiple`. Otherwise, the list
  *        of indexes for (each of) the value(s) in `value`.
  */
-declare function enumOptionsIndexForValue<S extends StrictRJSFSchema = RJSFSchema>(value: EnumOptionsType<S>["value"] | EnumOptionsType<S>["value"][], allEnumOptions?: EnumOptionsType<S>[], multiple?: boolean): string | string[] | undefined;
+declare function enumOptionsIndexForValue<S extends StrictRJSFSchema = RJSFSchema>(value: EnumOptionsType<S>['value'] | EnumOptionsType<S>['value'][], allEnumOptions?: EnumOptionsType<S>[], multiple?: boolean): string | string[] | undefined;
 
 /** Determines whether the given `value` is (one of) the `selected` value(s).
  *
@@ -1061,7 +1105,7 @@ declare function enumOptionsIndexForValue<S extends StrictRJSFSchema = RJSFSchem
  * @param selected - The current selected value or list of values
  * @returns - true if the `value` is one of the `selected` ones, false otherwise
  */
-declare function enumOptionsIsSelected<S extends StrictRJSFSchema = RJSFSchema>(value: EnumOptionsType<S>["value"], selected: EnumOptionsType<S>["value"] | EnumOptionsType<S>["value"][]): boolean;
+declare function enumOptionsIsSelected<S extends StrictRJSFSchema = RJSFSchema>(value: EnumOptionsType<S>['value'], selected: EnumOptionsType<S>['value'] | EnumOptionsType<S>['value'][]): boolean;
 
 /** Add the enum option value at the `valueIndex` to the list of `selected` values in the proper order as defined by
  * `allEnumOptions`
@@ -1071,7 +1115,7 @@ declare function enumOptionsIsSelected<S extends StrictRJSFSchema = RJSFSchema>(
  * @param [allEnumOptions=[]] - The list of all the known enumOptions
  * @returns - The updated list of selected enum values with enum value at the `valueIndex` added to it
  */
-declare function enumOptionsSelectValue<S extends StrictRJSFSchema = RJSFSchema>(valueIndex: string | number, selected: EnumOptionsType<S>["value"][], allEnumOptions?: EnumOptionsType<S>[]): any[];
+declare function enumOptionsSelectValue<S extends StrictRJSFSchema = RJSFSchema>(valueIndex: string | number, selected: EnumOptionsType<S>['value'][], allEnumOptions?: EnumOptionsType<S>[]): any[];
 
 /** Returns the value(s) from `allEnumOptions` at the index(es) provided by `valueIndex`. If `valueIndex` is not an
  * array AND the index is not valid for `allEnumOptions`, `emptyValue` is returned. If `valueIndex` is an array, AND it
@@ -1084,7 +1128,7 @@ declare function enumOptionsSelectValue<S extends StrictRJSFSchema = RJSFSchema>
  * @returns - The single or list of values specified by the single or list of indexes if they are valid. Otherwise,
  *        `emptyValue` or an empty list.
  */
-declare function enumOptionsValueForIndex<S extends StrictRJSFSchema = RJSFSchema>(valueIndex: string | number | Array<string | number>, allEnumOptions?: EnumOptionsType<S>[], emptyValue?: EnumOptionsType<S>["value"]): EnumOptionsType<S>["value"] | EnumOptionsType<S>["value"][] | undefined;
+declare function enumOptionsValueForIndex<S extends StrictRJSFSchema = RJSFSchema>(valueIndex: string | number | Array<string | number>, allEnumOptions?: EnumOptionsType<S>[], emptyValue?: EnumOptionsType<S>['value']): EnumOptionsType<S>['value'] | EnumOptionsType<S>['value'][] | undefined;
 
 /** The `ErrorSchemaBuilder<T>` is used to build an `ErrorSchema<T>` since the definition of the `ErrorSchema` type is
  * designed for reading information rather than writing it. Use this class to add, replace or clear errors in an error
@@ -1198,12 +1242,13 @@ declare function getSubmitButtonOptions<T = any, S extends StrictRJSFSchema = RJ
 declare function getTemplate<Name extends keyof TemplatesType<T, S, F>, T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(name: Name, registry: Registry<T, S, F>, uiOptions?: UIOptionsType<T, S, F>): TemplatesType<T, S, F>[Name];
 
 /** Get all passed options from ui:options, and ui:<optionName>, returning them in an object with the `ui:`
- * stripped off.
+ * stripped off. Any `globalOptions` will always be returned, unless they are overridden by options in the `uiSchema`.
  *
  * @param [uiSchema={}] - The UI Schema from which to get any `ui:xxx` options
- * @returns - An object containing all the `ui:xxx` options with the stripped off
+ * @param [globalOptions={}] - The optional Global UI Schema from which to get any fallback `xxx` options
+ * @returns - An object containing all the `ui:xxx` options with the `ui:` stripped off along with all `globalOptions`
  */
-declare function getUiOptions<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(uiSchema?: UiSchema<T, S, F>): UIOptionsType<T, S, F>;
+declare function getUiOptions<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(uiSchema?: UiSchema<T, S, F>, globalOptions?: GlobalUISchemaOptions): UIOptionsType<T, S, F>;
 
 /** Given a schema representing a field to render and either the name or actual `Widget` implementation, returns the
  * React component that is used to render the widget. If the `widget` is already a React component, then it is wrapped
@@ -1346,7 +1391,7 @@ declare function mergeDefaultsWithFormData<T = any>(defaults?: T, formData?: T):
  *          NOTE: Uses shallow comparison for the duplicate checking.
  * @returns - A new object that is the merge of the two given objects
  */
-declare function mergeObjects(obj1: GenericObjectType, obj2: GenericObjectType, concatArrays?: boolean | "preventDuplicates"): GenericObjectType;
+declare function mergeObjects(obj1: GenericObjectType, obj2: GenericObjectType, concatArrays?: boolean | 'preventDuplicates'): GenericObjectType;
 
 /** Recursively merge deeply nested schemas. The difference between `mergeSchemas` and `mergeObjects` is that
  * `mergeSchemas` only concats arrays for values under the 'required' keyword, and when it does, it doesn't include
@@ -1487,7 +1532,8 @@ declare const REF_KEY = "$ref";
 declare const RJSF_ADDITONAL_PROPERTIES_FLAG = "__rjsf_additionalProperties";
 declare const UI_FIELD_KEY = "ui:field";
 declare const UI_WIDGET_KEY = "ui:widget";
-declare const UI_OPTIONS_KEY = "ui:options";
+declare const UI_OPTIONS_KEY = "ui:options";
+declare const UI_GLOBAL_OPTIONS_KEY = "ui:globalOptions";
 
 /** Returns the superset of `formData` that includes the given set updated to include any missing fields that have
  * computed to have defaults provided in the `schema`.
@@ -1501,7 +1547,7 @@ declare const UI_OPTIONS_KEY = "ui:options";
  *          false when computing defaults for any nested object properties.
  * @returns - The resulting `formData` with all the defaults provided
  */
-declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, theSchema: S, formData?: T, rootSchema?: S, includeUndefinedValues?: boolean | "excludeObjectChildren"): T | T[] | undefined;
+declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, theSchema: S, formData?: T, rootSchema?: S, includeUndefinedValues?: boolean | 'excludeObjectChildren'): T | T[] | undefined;
 
 /** Determines whether the combination of `schema` and `uiSchema` properties indicates that the label for the `schema`
  * should be displayed in a UI.
@@ -1510,9 +1556,10 @@ declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFS
  * @param schema - The schema for which the display label flag is desired
  * @param [uiSchema={}] - The UI schema from which to derive potentially displayable information
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
+ * @param [globalOptions={}] - The optional Global UI Schema from which to get any fallback `xxx` options
  * @returns - True if the label should be displayed or false if it should not
  */
-declare function getDisplayLabel<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, uiSchema?: UiSchema<T, S, F>, rootSchema?: S): boolean;
+declare function getDisplayLabel<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, uiSchema?: UiSchema<T, S, F>, rootSchema?: S, globalOptions?: GlobalUISchemaOptions): boolean;
 
 /** Determines which of the given `options` provided most closely matches the `formData`. Using
  * `getFirstMatchingOption()` to match two schemas that differ only by the readOnly, default or const value of a field
@@ -1684,4 +1731,4 @@ declare function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F
  */
 declare function toPathSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, name?: string, rootSchema?: S, formData?: T): PathSchema<T>;
 
-export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, ArrayFieldDescriptionProps, ArrayFieldTemplateItemType, ArrayFieldTemplateProps, ArrayFieldTitleProps, CONST_KEY, CustomValidator, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, DateObject, DescriptionFieldProps, ENUM_KEY, ERRORS_KEY, EnumOptionsType, ErrorListProps, ErrorSchema, ErrorSchemaBuilder, ErrorTransformer, Field, FieldError, FieldErrorProps, FieldErrors, FieldHelpProps, FieldId, FieldPath, FieldProps, FieldTemplateProps, FieldValidation, FormContextType, FormValidation, GenericObjectType, ID_KEY, ITEMS_KEY, IconButtonProps, IdSchema, InputPropsType, NAME_KEY, ONE_OF_KEY, ObjectFieldTemplatePropertyType, ObjectFieldTemplateProps, PROPERTIES_KEY, PathSchema, REF_KEY, REQUIRED_KEY, RJSFSchema, RJSFValidationError, RJSF_ADDITONAL_PROPERTIES_FLAG, RangeSpecType, Registry, RegistryFieldsType, RegistryWidgetsType, SUBMIT_BTN_OPTIONS_KEY, SchemaUtilsType, StrictRJSFSchema, SubmitButtonProps, TemplatesType, TitleFieldProps, TranslatableString, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, WrapIfAdditionalTemplateProps, allowAdditionalItems, ariaDescribedByIds, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, englishStringTranslator, enumOptionsDeselectValue, enumOptionsIndexForValue, enumOptionsIsSelected, enumOptionsSelectValue, enumOptionsValueForIndex, errorId, examplesId, findSchemaDefinition, getClosestMatchingOption, getDefaultFormState, getDisplayLabel, getFirstMatchingOption, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, helpId, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionId, optionsList, orderProperties, pad, parseDateString, rangeSpec, replaceStringParameters, retrieveSchema, sanitizeDataForNewSchema, schemaRequiresTrueValue, shouldRender, titleId, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };
+export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, ArrayFieldDescriptionProps, ArrayFieldTemplateItemType, ArrayFieldTemplateProps, ArrayFieldTitleProps, BaseInputTemplateProps, CONST_KEY, CustomValidator, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, DateObject, DescriptionFieldProps, ENUM_KEY, ERRORS_KEY, EnumOptionsType, ErrorListProps, ErrorSchema, ErrorSchemaBuilder, ErrorTransformer, Field, FieldError, FieldErrorProps, FieldErrors, FieldHelpProps, FieldId, FieldPath, FieldProps, FieldTemplateProps, FieldValidation, FormContextType, FormValidation, GenericObjectType, GlobalUISchemaOptions, ID_KEY, ITEMS_KEY, IconButtonProps, IdSchema, InputPropsType, NAME_KEY, ONE_OF_KEY, ObjectFieldTemplatePropertyType, ObjectFieldTemplateProps, PROPERTIES_KEY, PathSchema, REF_KEY, REQUIRED_KEY, RJSFSchema, RJSFValidationError, RJSF_ADDITONAL_PROPERTIES_FLAG, RangeSpecType, Registry, RegistryFieldsType, RegistryWidgetsType, SUBMIT_BTN_OPTIONS_KEY, SchemaUtilsType, StrictRJSFSchema, SubmitButtonProps, TemplatesType, TitleFieldProps, TranslatableString, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_GLOBAL_OPTIONS_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, WrapIfAdditionalTemplateProps, allowAdditionalItems, ariaDescribedByIds, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, englishStringTranslator, enumOptionsDeselectValue, enumOptionsIndexForValue, enumOptionsIsSelected, enumOptionsSelectValue, enumOptionsValueForIndex, errorId, examplesId, findSchemaDefinition, getClosestMatchingOption, getDefaultFormState, getDisplayLabel, getFirstMatchingOption, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, helpId, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionId, optionsList, orderProperties, pad, parseDateString, rangeSpec, replaceStringParameters, retrieveSchema, sanitizeDataForNewSchema, schemaRequiresTrueValue, shouldRender, titleId, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };