@rjsf/core 5.1.0 → 5.2.0

package/dist/core.esm.js

@@ -1,5 +1,5 @@
 import React, { Component, useState, useCallback, useEffect, useReducer, useMemo, forwardRef } from 'react';
-import { isFixedItems, allowAdditionalItems, getUiOptions, ITEMS_KEY, getTemplate, isCustomWidget, getWidget, optionsList, deepEquals, ERRORS_KEY, asNumber, REF_KEY, orderProperties, PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ANY_OF_KEY, ONE_OF_KEY, mergeObjects, UI_OPTIONS_KEY, descriptionId, getSchemaType, ID_KEY, hasWidget, titleId, getInputProps, examplesId, ariaDescribedByIds, getSubmitButtonOptions, errorId, helpId, canExpand, parseDateString, toDateString, pad, schemaRequiresTrueValue, enumOptionsValueForIndex, enumOptionsIsSelected, optionId, enumOptionsSelectValue, enumOptionsDeselectValue, utcToLocal, localToUTC, dataURItoBlob, enumOptionsIndexForValue, createSchemaUtils, shouldRender, isObject as isObject$1, RJSF_ADDITONAL_PROPERTIES_FLAG, NAME_KEY } from '@rjsf/utils';
+import { isFixedItems, allowAdditionalItems, getUiOptions, ITEMS_KEY, getTemplate, TranslatableString, isCustomWidget, getWidget, optionsList, deepEquals, ERRORS_KEY, asNumber, REF_KEY, orderProperties, PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ANY_OF_KEY, ONE_OF_KEY, mergeObjects, UI_OPTIONS_KEY, descriptionId, getSchemaType, ID_KEY, hasWidget, titleId, getInputProps, examplesId, ariaDescribedByIds, getSubmitButtonOptions, errorId, helpId, canExpand, parseDateString, toDateString, pad, schemaRequiresTrueValue, enumOptionsValueForIndex, enumOptionsIsSelected, optionId, enumOptionsSelectValue, enumOptionsDeselectValue, utcToLocal, localToUTC, dataURItoBlob, enumOptionsIndexForValue, englishStringTranslator, createSchemaUtils, shouldRender, isObject as isObject$1, RJSF_ADDITONAL_PROPERTIES_FLAG, NAME_KEY } from '@rjsf/utils';
 import get from 'lodash-es/get';
 import isEmpty from 'lodash-es/isEmpty';
 import _pick from 'lodash-es/pick';
@@ -10,6 +10,7 @@ import { nanoid } from 'nanoid';
 import omit from 'lodash-es/omit';
 import has from 'lodash-es/has';
 import unset from 'lodash-es/unset';
