@shopify/ui-extensions 2025.10.0-rc.45 → 2025.10.0-rc.46

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.
Files changed (86) hide show
  1. package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
  2. package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +3 -1
  3. package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts.map +1 -1
  4. package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +7 -9
  5. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts.map +1 -1
  6. package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +6 -2
  7. package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts.map +1 -1
  8. package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +10 -2
  9. package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts +4 -0
  10. package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts.map +1 -0
  11. package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts.map +1 -1
  12. package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +9 -2
  13. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts.map +1 -1
  14. package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +19 -20
  15. package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts.map +1 -1
  16. package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +6 -2
  17. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts.map +1 -1
  18. package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +9 -2
  19. package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts.map +1 -1
  20. package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +17 -2
  21. package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.doc.d.ts.map +1 -1
  22. package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +8 -4
  23. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts.map +1 -1
  24. package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +6 -2
  25. package/build/tsconfig.tsbuildinfo +1 -1
  26. package/package.json +13 -3
  27. package/src/surfaces/point-of-sale/components/Banner/examples/default.html +8 -8
  28. package/src/surfaces/point-of-sale/components/Box/examples/default.html +2 -2
  29. package/src/surfaces/point-of-sale/components/Button/examples/default.html +2 -4
  30. package/src/surfaces/point-of-sale/components/ChoiceList/examples/default.html +5 -4
  31. package/src/surfaces/point-of-sale/components/ChoiceList/examples/event-handling.jsx +8 -0
  32. package/src/surfaces/point-of-sale/components/ChoiceList/examples/multiple-selection.jsx +9 -0
  33. package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +3 -1
  34. package/src/surfaces/point-of-sale/components/Clickable/examples/default.html +5 -2
  35. package/src/surfaces/point-of-sale/components/DateField/examples/default.html +2 -10
  36. package/src/surfaces/point-of-sale/components/DateField/examples/event-handling.jsx +8 -0
  37. package/src/surfaces/point-of-sale/components/DateField.d.ts +7 -9
  38. package/src/surfaces/point-of-sale/components/DatePicker/examples/command-system.jsx +10 -0
  39. package/src/surfaces/point-of-sale/components/DatePicker/examples/default.html +4 -5
  40. package/src/surfaces/point-of-sale/components/DatePicker/examples/event-handling.jsx +7 -0
  41. package/src/surfaces/point-of-sale/components/DatePicker.d.ts +6 -2
  42. package/src/surfaces/point-of-sale/components/DateSpinner/examples/command-system.jsx +10 -0
  43. package/src/surfaces/point-of-sale/components/DateSpinner/examples/default.html +1 -2
  44. package/src/surfaces/point-of-sale/components/DateSpinner/examples/event-handling.jsx +7 -0
  45. package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +10 -2
  46. package/src/surfaces/point-of-sale/components/Divider/examples/default.html +1 -0
  47. package/src/surfaces/point-of-sale/components/EmailField/examples/accessory-slot.jsx +9 -0
  48. package/src/surfaces/point-of-sale/components/EmailField/examples/default.html +3 -10
  49. package/src/surfaces/point-of-sale/components/EmailField/examples/event-handling.jsx +8 -0
  50. package/src/surfaces/point-of-sale/components/EmailField.d.ts +9 -2
  51. package/src/surfaces/point-of-sale/components/Heading/examples/default.html +4 -5
  52. package/src/surfaces/point-of-sale/components/Icon/examples/default.html +4 -1
  53. package/src/surfaces/point-of-sale/components/Image/examples/default.html +1 -1
  54. package/src/surfaces/point-of-sale/components/Modal/examples/default.html +6 -8
  55. package/src/surfaces/point-of-sale/components/NumberField/examples/controls-constraints.jsx +9 -0
  56. package/src/surfaces/point-of-sale/components/NumberField/examples/default.html +5 -2
  57. package/src/surfaces/point-of-sale/components/NumberField/examples/input-mode.jsx +15 -0
  58. package/src/surfaces/point-of-sale/components/NumberField.d.ts +19 -20
  59. package/src/surfaces/point-of-sale/components/Page/examples/default.html +3 -4
  60. package/src/surfaces/point-of-sale/components/PosBlock/examples/default.html +3 -9
  61. package/src/surfaces/point-of-sale/components/ScrollBox/examples/default.html +5 -4
  62. package/src/surfaces/point-of-sale/components/SearchField/examples/default.html +1 -1
  63. package/src/surfaces/point-of-sale/components/SearchField/examples/event-handling.jsx +8 -0
  64. package/src/surfaces/point-of-sale/components/SearchField.d.ts +6 -2
  65. package/src/surfaces/point-of-sale/components/Section/examples/default.html +6 -8
  66. package/src/surfaces/point-of-sale/components/Stack/examples/default.html +3 -3
  67. package/src/surfaces/point-of-sale/components/Text/examples/default.html +3 -6
  68. package/src/surfaces/point-of-sale/components/TextArea/examples/accessory-slot.jsx +9 -0
  69. package/src/surfaces/point-of-sale/components/TextArea/examples/default.html +4 -1
  70. package/src/surfaces/point-of-sale/components/TextArea/examples/event-handling.jsx +8 -0
  71. package/src/surfaces/point-of-sale/components/TextArea/examples/rows-configuration.jsx +7 -0
  72. package/src/surfaces/point-of-sale/components/TextArea.d.ts +9 -2
  73. package/src/surfaces/point-of-sale/components/TextField/examples/accessory-slot.jsx +5 -0
  74. package/src/surfaces/point-of-sale/components/TextField/examples/common-props.jsx +11 -0
  75. package/src/surfaces/point-of-sale/components/TextField/examples/default.html +5 -3
  76. package/src/surfaces/point-of-sale/components/TextField/examples/event-handling.jsx +17 -0
  77. package/src/surfaces/point-of-sale/components/TextField.d.ts +17 -2
  78. package/src/surfaces/point-of-sale/components/Tile/examples/default.html +2 -5
  79. package/src/surfaces/point-of-sale/components/TimeField/examples/default.html +1 -9
  80. package/src/surfaces/point-of-sale/components/TimeField/examples/event-handling.jsx +8 -0
  81. package/src/surfaces/point-of-sale/components/TimeField.d.ts +8 -4
  82. package/src/surfaces/point-of-sale/components/TimePicker/examples/command-system.jsx +10 -0
  83. package/src/surfaces/point-of-sale/components/TimePicker/examples/default.html +4 -1
  84. package/src/surfaces/point-of-sale/components/TimePicker/examples/event-handling.jsx +7 -0
  85. package/src/surfaces/point-of-sale/components/TimePicker.d.ts +6 -2
  86. package/src/surfaces/point-of-sale/components.d.ts +169 -72
