@commercetools-uikit/date-time-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.
@@ -427,7 +427,7 @@ DateTimeInput.propTypes = process.env.NODE_ENV !== "production" ? {
427
427
  var dateTimeInput = reactIntl.injectIntl(DateTimeInput);
428
428
 
429
429
  // NOTE: This string will be replaced on build time with the package version.
430
- var version = "19.9.0";
430
+ var version = "19.10.0";
431
431
 
432
432
  exports["default"] = dateTimeInput;
433
433
  exports.version = version;
@@ -403,7 +403,7 @@ DateTimeInput.propTypes = {};
403
403
  var dateTimeInput = reactIntl.injectIntl(DateTimeInput);
404
404
 
405
405
  // NOTE: This string will be replaced on build time with the package version.
406
- var version = "19.9.0";
406
+ var version = "19.10.0";
407
407
 
408
408
  exports["default"] = dateTimeInput;
409
409
  exports.version = version;
@@ -404,6 +404,6 @@ DateTimeInput.propTypes = process.env.NODE_ENV !== "production" ? {
404
404
  var dateTimeInput = injectIntl(DateTimeInput);
405
405
 
406
406
  // NOTE: This string will be replaced on build time with the package version.
407
- var version = "19.9.0";
407
+ var version = "19.10.0";
408
408
 
409
409
  export { dateTimeInput as default, version };
@@ -8,22 +8,75 @@ type TCustomEvent = {
8
8
  };
9
9
  };
10
10
  export type TDateTimeInputProps = {
11
+ /**
12
+ * Indicate if the value entered in the input is invalid.
13
+ */
11
14
  'aria-invalid'?: boolean;
15
+ /**
16
+ * HTML ID of an element containing an error message related to the input.
17
+ */
12
18
  'aria-errormessage'?: string;
19
+ /**
20
+ * Horizontal size limit of the input field.
21
+ */
13
22
  horizontalConstraint?: 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 'scale' | 'auto';
23
+ /**
24
+ * The selected date, must either be an empty string or a date formatted in ISO 8601 (e.g. "2018-10-04T09:00:00.000Z").
25
+ */
14
26
  value: string;
27
+ /**
28
+ * Called when the date changes. Called with an event containing an empty string (no value) or a string in this format: "YYYY-MM-DD".
29
+ */
15
30
  onChange?: (event: TCustomEvent) => void;
31
+ /**
32
+ * Called when the date input gains focus.
33
+ */
16
34
  onFocus?: FocusEventHandler<HTMLDivElement>;
35
+ /**
36
+ * Called when the date input loses focus.
37
+ */
17
38
  onBlur?: (event: TCustomEvent) => void;
39
+ /**
40
+ * Specifies the time zone in which the calendar and selected values are shown. It also influences how entered dates and times are parsed.
41
+ * Get list of timezone with `moment.tz.names()` [See moment docs](https://momentjs.com/timezone/docs/#/data-loading/getting-zone-names/)
42
+ */
18
43
  timeZone: string;
44
+ /**
45
+ * Used as the HTML `id` attribute.
46
+ */
19
47
  id?: string;
48
+ /**
49
+ * Used as the HTML `name` attribute.
50
+ */
20
51
  name?: string;
52
+ /**
53
+ * Placeholder value to show in the input field
54
+ */
21
55
  placeholder?: string;
56
+ /**
57
+ * Use this property to reduce the paddings of the component for a ui compact variant
58
+ */
22
59
  isCondensed?: boolean;
60
+ /**
61
+ * Disables the date picker
62
+ */
23
63
  isDisabled?: boolean;
64
+ /**
65
+ * Disables the date picker menu and sets the input field as read-only
66
+ */
24
67
  isReadOnly?: boolean;
68
+ /**
69
+ * Indicates the input field has an error
70
+ */
25
71
  hasError?: boolean;
72
+ /**
73
+ * Indicates the input field has a warning
74
+ */
26
75
  hasWarning?: boolean;
76
+ /**
77
+ * The time that will be used by default when a user selects a calendar day.
78
+ * It must follow the “HH:mm” pattern (eg: 04:30, 13:25, 23:59)
79
+ */
27
80
  defaultDaySelectionTime?: string;
28
81
  } & WrappedComponentProps;
29
82
  declare const _default: import("react").FC<import("react-intl").WithIntlProps<TDateTimeInputProps>> & {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@commercetools-uikit/date-time-input",
3
3
  "description": "The `DateTimeInput` component allows the user to select a date. This component also supports multiple date selection.",
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,19 +21,19 @@
21
21
  "dependencies": {
22
22
  "@babel/runtime": "^7.20.13",
23
23
  "@babel/runtime-corejs3": "^7.20.13",
24
- "@commercetools-uikit/accessible-button": "19.9.0",
25
- "@commercetools-uikit/calendar-time-utils": "19.9.0",
26
- "@commercetools-uikit/calendar-utils": "19.9.0",
27
- "@commercetools-uikit/constraints": "19.9.0",
28
- "@commercetools-uikit/design-system": "19.9.0",
29
- "@commercetools-uikit/hooks": "19.9.0",
30
- "@commercetools-uikit/icons": "19.9.0",
31
- "@commercetools-uikit/secondary-icon-button": "19.9.0",
32
- "@commercetools-uikit/select-utils": "19.9.0",
33
- "@commercetools-uikit/spacings-inline": "19.9.0",
34
- "@commercetools-uikit/text": "19.9.0",
35
- "@commercetools-uikit/tooltip": "19.9.0",
36
- "@commercetools-uikit/utils": "19.9.0",
24
+ "@commercetools-uikit/accessible-button": "19.10.0",
25
+ "@commercetools-uikit/calendar-time-utils": "19.10.0",
26
+ "@commercetools-uikit/calendar-utils": "19.10.0",
27
+ "@commercetools-uikit/constraints": "19.10.0",
28
+ "@commercetools-uikit/design-system": "19.10.0",
29
+ "@commercetools-uikit/hooks": "19.10.0",
30
+ "@commercetools-uikit/icons": "19.10.0",
31
+ "@commercetools-uikit/secondary-icon-button": "19.10.0",
32
+ "@commercetools-uikit/select-utils": "19.10.0",
33
+ "@commercetools-uikit/spacings-inline": "19.10.0",
34
+ "@commercetools-uikit/text": "19.10.0",
35
+ "@commercetools-uikit/tooltip": "19.10.0",
36
+ "@commercetools-uikit/utils": "19.10.0",
37
37
  "@emotion/react": "^11.10.5",
38
38
  "@emotion/styled": "^11.10.5",
39
39
  "downshift": "6.1.12",