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

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

@@ -266,7 +266,7 @@ LocalizedTextInput.isTouched = localizedUtils.isTouched;
 var LocalizedTextInput$1 = LocalizedTextInput;
 
 // 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"] = LocalizedTextInput$1;
 exports.version = version;

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

@@ -204,7 +204,7 @@ LocalizedTextInput.isTouched = localizedUtils.isTouched;
 var LocalizedTextInput$1 = LocalizedTextInput;
 
 // 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"] = LocalizedTextInput$1;
 exports.version = version;

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

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

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

@@ -7,34 +7,113 @@ export type TLocalizedTextInputProps = {
     id?: string;
     name?: string;
     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;
+    /**
+     *   then input doesn't accept a "languages" prop, instead all possible
+    languages have to exist (with empty or filled strings) on the value:
+      { en: 'foo', de: '', es: '' }
+     */
     value: Record<string, string>;
+    /**
+     * Gets called when any input is changed. Is called with the change event of the changed input.
+     */
     onChange?: ChangeEventHandler<HTMLLocalizedInputElement>;
+    /**
+     * Specifies which language will be shown in case the `LocalizedTextInput` is collapsed.
+     */
     selectedLanguage: string;
+    /**
+     * Called when any field is blurred. Is called with the `event` of that field.
+     */
     onBlur?: FocusEventHandler<HTMLInputElement>;
+    /**
+     * Called when any field is focussed. Is called with the `event` of that field.
+     */
     onFocus?: FocusEventHandler<HTMLInputElement>;
+    /**
+     * 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
+     */
     defaultExpandLanguages?: boolean;
+    /**
+     * Focus the input field on initial render
+     */
     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?: Record<string, string>;
+    /**
+     * Horizontal size limit of the input fields.
+     */
     horizontalConstraint?: 1 | 2 | 3 | 4 | 5 | 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;
+    /**
+     * Indicates the input field has a warning
+     */
     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?: Record<string, ReactNode>;
+    /**
+     * A map of warnings.
+     */
     warnings?: Record<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>;
     })>;
 };
 export type TLocalizedInputProps = {
+    /**
+     * Used as prefix of HTML `id` property. Each input field id will have the language as a suffix (`${idPrefix}.${lang}`), e.g. `foo.en`. You can use the static `LocalizedTextInput.getId(idPrefix, language)` to create this id string, e.g. for labels.
+     */
     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;
     value: string;
+    /**
+     * Gets called when any input is changed. Is called with the change event of the changed input.
+     */
     onChange?: ChangeEventHandler<HTMLLocalizedInputElement>;
     language: string;
     onBlur?: FocusEventHandler<HTMLInputElement>;
@@ -44,6 +123,9 @@ export type TLocalizedInputProps = {
     isDisabled?: boolean;
     isReadOnly?: boolean;
     hasError?: boolean;
+    /**
+     * Indicates the input field has a warning
+     */
     hasWarning?: boolean;
     warning?: ReactNode;
     placeholder?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercetools-uikit/localized-text-input",
   "description": "A controlled text input component for localized single-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,18 +21,18 @@
   "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/text-input": "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/text-input": "19.11.0",
+    "@commercetools-uikit/utils": "19.11.0",
     "@emotion/react": "^11.10.5",
     "@emotion/styled": "^11.10.5",
     "prop-types": "15.8.1"