+import Markdown from 'markdown-to-jsx';
 
 function _defineProperties(target, props) {
   for (var i = 0; i < props.length; i++) {
@@ -189,7 +190,7 @@ var ArrayField = /*#__PURE__*/function (_Component) {
           onChange = _this$props3.onChange,
           errorSchema = _this$props3.errorSchema;
         var newErrorSchema;
-        if (_this.props.errorSchema) {
+        if (errorSchema) {
           newErrorSchema = {};
           for (var idx in errorSchema) {
             var i = parseInt(idx);
@@ -366,14 +367,15 @@ var ArrayField = /*#__PURE__*/function (_Component) {
       uiSchema = _this$props7.uiSchema,
       idSchema = _this$props7.idSchema,
       registry = _this$props7.registry;
-    var schemaUtils = registry.schemaUtils;
+    var schemaUtils = registry.schemaUtils,
+      translateString = registry.translateString;
     if (!(ITEMS_KEY in schema)) {
       var uiOptions = getUiOptions(uiSchema);
       var UnsupportedFieldTemplate = getTemplate("UnsupportedFieldTemplate", registry, uiOptions);
       return /*#__PURE__*/React.createElement(UnsupportedFieldTemplate, {
         schema: schema,
         idSchema: idSchema,
-        reason: "Missing items definition",
+        reason: translateString(TranslatableString.MissingItems),
         registry: registry
       });
     }
@@ -830,8 +832,11 @@ var ArrayField = /*#__PURE__*/function (_Component) {
   _createClass(ArrayField, [{
     key: "itemTitle",
     get: function get$1() {
-      var schema = this.props.schema;
-      return get(schema, [ITEMS_KEY, "title"], get(schema, [ITEMS_KEY, "description"], "Item"));
+      var _this$props14 = this.props,
+        schema = _this$props14.schema,
+        registry = _this$props14.registry;
+      var translateString = registry.translateString;
+      return get(schema, [ITEMS_KEY, "title"], get(schema, [ITEMS_KEY, "description"], translateString(TranslatableString.ArrayItemTitle)));
     }
   }]);
   return ArrayField;
@@ -860,19 +865,22 @@ function BooleanField(props) {
     rawErrors = props.rawErrors;
   var title = schema.title;
   var widgets = registry.widgets,
-    formContext = registry.formContext;
+    formContext = registry.formContext,
+    translateString = registry.translateString;
   var _getUiOptions = getUiOptions(uiSchema),
     _getUiOptions$widget = _getUiOptions.widget,
     widget = _getUiOptions$widget === void 0 ? "checkbox" : _getUiOptions$widget,
     options = _objectWithoutPropertiesLoose(_getUiOptions, _excluded$8);
   var Widget = getWidget(schema, widget, widgets);
+  var yes = translateString(TranslatableString.YesLabel);
+  var no = translateString(TranslatableString.NoLabel);
   var enumOptions;
   if (Array.isArray(schema.oneOf)) {
     enumOptions = optionsList({
       oneOf: schema.oneOf.map(function (option) {
         if (isObject(option)) {
           return _extends({}, option, {
-            title: option.title || (option["const"] === true ? "Yes" : "No")
+            title: option.title || (option["const"] === true ? yes : no)
           });
         }
         return undefined;
@@ -890,10 +898,10 @@ function BooleanField(props) {
     })) {
       enumOptions = [{
         value: enums[0],
-        label: enums[0] ? "Yes" : "No"
+        label: enums[0] ? yes : no
       }, {
         value: enums[1],
-        label: enums[1] ? "Yes" : "No"
+        label: enums[1] ? yes : no
       }];
     } else {
       enumOptions = optionsList({
@@ -926,9 +934,6 @@ function BooleanField(props) {
 }
 
 var _excluded$7 = ["widget", "placeholder", "autofocus", "autocomplete", "title"];
-/** The prefix used when a oneOf option does not have a title
- */
-var UNKNOWN_OPTION_PREFIX = "Option";
 /** The `AnyOfField` component is used to render a field in the schema that is an `anyOf`, `allOf` or `oneOf`. It tracks
  * the currently selected option and cleans up any irrelevant data in `formData`.
  *
@@ -1067,7 +1072,8 @@ var AnyOfField = /*#__PURE__*/function (_Component) {
       schema = _this$props5.schema,
       uiSchema = _this$props5.uiSchema;
     var widgets = registry.widgets,
-      fields = registry.fields;
+      fields = registry.fields,
+      translateString = registry.translateString;
     var _SchemaField = fields.SchemaField;
     var _this$state2 = this.state,
       selectedOption = _this$state2.selectedOption,
@@ -1095,10 +1101,11 @@ var AnyOfField = /*#__PURE__*/function (_Component) {
         type: baseType
       });
     }
-    var optionLabel = title ? title + " " + UNKNOWN_OPTION_PREFIX.toLowerCase() : UNKNOWN_OPTION_PREFIX;
+    var translateEnum = title ? TranslatableString.TitleOptionPrefix : TranslatableString.OptionPrefix;
+    var translateParams = title ? [title] : [];
     var enumOptions = retrievedOptions.map(function (opt, index) {
       return {
-        label: opt.title || optionLabel + " " + (index + 1),
+        label: opt.title || translateString(translateEnum, translateParams.concat(String(index + 1))),
         value: index
       };
     });
@@ -1353,9 +1360,8 @@ var ObjectField = /*#__PURE__*/function (_Component) {
    * @param type - The type of the new additional schema property
    */
   _proto.getDefaultValue = function getDefaultValue(type) {
+    var translateString = this.props.registry.translateString;
     switch (type) {
-      case "string":
-        return "New Value";
       case "array":
         return [];
       case "boolean":
@@ -1366,9 +1372,10 @@ var ObjectField = /*#__PURE__*/function (_Component) {
         return 0;
       case "object":
         return {};
+      case "string":
       default:
         // We don't have a datatype for some reason (perhaps additionalProperties was true)
-        return "New Value";
+        return translateString(TranslatableString.NewStringDefault);
     }
   }
   /** Handles the adding of a new additional property on the given `schema`. Calls the `onChange` callback once the new
@@ -1502,7 +1509,8 @@ var COMPONENT_TYPES = {
  */
 function getFieldComponent(schema, uiOptions, idSchema, registry) {
   var field = uiOptions.field;
-  var fields = registry.fields;
+  var fields = registry.fields,
+    translateString = registry.translateString;
   if (typeof field === "function") {
     return field;
   }
@@ -1524,7 +1532,7 @@ function getFieldComponent(schema, uiOptions, idSchema, registry) {
     return /*#__PURE__*/React.createElement(UnsupportedFieldTemplate, {
       schema: schema,
       idSchema: idSchema,
-      reason: "Unknown field type " + schema.type,
+      reason: translateString(TranslatableString.UnknownFieldType, [String(schema.type)]),
       registry: registry
     });
   };
@@ -2109,24 +2117,27 @@ function IconButton(props) {
   }));
 }
 function MoveDownButton(props) {
+  var translateString = props.registry.translateString;
   return /*#__PURE__*/React.createElement(IconButton, _extends({
-    title: "Move down",
+    title: translateString(TranslatableString.MoveDownButton),
     className: "array-item-move-down"
   }, props, {
     icon: "arrow-down"
   }));
 }
 function MoveUpButton(props) {
+  var translateString = props.registry.translateString;
   return /*#__PURE__*/React.createElement(IconButton, _extends({
-    title: "Move up",
+    title: translateString(TranslatableString.MoveUpButton),
     className: "array-item-move-up"
   }, props, {
     icon: "arrow-up"
   }));
 }
 function RemoveButton(props) {
+  var translateString = props.registry.translateString;
   return /*#__PURE__*/React.createElement(IconButton, _extends({
-    title: "Remove",
+    title: translateString(TranslatableString.RemoveButton),
     className: "array-item-remove"
   }, props, {
     iconType: "danger",
@@ -2141,6 +2152,7 @@ function AddButton(_ref) {
     onClick = _ref.onClick,
     disabled = _ref.disabled,
     registry = _ref.registry;
+  var translateString = registry.translateString;
   return /*#__PURE__*/React.createElement("div", {
     className: "row"
   }, /*#__PURE__*/React.createElement("p", {
@@ -2149,7 +2161,7 @@ function AddButton(_ref) {
     iconType: "info",
     icon: "plus",
     className: "btn-add col-xs-12",
-    title: "Add",
+    title: translateString(TranslatableString.AddButton),
     onClick: onClick,
     disabled: disabled,
     registry: registry
@@ -2194,14 +2206,16 @@ function DescriptionField(props) {
  * @param props - The `ErrorListProps` for this component
  */
 function ErrorList(_ref) {
-  var errors = _ref.errors;
+  var errors = _ref.errors,
+    registry = _ref.registry;
+  var translateString = registry.translateString;
   return /*#__PURE__*/React.createElement("div", {
     className: "panel panel-danger errors"
   }, /*#__PURE__*/React.createElement("div", {
     className: "panel-heading"
   }, /*#__PURE__*/React.createElement("h3", {
     className: "panel-title"
-  }, "Errors")), /*#__PURE__*/React.createElement("ul", {
+  }, translateString(TranslatableString.ErrorsLabel))), /*#__PURE__*/React.createElement("ul", {
     className: "list-group"
   }, errors.map(function (error, i) {
     return /*#__PURE__*/React.createElement("li", {
@@ -2384,10 +2398,22 @@ function TitleField(props) {
 function UnsupportedField(props) {
   var schema = props.schema,
     idSchema = props.idSchema,
-    reason = props.reason;
+    reason = props.reason,
+    registry = props.registry;
+  var translateString = registry.translateString;
+  var translateEnum = TranslatableString.UnsupportedField;
+  var translateParams = [];
+  if (idSchema && idSchema.$id) {
+    translateEnum = TranslatableString.UnsupportedFieldWithId;
+    translateParams.push(idSchema.$id);
+  }
+  if (reason) {
+    translateEnum = translateEnum === TranslatableString.UnsupportedField ? TranslatableString.UnsupportedFieldWithReason : TranslatableString.UnsupportedFieldWithIdAndReason;
+    translateParams.push(reason);
+  }
   return /*#__PURE__*/React.createElement("div", {
     className: "unsupported-field"
-  }, /*#__PURE__*/React.createElement("p", null, "Unsupported field schema", idSchema && idSchema.$id && /*#__PURE__*/React.createElement("span", null, " for", " field ", /*#__PURE__*/React.createElement("code", null, idSchema.$id)), reason && /*#__PURE__*/React.createElement("em", null, ": ", reason), "."), schema && /*#__PURE__*/React.createElement("pre", null, JSON.stringify(schema, null, 2)));
+  }, /*#__PURE__*/React.createElement("p", null, /*#__PURE__*/React.createElement(Markdown, null, translateString(translateEnum, translateParams))), schema && /*#__PURE__*/React.createElement("pre", null, JSON.stringify(schema, null, 2)));
 }
 
 /** The `WrapIfAdditional` component is used by the `FieldTemplate` to rename, or remove properties that are
@@ -2409,9 +2435,11 @@ function WrapIfAdditionalTemplate(props) {
     children = props.children,
     uiSchema = props.uiSchema,
     registry = props.registry;
+  var templates = registry.templates,
+    translateString = registry.translateString;
   // Button templates are not overridden in the uiSchema
-  var RemoveButton = registry.templates.ButtonTemplates.RemoveButton;
-  var keyLabel = label + " Key"; // i18n ?
+  var RemoveButton = templates.ButtonTemplates.RemoveButton;
+  var keyLabel = translateString(TranslatableString.KeyLabel, [label]);
   var additional = (ADDITIONAL_PROPERTY_FLAG in schema);
   if (!additional) {
     return /*#__PURE__*/React.createElement("div", {
@@ -2588,6 +2616,7 @@ function AltDateWidget(_ref2) {
     onFocus = _ref2.onFocus,
     onChange = _ref2.onChange,
     value = _ref2.value;
+  var translateString = registry.translateString;
   var _useReducer = useReducer(function (state, action) {
       return _extends({}, state, action);
     }, parseDateString(value, time)),
@@ -2647,13 +2676,13 @@ function AltDateWidget(_ref2) {
     href: "#",
     className: "btn btn-info btn-now",
     onClick: handleSetNow
-  }, "Now")), (options.hideClearButton !== "undefined" ? !options.hideClearButton : true) && /*#__PURE__*/React.createElement("li", {
+  }, translateString(TranslatableString.NowLabel))), (options.hideClearButton !== "undefined" ? !options.hideClearButton : true) && /*#__PURE__*/React.createElement("li", {
     className: "list-inline-item"
   }, /*#__PURE__*/React.createElement("a", {
     href: "#",
     className: "btn btn-warning btn-clear",
     onClick: handleClear
-  }, "Clear")));
+  }, translateString(TranslatableString.ClearLabel))));
 }
 
 var _excluded$1 = ["time"];
@@ -2906,10 +2935,12 @@ function processFiles(files) {
   return Promise.all(Array.from(files).map(processFile));
 }
 function FilesInfo(_ref) {
-  var filesInfo = _ref.filesInfo;
+  var filesInfo = _ref.filesInfo,
+    registry = _ref.registry;
   if (filesInfo.length === 0) {
     return null;
   }
+  var translateString = registry.translateString;
   return /*#__PURE__*/React.createElement("ul", {
     className: "file-info"
   }, filesInfo.map(function (fileInfo, key) {
@@ -2918,7 +2949,7 @@ function FilesInfo(_ref) {
       type = fileInfo.type;
     return /*#__PURE__*/React.createElement("li", {
       key: key
-    }, /*#__PURE__*/React.createElement("strong", null, name), " (", type, ", ", size, " bytes)");
+    }, /*#__PURE__*/React.createElement(Markdown, null, translateString(TranslatableString.FilesInfo, [name, type, String(size)])));
   }));
 }
 function extractFileInfo(dataURLs) {
@@ -2948,7 +2979,8 @@ function FileWidget(_ref2) {
     value = _ref2.value,
     _ref2$autofocus = _ref2.autofocus,
     autofocus = _ref2$autofocus === void 0 ? false : _ref2$autofocus,
-    options = _ref2.options;
+    options = _ref2.options,
+    registry = _ref2.registry;
   var extractedFilesInfo = useMemo(function () {
     return Array.isArray(value) ? extractFileInfo(value) : extractFileInfo([value]);
   }, [value]);
@@ -2983,7 +3015,8 @@ function FileWidget(_ref2) {
     accept: options.accept ? String(options.accept) : undefined,
     "aria-describedby": ariaDescribedByIds(id)
   })), /*#__PURE__*/React.createElement(FilesInfo, {
-    filesInfo: filesInfo
+    filesInfo: filesInfo,
+    registry: registry
   }));
 }
 
@@ -3295,7 +3328,8 @@ function getDefaultRegistry() {
     templates: templates(),
     widgets: widgets(),
     rootSchema: {},
-    formContext: {}
+    formContext: {},
+    translateString: englishStringTranslator
   };
 }
 
@@ -3623,7 +3657,8 @@ var Form = /*#__PURE__*/function (_Component) {
         errorSchema: errorSchema || {},
         schema: schema,
         uiSchema: uiSchema,
-        formContext: formContext
+        formContext: formContext,
+        registry: registry
       });
     }
     return null;
@@ -3636,12 +3671,14 @@ var Form = /*#__PURE__*/function (_Component) {
   /** Returns the registry for the form */
   _proto.getRegistry = function getRegistry() {
     var _this$props$templates;
+    var customTranslateString = this.props.translateString;
     var schemaUtils = this.state.schemaUtils;
     var _getDefaultRegistry = getDefaultRegistry(),
       fields = _getDefaultRegistry.fields,
       templates = _getDefaultRegistry.templates,
       widgets = _getDefaultRegistry.widgets,
-      formContext = _getDefaultRegistry.formContext;
+      formContext = _getDefaultRegistry.formContext,
+      translateString = _getDefaultRegistry.translateString;
     return {
       fields: _extends({}, fields, this.props.fields),
       templates: _extends({}, templates, this.props.templates, {
@@ -3650,7 +3687,8 @@ var Form = /*#__PURE__*/function (_Component) {
       widgets: _extends({}, widgets, this.props.widgets),
       rootSchema: this.props.schema,
       formContext: this.props.formContext || formContext,
-      schemaUtils: schemaUtils
+      schemaUtils: schemaUtils,
+      translateString: customTranslateString || translateString
     };
   }
   /** Provides a function that can be used to programmatically submit the `Form` */;