@commercetools-uikit/search-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.
@@ -171,7 +171,7 @@ SearchTextInput.isEmpty = isEmpty;
171
171
  var SearchTextInput$1 = SearchTextInput;
172
172
 
173
173
  // NOTE: This string will be replaced on build time with the package version.
174
- var version = "19.9.0";
174
+ var version = "19.10.0";
175
175
 
176
176
  exports["default"] = SearchTextInput$1;
177
177
  exports.version = version;
@@ -169,7 +169,7 @@ SearchTextInput.isEmpty = isEmpty;
169
169
  var SearchTextInput$1 = SearchTextInput;
170
170
 
171
171
  // NOTE: This string will be replaced on build time with the package version.
172
- var version = "19.9.0";
172
+ var version = "19.10.0";
173
173
 
174
174
  exports["default"] = SearchTextInput$1;
175
175
  exports.version = version;
@@ -153,6 +153,6 @@ SearchTextInput.isEmpty = isEmpty;
153
153
  var SearchTextInput$1 = SearchTextInput;
154
154
 
155
155
  // NOTE: This string will be replaced on build time with the package version.
156
- var version = "19.9.0";
156
+ var version = "19.10.0";
157
157
 
158
158
  export { SearchTextInput$1 as default, version };
@@ -1,24 +1,86 @@
1
1
  import { type FocusEventHandler, type ChangeEventHandler, type ForwardRefExoticComponent, type RefAttributes } from 'react';
2
2
  export type TSearchTextInputProps = {
3
+ /**
4
+ * Used as HTML id property. An id is auto-generated when it is not specified.
5
+ */
3
6
  id?: string;
7
+ /**
8
+ * Used as HTML autocomplete property
9
+ */
4
10
  autoComplete?: string;
11
+ /**
12
+ * Indicate if the value entered in the input is invalid.
13
+ */
5
14
  'aria-invalid'?: boolean;
15
+ /**
16
+ * HTML ID of an element containing an error message related to the input.
17
+ */
6
18
  'aria-errormessage'?: string;
19
+ /**
20
+ * Used as HTML name of the input component property.
21
+ */
7
22
  name?: string;
23
+ /**
24
+ * Value of the input component.
25
+ */
8
26
  value: string;
27
+ /**
28
+ * Called with an event containing the new value. Required when input is not read only. Parent should pass it back as value.
29
+ */
9
30
  onChange?: ChangeEventHandler<HTMLInputElement>;
31
+ /**
32
+ * Called when input is blurred
33
+ */
10
34
  onBlur?: FocusEventHandler<HTMLInputElement>;
35
+ /**
36
+ * Called when input is focused
37
+ */
11
38
  onFocus?: FocusEventHandler<HTMLInputElement>;
39
+ /**
40
+ * Handler when the search button is clicked.
41
+ */
12
42
  onSubmit: (searchValue: string) => void;
43
+ /**
44
+ * Handler when the clear button is clicked.
45
+ */
13
46
  onReset: () => void;
47
+ /**
48
+ * Focus the input on initial render
49
+ */
14
50
  isAutofocussed?: boolean;
51
+ /**
52
+ * Use this property to reduce the paddings of the component for a ui compact variant
53
+ */
15
54
  isCondensed?: boolean;
55
+ /**
56
+ * Indicates that the input cannot be modified (e.g not authorized, or changes currently saving).
57
+ */
16
58
  isDisabled?: boolean;
59
+ /**
60
+ * Indicates that the field is displaying read-only content
61
+ */
17
62
  isReadOnly?: boolean;
63
+ /**
64
+ * Indicates if the input has invalid values
65
+ */
18
66
  hasError?: boolean;
67
+ /**
68
+ * Indicates if the input has warning values
69
+ */
19
70
  hasWarning?: boolean;
71
+ /**
72
+ * Placeholder text for the input
73
+ */
20
74
  placeholder?: string;
75
+ /**
76
+ * Indicates if the input should be cleared when the clear button is clicked.
77
+ * Defaults to true.
78
+ *
79
+ */
21
80
  isClearable?: boolean;
81
+ /**
82
+ * Horizontal size limit of the input fields.
83
+ */
22
84
  horizontalConstraint?: 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
23
85
  };
24
86
  type StaticProps = {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@commercetools-uikit/search-text-input",
3
3
  "description": "A controlled search text input component for single-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,12 +21,12 @@
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/icons": "19.9.0",
27
- "@commercetools-uikit/input-utils": "19.9.0",
28
- "@commercetools-uikit/secondary-icon-button": "19.9.0",
29
- "@commercetools-uikit/utils": "19.9.0",
24
+ "@commercetools-uikit/constraints": "19.10.0",
25
+ "@commercetools-uikit/design-system": "19.10.0",
26
+ "@commercetools-uikit/icons": "19.10.0",
27
+ "@commercetools-uikit/input-utils": "19.10.0",
28
+ "@commercetools-uikit/secondary-icon-button": "19.10.0",
29
+ "@commercetools-uikit/utils": "19.10.0",
30
30
  "@emotion/react": "^11.10.5",
31
31
  "@emotion/styled": "^11.10.5",
32
32
  "prop-types": "15.8.1"