@commercetools-uikit/multiline-text-input 19.9.0 → 19.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -185,7 +185,7 @@ MultilineTextInput.defaultProps = defaultProps;
185
185
  var MultilineTextInput$1 = MultilineTextInput;
186
186
 
187
187
  // NOTE: This string will be replaced on build time with the package version.
188
- var version = "19.9.0";
188
+ var version = "19.10.0";
189
189
 
190
190
  exports["default"] = MultilineTextInput$1;
191
191
  exports.version = version;
@@ -145,7 +145,7 @@ MultilineTextInput.defaultProps = defaultProps;
145
145
  var MultilineTextInput$1 = MultilineTextInput;
146
146
 
147
147
  // NOTE: This string will be replaced on build time with the package version.
148
- var version = "19.9.0";
148
+ var version = "19.10.0";
149
149
 
150
150
  exports["default"] = MultilineTextInput$1;
151
151
  exports.version = version;
@@ -163,6 +163,6 @@ MultilineTextInput.defaultProps = defaultProps;
163
163
  var MultilineTextInput$1 = MultilineTextInput;
164
164
 
165
165
  // NOTE: This string will be replaced on build time with the package version.
166
- var version = "19.9.0";
166
+ var version = "19.10.0";
167
167
 
168
168
  export { MultilineTextInput$1 as default, version };
@@ -1,26 +1,93 @@
1
1
  import { type ChangeEventHandler, type FocusEventHandler, ReactElement } from 'react';
2
2
  import { type TSecondaryButtonIconProps } from '@commercetools-uikit/secondary-icon-button';
3
3
  export type TMultilineTextInputProps = {
4
+ /**
5
+ * Used as HTML name of the input component. property
6
+ */
4
7
  name?: string;
8
+ /**
9
+ * Indicate if the value entered in the input is invalid.
10
+ */
5
11
  'aria-invalid'?: boolean;
12
+ /**
13
+ * HTML ID of an element containing an error message related to the input.
14
+ */
6
15
  'aria-errormessage'?: string;
16
+ /**
17
+ * Used as HTML `autocomplete` property
18
+ */
7
19
  autoComplete?: string;
20
+ /**
21
+ * Used as HTML id property. An id is auto-generated when it is not specified.
22
+ */
8
23
  id?: string;
24
+ /**
25
+ * Value of the input component.
26
+ */
9
27
  value: string;
28
+ /**
29
+ * Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value.
30
+ */
10
31
  onChange?: ChangeEventHandler<HTMLTextAreaElement>;
32
+ /**
33
+ * Called when input is blurred
34
+ */
11
35
  onBlur?: FocusEventHandler<HTMLTextAreaElement>;
36
+ /**
37
+ * Called when input is focused
38
+ */
12
39
  onFocus?: FocusEventHandler<HTMLTextAreaElement>;
40
+ /**
41
+ * Focus the input on initial render
42
+ */
13
43
  isAutofocussed?: boolean;
44
+ /**
45
+ * Expands multiline text input initially
46
+ */
14
47
  defaultExpandMultilineText?: boolean;
48
+ /**
49
+ * Indicates that the input cannot be modified (e.g not authorized, or changes currently saving).
50
+ */
15
51
  isDisabled?: boolean;
52
+ /**
53
+ * Indicates that the field is displaying read-only content
54
+ */
16
55
  isReadOnly?: boolean;
56
+ /**
57
+ * Placeholder text for the input
58
+ */
17
59
  placeholder?: string;
60
+ /**
61
+ * Indicates that input has errors
62
+ */
18
63
  hasError?: boolean;
64
+ /**
65
+ * Control to indicate on the input if there are selected values that are potentially invalid
66
+ */
19
67
  hasWarning?: boolean;
68
+ /**
69
+ * Horizontal size limit of the input fields.
70
+ */
20
71
  horizontalConstraint?: 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
72
+ /**
73
+ * Custom action icon to be displayed on the right side of the input.
74
+ */
21
75
  rightActionIcon?: ReactElement;
76
+ /**
77
+ * Props for the right-action icon-button. Required when rightActionIcon is provided.
78
+ * At least a `label` and an `onClick` prop/function need to be provided.
79
+ */
22
80
  rightActionProps?: TSecondaryButtonIconProps;
81
+ /**
82
+ * Set this to `true` to reduce the paddings of the input allowing the input to display
83
+ * more data in less space.
84
+ *
85
+ */
23
86
  isCondensed?: boolean;
87
+ /**
88
+ * Set this to value to determine the maximum text rows of the text area.
89
+ * Any text overflow past this row number would implement a scroll
90
+ */
24
91
  maxRows?: number;
25
92
  };
26
93
  declare const MultilineTextInput: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@commercetools-uikit/multiline-text-input",
3
3
  "description": "A controlled text input component for multi-line strings with validation states.",
4
- "version": "19.9.0",
4
+ "version": "19.10.0",
5
5
  "bugs": "https://github.com/commercetools/ui-kit/issues",
6
6
  "repository": {
7
7
  "type": "git",
@@ -21,17 +21,17 @@
21
21
  "dependencies": {
22
22
  "@babel/runtime": "^7.20.13",
23
23
  "@babel/runtime-corejs3": "^7.20.13",
24
- "@commercetools-uikit/constraints": "19.9.0",
25
- "@commercetools-uikit/design-system": "19.9.0",
26
- "@commercetools-uikit/flat-button": "19.9.0",
27
- "@commercetools-uikit/hooks": "19.9.0",
28
- "@commercetools-uikit/icons": "19.9.0",
29
- "@commercetools-uikit/input-utils": "19.9.0",
30
- "@commercetools-uikit/secondary-icon-button": "19.9.0",
31
- "@commercetools-uikit/spacings-inline": "19.9.0",
32
- "@commercetools-uikit/spacings-stack": "19.9.0",
33
- "@commercetools-uikit/tooltip": "19.9.0",
34
- "@commercetools-uikit/utils": "19.9.0",
24
+ "@commercetools-uikit/constraints": "19.10.0",
25
+ "@commercetools-uikit/design-system": "19.10.0",
26
+ "@commercetools-uikit/flat-button": "19.10.0",
27
+ "@commercetools-uikit/hooks": "19.10.0",
28
+ "@commercetools-uikit/icons": "19.10.0",
29
+ "@commercetools-uikit/input-utils": "19.10.0",
30
+ "@commercetools-uikit/secondary-icon-button": "19.10.0",
31
+ "@commercetools-uikit/spacings-inline": "19.10.0",
32
+ "@commercetools-uikit/spacings-stack": "19.10.0",
33
+ "@commercetools-uikit/tooltip": "19.10.0",
34
+ "@commercetools-uikit/utils": "19.10.0",
35
35
  "@emotion/react": "^11.10.5",
36
36
  "@emotion/styled": "^11.10.5",
37
37
  "downshift": "6.1.12",