@commercetools-uikit/localized-multiline-text-field 14.0.0 → 14.0.1

package/README.md

@@ -144,3 +144,23 @@ When the `key` is known, and when the value is truthy, and when `renderError` re
 Known error keys are:
 
 - `missing`: tells the user that this field is required
+
+## Static methods
+
+### `LocalizedMultilineTextField.toFieldErrors`
+
+Use this function to convert the Formik `errors` object type to our custom field errors type. This is primarily useful when using TypeScript.
+
+```ts
+type FormValues = {
+  myField: string;
+};
+
+<LocalizedMultilineTextField
+  // ...
+  name="my-field"
+  errors={
+    LocalizedMultilineTextField.toFieldErrors<FormValues>(formik.errors).myField
+  }
+/>;
+```

package/dist/commercetools-uikit-localized-multiline-text-field.cjs.dev.js

@@ -149,6 +149,17 @@ var LocalizedMultilineTextField = /*#__PURE__*/function (_Component) {
         })
       });
     }
+  }], [{
+    key: "toFieldErrors",
+    value:
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
+    function toFieldErrors(errors) {
+      return errors;
+    }
   }]);
 
   return LocalizedMultilineTextField;
@@ -195,7 +206,7 @@ LocalizedMultilineTextField.propTypes = process.env.NODE_ENV !== "production" ?
 var LocalizedMultilineTextField$1 = LocalizedMultilineTextField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.1";
 
 exports["default"] = LocalizedMultilineTextField$1;
 exports.version = version;

package/dist/commercetools-uikit-localized-multiline-text-field.cjs.prod.js

@@ -144,6 +144,17 @@ var LocalizedMultilineTextField = /*#__PURE__*/function (_Component) {
         })
       });
     }
+  }], [{
+    key: "toFieldErrors",
+    value:
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
+    function toFieldErrors(errors) {
+      return errors;
+    }
   }]);
 
   return LocalizedMultilineTextField;
@@ -164,7 +175,7 @@ LocalizedMultilineTextField.propTypes = {};
 var LocalizedMultilineTextField$1 = LocalizedMultilineTextField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.1";
 
 exports["default"] = LocalizedMultilineTextField$1;
 exports.version = version;

package/dist/commercetools-uikit-localized-multiline-text-field.esm.js

@@ -124,6 +124,17 @@ var LocalizedMultilineTextField = /*#__PURE__*/function (_Component) {
         })
       });
     }
+  }], [{
+    key: "toFieldErrors",
+    value:
+    /**
+     * Use this function to convert the Formik `errors` object type to
+     * our custom field errors type.
+     * This is primarly useful when using TypeScript.
+     */
+    function toFieldErrors(errors) {
+      return errors;
+    }
   }]);
 
   return LocalizedMultilineTextField;
@@ -170,6 +181,6 @@ LocalizedMultilineTextField.propTypes = process.env.NODE_ENV !== "production" ?
 var LocalizedMultilineTextField$1 = LocalizedMultilineTextField;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "14.0.0";
+var version = "14.0.1";
 
 export { LocalizedMultilineTextField$1 as default, version };

package/dist/declarations/src/localized-multiline-text-field.d.ts

@@ -1,4 +1,9 @@
 import { Component, type ReactNode, type ChangeEventHandler, type ReactElement } from 'react';
+declare type TErrorRenderer = (key: string, error?: boolean) => ReactNode;
+declare type TFieldErrors = Record<string, boolean>;
+declare type TCustomFormErrors<Values> = {
+    [K in keyof Values]?: TFieldErrors;
+};
 declare type TEvent = {
     target: {
         language: string;
@@ -40,8 +45,6 @@ declare type TLocalizedMultilineTextFieldProps = {
     badge?: ReactNode;
 };
 declare type TLocalizedMultilineTextFieldState = Pick<TLocalizedMultilineTextFieldProps, 'id'>;
-declare type TFieldErrors = Record<string, boolean>;
-declare type TErrorRenderer = (key: string, error?: boolean) => ReactNode;
 declare class LocalizedMultilineTextField extends Component<TLocalizedMultilineTextFieldProps, TLocalizedMultilineTextFieldState> {
     static displayName: string;
     static defaultProps: Pick<TLocalizedMultilineTextFieldProps, 'horizontalConstraint'>;
@@ -51,6 +54,7 @@ declare class LocalizedMultilineTextField extends Component<TLocalizedMultilineT
     static getDerivedStateFromProps: (props: TLocalizedMultilineTextFieldProps, state: TLocalizedMultilineTextFieldState) => {
         id: string;
     };
+    static toFieldErrors<FormValues>(errors: unknown): TCustomFormErrors<FormValues>;
     render(): import("@emotion/react/jsx-runtime").JSX.Element;
 }
 export default LocalizedMultilineTextField;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/localized-multiline-text-field",
   "description": "A controlled text input component for localized multi-line strings with validation states.",
-  "version": "14.0.0",
+  "version": "14.0.1",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,13 +21,13 @@
   "dependencies": {
     "@babel/runtime": "^7.17.2",
     "@babel/runtime-corejs3": "^7.17.2",
-    "@commercetools-uikit/constraints": "14.0.0",
+    "@commercetools-uikit/constraints": "14.0.1",
     "@commercetools-uikit/design-system": "14.0.0",
-    "@commercetools-uikit/field-errors": "14.0.0",
-    "@commercetools-uikit/field-label": "14.0.0",
-    "@commercetools-uikit/localized-multiline-text-input": "14.0.0",
-    "@commercetools-uikit/spacings": "14.0.0",
-    "@commercetools-uikit/utils": "14.0.0",
+    "@commercetools-uikit/field-errors": "14.0.1",
+    "@commercetools-uikit/field-label": "14.0.1",
+    "@commercetools-uikit/localized-multiline-text-input": "14.0.1",
+    "@commercetools-uikit/spacings": "14.0.1",
+    "@commercetools-uikit/utils": "14.0.1",
     "@emotion/react": "^11.4.0",
     "@emotion/styled": "^11.3.0",
     "prop-types": "15.8.1",