@@ -1 +1 @@
1
- {"version":3,"file":"ChoiceList.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAwCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"ChoiceList.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -39,8 +39,10 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
39
39
  declare const tagName = 's-choice-list';
40
40
  export interface ChoiceListJSXProps
41
41
  extends Pick<ChoiceListProps, 'values' | 'multiple'> {
42
- onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
42
+ /** Function called when the user changes a choice. Fires simultaneously with onChange. */
43
43
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
44
+ /** Function called when the user changes a choice. Fires simultaneously with onInput. */
45
+ onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
44
46
  children?: ComponentChildren;
45
47
  }
46
48
  declare global {
@@ -1 +1 @@
1
- {"version":3,"file":"DateField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateField/DateField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"DateField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateField/DateField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -8,12 +8,7 @@
8
8
  /* eslint-disable import-x/namespace */
9
9
  // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
10
10
  /// <reference lib="DOM" />
11
- import type {
12
- DateFieldProps,
13
- Key,
14
- Ref,
15
- ComponentChild,
16
- } from './components-shared.d.ts';
11
+ import type {DateFieldProps, Key, Ref} from './components-shared.d.ts';
17
12
 
18
13
  export type ComponentChildren = any;
19
14
  /**
@@ -47,11 +42,14 @@ export interface DateFieldJSXProps
47
42
  DateFieldProps,
48
43
  'label' | 'details' | 'value' | 'disabled' | 'error'
49
44
  > {
45
+ /** Function called when the user makes any changes in the field. */
50
46
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
51
- onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
52
- onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
47
+ /** Function called after editing completes (typically on blur). */
53
48
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
54
- accessory?: ComponentChild;
49
+ /** Function called when the element loses focus. */
50
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
51
+ /** Function called when the element receives focus. */
52
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
55
53
  }
56
54
  declare global {
57
55
  interface HTMLElementTagNameMap {
@@ -1 +1 @@
1
- {"version":3,"file":"DatePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"DatePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -39,10 +39,14 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
39
39
  declare const tagName = 's-date-picker';
40
40
  export interface DatePickerJSXProps
41
41
  extends Pick<DatePickerProps, 'id' | 'value'> {
42
+ /** Function called when the user selects a date from the picker. */
43
+ onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
44
+ /** Function called when the user selects a date from the picker that is different to the current value. */
45
+ onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
46
+ /** Function called when the date picker is dismissed. */
42
47
  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
48
+ /** Function called when the date picker is revealed. */
43
49
  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
44
- onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
45
- onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
46
50
  }
47
51
  declare global {
48
52
  interface HTMLElementTagNameMap {
@@ -1 +1 @@
1
- {"version":3,"file":"DateSpinner.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"DateSpinner.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -39,10 +39,18 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
39
39
  declare const tagName = 's-date-spinner';
40
40
  export interface DateSpinnerJSXProps
41
41
  extends Pick<DateSpinnerProps, 'id' | 'value'> {
42
+ /**
43
+ * Function called when the user makes a selection.
44
+ */
45
+ onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
46
+ /**
47
+ * Function called when the value changes. Only called when a different value is selected.
48
+ */
49
+ onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
50
+ /** Function called when the date picker is dismissed. */
42
51
  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
52
+ /** Function called when the date picker is revealed. */
43
53
  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
44
- onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
45
- onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
46
54
  }
47
55
  declare global {
48
56
  interface HTMLElementTagNameMap {
@@ -0,0 +1,4 @@
1
+ import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
2
+ declare const data: ReferenceEntityTemplateSchema;
3
+ export default data;
4
+ //# sourceMappingURL=Divider.doc.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Divider.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Divider/Divider.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA6BX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"EmailField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/EmailField/EmailField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"EmailField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/EmailField/EmailField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -54,10 +54,17 @@ export interface EmailFieldJSXProps
54
54
  | 'maxLength'
55
55
  | 'details'
56
56
  > {
57
+ /** Function called when the user makes any changes in the field. */
57
58
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
58
- onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
59
- onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
59
+ /** Function called after editing completes (typically on blur). */
60
60
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
61
+ /** Function called when the element loses focus. */
62
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
63
+ /** Function called when the element receives focus. */
64
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
65
+ /**
66
+ * Additional content to be displayed in the field. Commonly used to display clickable text.
67
+ */
61
68
  accessory?: ComponentChild;
62
69
  }
63
70
  declare global {
@@ -1 +1 @@
1
- {"version":3,"file":"NumberField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/NumberField/NumberField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"NumberField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/NumberField/NumberField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAwEX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -42,7 +42,7 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
42
42
  }
43
43
 
44
44
  declare const tagName = 's-number-field';
45
- export interface PickedJSXProps
45
+ export interface NumberFieldJSXProps
46
46
  extends Pick<
47
47
  NumberFieldProps,
48
48
  | 'label'
@@ -56,20 +56,12 @@ export interface PickedJSXProps
56
56
  | 'min'
57
57
  | 'controls'
58
58
  > {
59
- inputMode?: Extract<NumberFieldProps['inputMode'], 'decimal' | 'numeric'>;
60
- onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
61
- onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
62
- onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
63
- onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
64
- accessory?: ComponentChild;
65
- }
66
- export interface NumberFieldJSXProps extends PickedJSXProps {
67
59
  /**
68
60
  * Content to use as the field label.
69
61
  *
70
62
  * Label is not supported when using Stepper controls
71
63
  */
72
- label?: PickedJSXProps['label'];
64
+ label?: NumberFieldProps['label'];
73
65
  /**
74
66
  * Additional text to provide context or guidance for the field.
75
67
  * This text is displayed along with the field and its label
@@ -79,7 +71,7 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
79
71
  *
80
72
  * Details are not supported when using Stepper controls
81
73
  */
82
- details?: PickedJSXProps['details'];
74
+ details?: NumberFieldProps['details'];
83
75
  /**
84
76
  * Whether the field needs a value. This requirement adds semantic value
85
77
  * to the field, but it will not cause an error to appear automatically.
@@ -90,14 +82,14 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
90
82
  *
91
83
  * Required is not supported when using Stepper controls
92
84
  */
93
- required?: PickedJSXProps['required'];
85
+ required?: NumberFieldProps['required'];
94
86
  /**
95
87
  * Indicate an error to the user. The field will be given a specific stylistic treatment
96
88
  * to communicate problems that have to be resolved immediately.
97
89
  *
98
90
  * Error is not supported when using Stepper controls
99
91
  */
100
- error?: PickedJSXProps['error'];
92
+ error?: NumberFieldProps['error'];
101
93
  /**
102
94
  * Sets the virtual keyboard.
103
95
  *
@@ -106,20 +98,19 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
106
98
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
107
99
  * @default 'decimal'
108
100
  */
109
- inputMode?: PickedJSXProps['inputMode'];
101
+ inputMode?: NumberFieldProps['inputMode'];
110
102
  /**
111
103
  * A short hint that describes the expected value of the field.
112
104
  *
113
105
  * Placeholder text is not supported when using Stepper controls due to constrained space for the number field, especially on phones.
114
106
  */
115
- placeholder?: PickedJSXProps['placeholder'];
107
+ placeholder?: NumberFieldProps['placeholder'];
116
108
  /**
117
- * Additional content to be displayed in the field.
118
- * Commonly used to display an icon that activates a tooltip providing more information.
109
+ * Additional content to be displayed in the field. Commonly used to display clickable text.
119
110
  *
120
- * Accessory is not supported when using Stepper controls
111
+ * > Note: Accessory is not supported when using Stepper controls
121
112
  */
122
- accessory?: PickedJSXProps['accessory'];
113
+ accessory?: ComponentChild;
123
114
  /**
124
115
  * Sets the type of controls displayed for the field.
125
116
  *
@@ -130,7 +121,15 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
130
121
  * - `none`: no controls are displayed and users must input the value manually.
131
122
  * - `auto`: the presence of the controls depends on the surface and context.
132
123
  */
133
- controls?: PickedJSXProps['controls'];
124
+ controls?: NumberFieldProps['controls'];
125
+ /** Function called when the user makes any changes in the field. */
126
+ onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
127
+ /** Function called after editing completes (typically on blur). */
128
+ onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
129
+ /** Function called when the element loses focus. */
130
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
131
+ /** Function called when the element receives focus. */
132
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
134
133
  }
135
134
  declare global {
136
135
  interface HTMLElementTagNameMap {
@@ -1 +1 @@
1
- {"version":3,"file":"SearchField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/SearchField/SearchField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"SearchField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/SearchField/SearchField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -39,10 +39,14 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
39
39
  declare const tagName = 's-search-field';
40
40
  export interface SearchFieldJSXProps
41
41
  extends Pick<SearchFieldProps, 'disabled' | 'placeholder' | 'value'> {
42
- onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
43
- onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
42
+ /** Function called when the user changes the value in the field. */
44
43
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
44
+ /** Function called when the field loses focus after the user changes the value in the field. */
45
45
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
46
+ /** Function called when the field loses focus. */
47
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
48
+ /** Function called when the field is focused. */
49
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
46
50
  }
47
51
  declare global {
48
52
  interface HTMLElementTagNameMap {
@@ -1 +1 @@
1
- {"version":3,"file":"TextArea.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextArea/TextArea.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"TextArea.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextArea/TextArea.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAmFX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -55,10 +55,17 @@ export interface TextAreaJSXProps
55
55
  | 'maxLength'
56
56
  | 'rows'
57
57
  > {
58
+ /** Function called when the user makes any changes in the field. */
58
59
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
59
- onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
60
- onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
60
+ /** Function called after editing completes (typically on blur). */
61
61
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
62
+ /** Function called when the element loses focus. */
63
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
64
+ /** Function called when the element receives focus. */
65
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
66
+ /**
67
+ * Additional content to be displayed in the field. Commonly used to display clickable text.
68
+ */
62
69
  accessory?: ComponentChild;
63
70
  }
64
71
  declare global {
@@ -1 +1 @@
1
- {"version":3,"file":"TextField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextField/TextField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"TextField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextField/TextField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqFX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -54,10 +54,25 @@ export interface TextFieldJSXProps
54
54
  | 'required'
55
55
  | 'maxLength'
56
56
  > {
57
+ /**
58
+ * Function called when the user makes any changes in the field.
59
+ */
57
60
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
58
- onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
59
- onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
61
+ /**
62
+ * Function called after editing completes (typically on blur).
63
+ */
60
64
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
65
+ /**
66
+ * Function called when the element loses focus.
67
+ */
68
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
69
+ /**
70
+ * Function called when the element receives focus.
71
+ */
72
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
73
+ /**
74
+ * Additional content to be displayed in the field. Commonly used to display clickable text.
75
+ */
61
76
  accessory?: ComponentChild;
62
77
  }
63
78
  declare global {
@@ -1 +1 @@
1
- {"version":3,"file":"TimeField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimeField/TimeField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"TimeField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimeField/TimeField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -42,10 +42,14 @@ export interface TimeFieldJSXProps
42
42
  TimeFieldProps,
43
43
  'id' | 'label' | 'disabled' | 'value' | 'error' | 'details'
44
44
  > {
45
- onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
46
- onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
47
- onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
48
- onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
45
+ /** Function called when the user makes any changes in the field. */
46
+ onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
47
+ /** Function called after editing completes (typically on blur). */
48
+ onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
49
+ /** Function called when the element loses focus. */
50
+ onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
51
+ /** Function called when the element receives focus. */
52
+ onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
49
53
  }
50
54
  declare global {
51
55
  interface HTMLElementTagNameMap {
@@ -1 +1 @@
1
- {"version":3,"file":"TimePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAiCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
1
+ {"version":3,"file":"TimePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA+DX,CAAC;AAEF,eAAe,IAAI,CAAC"}
@@ -39,10 +39,14 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
39
39
  declare const tagName = 's-time-picker';
40
40
  export interface TimePickerJSXProps
41
41
  extends Pick<TimePickerProps, 'id' | 'value'> {
42
+ /** Function called when the user selects a time from the picker. */
43
+ onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
44
+ /** Function called when the user selects a time from the picker that is different to the current value. */
45
+ onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
46
+ /** Function called when the time picker is dismissed. */
42
47
  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
48
+ /** Function called when the time picker is revealed. */
43
49
  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
44
- onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
45
- onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
46
50
  }
47
51
  declare global {
48
52
  interface HTMLElementTagNameMap {