@commercetools-uikit/localized-multiline-text-input 19.9.0 → 19.11.0

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

@@ -496,7 +496,7 @@ LocalizedMultilineTextInput.isTouched = localizedUtils.isTouched;
 var LocalizedMultilineTextInput$1 = LocalizedMultilineTextInput;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 exports["default"] = LocalizedMultilineTextInput$1;
 exports.version = version;

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

@@ -381,7 +381,7 @@ LocalizedMultilineTextInput.isTouched = localizedUtils.isTouched;
 var LocalizedMultilineTextInput$1 = LocalizedMultilineTextInput;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 exports["default"] = LocalizedMultilineTextInput$1;
 exports.version = version;

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

@@ -474,6 +474,6 @@ LocalizedMultilineTextInput.isTouched = isTouched;
 var LocalizedMultilineTextInput$1 = LocalizedMultilineTextInput;
 
 // NOTE: This string will be replaced on build time with the package version.
-var version = "19.9.0";
+var version = "19.11.0";
 
 export { LocalizedMultilineTextInput$1 as default, version };

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

@@ -4,38 +4,123 @@ interface HTMLLocalizedTextAreaElement extends HTMLTextAreaElement {
     language: string;
 }
 export type TLocalizedMultilineTextInputProps = {
+    /**
+     * Used as prefix of HTML `id` property. Each input field id will have the language as a suffix (`${idPrefix}.${lang}`), e.g. `foo.en`
+     */
     id?: string;
+    /**
+     * Used as HTML `name` property for each input field. Each input field name will have the language as a suffix (`${namePrefix}.${lang}`), e.g. `foo.en`
+     */
     name?: string;
+    /**
+     * Used as HTML `autocomplete` property
+     */
     autoComplete?: string;
+    /**
+     * Indicate if the value entered in the input is invalid.
+     */
     'aria-invalid'?: boolean;
+    /**
+     * HTML ID of an element containing an error message related to the input.
+     */
     'aria-errormessage'?: string;
+    /**
+     * Values to use. Keyed by language, the values are the actual values, e.g. `{ en: 'Horse', de: 'Pferd' }`
+     * <br />
+     * The input doesn't accept a "languages" prop, instead all possible
+     * languages have to exist (with empty or filled strings) on the value:
+     * <br />
+     * { en: 'foo', de: '', es: '' }
+     */
     value: {
         [key: string]: string;
     };
+    /**
+     * Gets called when any input is changed. Is called with the change event of the changed input.
+     */
     onChange?: ChangeEventHandler<HTMLLocalizedTextAreaElement>;
+    /**
+     * Specifies which language will be shown in case the `LocalizedTextInput` is collapsed.
+     */
     selectedLanguage: string;
+    /**
+     * Called when input is blurred
+     */
     onBlur?: FocusEventHandler<HTMLLocalizedTextAreaElement>;
+    /**
+     * Called when input is focused
+     */
     onFocus?: () => void;
+    /**
+     * Expands input components holding multiline values instead of collpasing them by default.
+     */
     defaultExpandMultilineText?: boolean;
+    /**
+     * Use this property to turn off caching input measurements.
+     */
     cacheMeasurements?: boolean;
+    /**
+     * Will hide the language expansion controls when set to `true`. All languages will be shown when set to `true`.
+     */
     hideLanguageExpansionControls?: boolean;
+    /**
+     * Controls whether one or all languages are visible by default. Pass `true` to show all languages by default.
+     */
     defaultExpandLanguages?: boolean;
+    /**
+     * Sets the focus on the first input when `true` is passed.
+     */
     isAutofocussed?: boolean;
+    /**
+     * Use this property to reduce the paddings of the component for a ui compact variant
+     */
     isCondensed?: boolean;
+    /**
+     * Disables all input fields.
+     */
     isDisabled?: boolean;
+    /**
+     * Disables all input fields and shows them in read-only mode.
+     */
     isReadOnly?: boolean;
+    /**
+     * Placeholders for each language. Object of the same shape as `value`.
+     */
     placeholder?: {
         [key: string]: string;
     };
+    /**
+     * Horizontal size limit of the input fields.
+     */
     horizontalConstraint?: 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
+    /**
+     * Will apply the error state to each input without showing any error message.
+     */
     hasError?: boolean;
+    /**
+     * Will apply the warning state to each input without showing any error message.
+     */
     hasWarning?: boolean;
+    /**
+     * Used to show errors underneath the inputs of specific locales. Pass an object whose key is a locale and whose value is the error to show for that key.
+     */
     errors?: {
         [key: string]: ReactNode;
     };
+    /**
+     * Used to show warnings underneath the inputs of specific locales. Pass an object whose key is a locale and whose value is the warning to show for that key.
+     */
     warnings?: {
         [key: string]: ReactNode;
     };
+    /**
+     * An object mapping locales to additional messages to be rendered below each input element.
+      Example:
+      {
+        en: 'Some value',
+        es: 'Algún valor',
+      }
+     */
     additionalInfo?: Record<string, string | ReactNode | (MessageDescriptor & {
         values: Record<string, ReactNode>;
     })>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/localized-multiline-text-input",
   "description": "A controlled text input component for localized multi-line strings with validation states.",
-  "version": "19.9.0",
+  "version": "19.11.0",
   "bugs": "https://github.com/commercetools/ui-kit/issues",
   "repository": {
     "type": "git",
@@ -21,17 +21,17 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/runtime-corejs3": "^7.20.13",
-    "@commercetools-uikit/constraints": "19.9.0",
-    "@commercetools-uikit/design-system": "19.9.0",
-    "@commercetools-uikit/flat-button": "19.9.0",
-    "@commercetools-uikit/hooks": "19.9.0",
-    "@commercetools-uikit/icons": "19.9.0",
-    "@commercetools-uikit/input-utils": "19.9.0",
-    "@commercetools-uikit/localized-utils": "19.9.0",
-    "@commercetools-uikit/messages": "19.9.0",
-    "@commercetools-uikit/spacings-stack": "19.9.0",
-    "@commercetools-uikit/text": "19.9.0",
-    "@commercetools-uikit/utils": "19.9.0",
+    "@commercetools-uikit/constraints": "19.11.0",
+    "@commercetools-uikit/design-system": "19.11.0",
+    "@commercetools-uikit/flat-button": "19.11.0",
+    "@commercetools-uikit/hooks": "19.11.0",
+    "@commercetools-uikit/icons": "19.11.0",
+    "@commercetools-uikit/input-utils": "19.11.0",
+    "@commercetools-uikit/localized-utils": "19.11.0",
+    "@commercetools-uikit/messages": "19.11.0",
+    "@commercetools-uikit/spacings-stack": "19.11.0",
+    "@commercetools-uikit/text": "19.11.0",
+    "@commercetools-uikit/utils": "19.11.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "prop-types": "15.8.1",