LocalizedMultilineTextField

Description

A controlled text input component for localized multi-line strings with validation states.

Installation

yarn add @commercetools-uikit/localized-multiline-text-field

npm --save install @commercetools-uikit/localized-multiline-text-field

Additionally install the peer dependencies (if not present)

yarn add react

npm --save install react

Usage

import LocalizedMultilineTextField from '@commercetools-uikit/localized-multiline-text-field';

const Example = () => (
  <LocalizedMultilineTextField
    title="Description"
    value={{
      en: 'Parrot that knows how to party',
      de: 'Papagei der ordentlich abfeiert',
    }}
    selectedLanguage="en"
    onChange={(event) => alert(event.target.value)}
  />
);

export default Example;

Properties

Props	Type	Required	Default	Description
`id`	`string`			Used as HTML id property. An id is auto-generated when it is not specified.
`horizontalConstraint`	`union` Possible values: `, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto'`		`'scale'`	Horizontal size limit of the input fields.
`errors`	`Record`			A map of errors. Error messages for known errors are rendered automatically. Unknown errors will be forwarded to `renderError`
`renderError`	`Function` See signature.			Called with custom errors. This function can return a message which will be wrapped in an ErrorMessage. It can also return null to show no error.
`warnings`	`Record`			A map of warnings. Warning messages for known warnings are rendered automatically. Unknown warnings will be forwarded to renderWarning.
`renderWarning`	`Function` See signature.			Called with custom warnings, as renderWarning(key, warning). This function can return a message which will be wrapped in a WarningMessage. It can also return null to show no warning.
`additionalInfo`	`Record`			An object mapping locales to additional messages to be rendered below each input element. Example: { en: 'Some value', es: 'Algún valor', }
`isRequired`	`boolean`			Indicates if the value is required. Shows an the "required asterisk" if so.
`touched`	`boolean`			Indicates whether the field was touched. Errors will only be shown when the field was touched.
`autoComplete`	`string`			Used as HTML `autocomplete` property
`name`	`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`
`value`	`Object` See signature.	✅		Values to use. Keyed by language, the values are the actual values, e.g. `{ en: 'Horse', de: 'Pferd' }` The 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: '' }
`onChange`	`ChangeEventHandler`			Gets called when any input is changed. Is called with the change event of the changed input.
`selectedLanguage`	`string`	✅		Specifies which language will be shown in case the `LocalizedTextInput` is collapsed.
`onBlur`	`FocusEventHandler`			Called when input is blurred
`onFocus`	`Function` See signature.			Called when input is focused
`defaultExpandMultilineText`	`boolean`			Expands input components holding multiline values instead of collpasing them by default.
`hideLanguageExpansionControls`	`boolean`			Will hide the language expansion controls when set to `true`. All languages will be shown when set to `true`.
`defaultExpandLanguages`	`boolean`			Controls whether one or all languages are visible by default. Pass `true` to show all languages by default.
`isAutofocussed`	`boolean`			Sets the focus on the first input when `true` is passed.
`isDisabled`	`boolean`			Disables all input fields.
`isReadOnly`	`boolean`			Disables all input fields and shows them in read-only mode.
`placeholder`	`Object` See signature.			Placeholders for each language. Object of the same shape as `value`.
`errorsByLanguage`	`Object` See signature.			Errors for each translation. These are forwarded to the `errors` prop of `LocalizedTextInput`.
`title`	`union` Possible values: `string , ReactNode`	✅		Title of the label
`hint`	`union` Possible values: `string , ReactNode`			Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas description can describe it in more depth. Can also receive a hintIcon.
`description`	`union` Possible values: `string , ReactNode`			Provides a description for the title.
`onInfoButtonClick`	`Function` See signature.			Function called when info button is pressed. Info button will only be visible when this prop is passed.
`hintIcon`	`ReactElement`			Icon to be displayed beside the hint text. Will only get rendered when hint is passed as well.
`badge`	`ReactNode`			Badge to be displayed beside the label. Might be used to display additional information about the content of the field (E.g verified email)

Signatures

Signature `renderError`

(key: string, error?: boolean) => ReactNode;

Signature `renderWarning`

(key: string, warning?: boolean) => ReactNode;

Signature `value`

{
  [key: string]: string;
}

Signature `onFocus`

() => void

Signature `placeholder`

{
  [key: string]: string;
}

Signature `errorsByLanguage`

{
  [key: string]: ReactNode;
}

Signature `onInfoButtonClick`

() => void

`data-*` props

The component further forwards all data- attributes to the underlying input component.

`errors`

This object is a key-value map. The renderError prop will be called for each entry with the key and the value. The return value will be rendered inside an ErrorMessage component underneath the input.

The LocalizedMultilineTextField supports some errors out of the box. Return undefined from renderError for these and the default errors will be shown instead. This prevents consumers from having to reimplement the same error messages for known errors while still keeping the flexibility of showing custom error messages for them.

When the key is known, and when the value is truthy, and when renderError returned undefined for that error entry, then the LocalizedMultilineTextField will render an appropriate error automatically.

Known error keys are:

missing: tells the user that this field is required

Static methods