@shopify/ui-extensions 2026.4.3 → 2026.4.4

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 (74) hide show
  1. package/build/ts/surfaces/admin/components/Badge.d.ts +1 -1
  2. package/build/ts/surfaces/admin/components/Button.d.ts +1 -1
  3. package/build/ts/surfaces/admin/components/Clickable.d.ts +7 -7
  4. package/build/ts/surfaces/admin/components/Grid.d.ts +12 -12
  5. package/build/ts/surfaces/admin/components/GridItem.d.ts +7 -7
  6. package/build/ts/surfaces/admin/components/Image.d.ts +7 -7
  7. package/build/ts/surfaces/admin/components/Stack.d.ts +11 -11
  8. package/build/ts/surfaces/admin/components/TextField.d.ts +1 -1
  9. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +0 -3
  10. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  11. package/build/ts/surfaces/checkout/components/Checkbox.d.ts +12 -4
  12. package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +12 -4
  13. package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +5 -5
  14. package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +99 -99
  15. package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +1 -1
  16. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +1 -1
  17. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
  18. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +1 -1
  19. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +1 -1
  20. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +1 -1
  21. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +1 -1
  22. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +1 -18
  23. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
  24. package/build/ts/surfaces/point-of-sale/event/data.d.ts +1 -3
  25. package/build/ts/surfaces/point-of-sale/event/data.d.ts.map +1 -1
  26. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +33 -26
  27. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
  28. package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.render.d.ts +0 -1
  29. package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.action.render.d.ts +0 -1
  30. package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.action.render.d.ts +0 -1
  31. package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.action.render.d.ts +0 -1
  32. package/build/ts/surfaces/point-of-sale/targets/pos.home.modal.render.d.ts +0 -1
  33. package/build/ts/surfaces/point-of-sale/targets/pos.order-details.action.render.d.ts +0 -1
  34. package/build/ts/surfaces/point-of-sale/targets/pos.product-details.action.render.d.ts +0 -1
  35. package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.action.render.d.ts +0 -1
  36. package/build/ts/surfaces/point-of-sale/targets/pos.register-details.action.render.d.ts +0 -1
  37. package/build/ts/surfaces/point-of-sale/targets/pos.return.post.action.render.d.ts +0 -1
  38. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +1 -1
  39. package/build/tsconfig.tsbuildinfo +1 -1
  40. package/package.json +1 -1
  41. package/src/surfaces/admin/components/Badge.d.ts +1 -1
  42. package/src/surfaces/admin/components/Button.d.ts +1 -1
  43. package/src/surfaces/admin/components/Clickable.d.ts +7 -7
  44. package/src/surfaces/admin/components/Grid.d.ts +12 -12
  45. package/src/surfaces/admin/components/GridItem.d.ts +7 -7
  46. package/src/surfaces/admin/components/Image.d.ts +7 -7
  47. package/src/surfaces/admin/components/Stack.d.ts +11 -11
  48. package/src/surfaces/admin/components/TextField.d.ts +1 -1
  49. package/src/surfaces/admin/components.d.ts +22 -22
  50. package/src/surfaces/checkout/api/standard/standard.ts +0 -3
  51. package/src/surfaces/checkout/components/Checkbox.d.ts +12 -4
  52. package/src/surfaces/point-of-sale/components/QrCode.d.ts +5 -5
  53. package/src/surfaces/point-of-sale/components/components-shared.d.ts +99 -99
  54. package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +1 -1
  55. package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +0 -2
  56. package/src/surfaces/point-of-sale/components.d.ts +3 -1
  57. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +1 -1
  58. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +1 -1
  59. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +1 -1
  60. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +1 -1
  61. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +1 -22
  62. package/src/surfaces/point-of-sale/event/data.ts +1 -10
  63. package/src/surfaces/point-of-sale/extension-targets.ts +33 -41
  64. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +1 -1
  65. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +0 -14
  66. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +0 -1
  67. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +0 -45
  68. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +0 -1
  69. package/build/ts/surfaces/point-of-sale/targets/pos.cart-update.event.observe.d.ts +0 -7
  70. package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-complete.event.observe.d.ts +0 -7
  71. package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-start.event.observe.d.ts +0 -7
  72. package/build/ts/surfaces/point-of-sale/targets/pos.transaction-complete.event.observe.d.ts +0 -7
  73. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +0 -14
  74. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +0 -46
@@ -9,19 +9,19 @@
9
9
  /**
10
10
  * TODO: Update `any` type here after this is resolved
11
11
  * https://github.com/Shopify/ui-api-design/issues/139
12
- * @publicDocs
12
+ * @private
13
13
  */
14
14
  export type ComponentChildren = any;
15
- /** @publicDocs */
15
+ /** @private */
16
16
  export type StringChildren = string;
17
- /** @publicDocs */
17
+ /** @private */
18
18
  export interface GlobalProps {
19
19
  /**
20
20
  * A unique identifier for the element.
21
21
  */
22
22
  id?: string;
23
23
  }
24
- /** @publicDocs */
24
+ /** @private */
25
25
  export interface ActionSlots {
26
26
  /**
27
27
  * The primary action to perform, provided as a button or link type element.
@@ -32,7 +32,7 @@ export interface ActionSlots {
32
32
  */
33
33
  secondaryActions?: ComponentChildren;
34
34
  }
35
- /** @publicDocs */
35
+ /** @private */
36
36
  export interface BaseOverlayProps {
37
37
  /**
38
38
  * Callback fired after the overlay is shown.
@@ -58,7 +58,7 @@ export interface BaseOverlayProps {
58
58
  * - Components implementing this interface must provide all methods
59
59
  * - Unlike props/attributes, methods are not rendered in HTML but are JavaScript APIs
60
60
  * - Consumers expect these methods to be consistently available on all instances
61
- * @publicDocs
61
+ * @private
62
62
  */
63
63
  export interface BaseOverlayMethods {
64
64
  /**
@@ -80,7 +80,7 @@ export interface BaseOverlayMethods {
80
80
  */
81
81
  toggleOverlay: () => void;
82
82
  }
83
- /** @publicDocs */
83
+ /** @private */
84
84
  export interface FocusEventProps {
85
85
  /**
86
86
  * Callback when the element loses focus.
@@ -95,7 +95,7 @@ export interface FocusEventProps {
95
95
  */
96
96
  onFocus?: (event: FocusEvent) => void;
97
97
  }
98
- /** @publicDocs */
98
+ /** @private */
99
99
  export type SizeKeyword =
100
100
  | 'small-500'
101
101
  | 'small-400'
@@ -110,11 +110,11 @@ export type SizeKeyword =
110
110
  | 'large-300'
111
111
  | 'large-400'
112
112
  | 'large-500';
113
- /** @publicDocs */
113
+ /** @private */
114
114
  export type ColorKeyword = 'subdued' | 'base' | 'strong';
115
- /** @publicDocs */
115
+ /** @private */
116
116
  export type BackgroundColorKeyword = 'transparent' | ColorKeyword;
117
- /** @publicDocs */
117
+ /** @private */
118
118
  export interface BackgroundProps {
119
119
  /**
120
120
  * Adjust the background of the element.
@@ -132,7 +132,7 @@ export interface BackgroundProps {
132
132
  * In some cases, like for Banner, the tone may also affect the semantic and accessibility treatment of the component.
133
133
  *
134
134
  * @default 'auto'
135
- * @publicDocs
135
+ * @private
136
136
  */
137
137
  export type ToneKeyword =
138
138
  | 'auto'
@@ -705,22 +705,22 @@ declare const privateIconArray: readonly [
705
705
  'x-circle',
706
706
  'x-circle-filled',
707
707
  ];
708
- /** @publicDocs */
708
+ /** @private */
709
709
  export type IconType = (typeof privateIconArray)[number];
710
710
  /**
711
711
  * Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.
712
- * @publicDocs
712
+ * @private
713
713
  */
714
714
  export type ExtractStrict<T, U extends T> = Extract<T, U>;
715
- /** @publicDocs */
715
+ /** @private */
716
716
  export type MaybeAllValuesShorthandProperty<T extends string> =
717
717
  | T
718
718
  | `${T} ${T}`
719
719
  | `${T} ${T} ${T}`
720
720
  | `${T} ${T} ${T} ${T}`;
721
- /** @publicDocs */
721
+ /** @private */
722
722
  export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
723
- /** @publicDocs */
723
+ /** @private */
724
724
  export type MaybeResponsive<T> = T | `@container${string}`;
725
725
  /**
726
726
  * Prevents widening string literal types in a union to `string`.
@@ -729,7 +729,7 @@ export type MaybeResponsive<T> = T | `@container${string}`;
729
729
  * // ^? string
730
730
  * type PropName = 'foo' | 'bar' | (string & {})
731
731
  * // ^? 'foo' | 'bar' | (string & {})
732
- * @publicDocs
732
+ * @private
733
733
  */
734
734
  export type AnyString = string & {};
735
735
  /**
@@ -737,10 +737,10 @@ export type AnyString = string & {};
737
737
  * to have a space or not in the string literal types.
738
738
  *
739
739
  * For example in the `aspectRatio` property, `16/9` and `16 / 9` are both valid.
740
- * @publicDocs
740
+ * @private
741
741
  */
742
742
  export type optionalSpace = '' | ' ';
743
- /** @publicDocs */
743
+ /** @private */
744
744
  export interface BadgeProps extends GlobalProps {
745
745
  /**
746
746
  * The content of the badge.
@@ -775,7 +775,7 @@ export interface BadgeProps extends GlobalProps {
775
775
  */
776
776
  size?: SizeKeyword;
777
777
  }
778
- /** @publicDocs */
778
+ /** @private */
779
779
  export interface BannerProps extends GlobalProps, ActionSlots {
780
780
  /**
781
781
  * The title of the banner.
@@ -851,7 +851,7 @@ export interface BannerProps extends GlobalProps, ActionSlots {
851
851
  */
852
852
  hidden?: boolean;
853
853
  }
854
- /** @publicDocs */
854
+ /** @private */
855
855
  export interface DisplayProps {
856
856
  /**
857
857
  * Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
@@ -864,7 +864,7 @@ export interface DisplayProps {
864
864
  */
865
865
  display?: MaybeResponsive<'auto' | 'none'>;
866
866
  }
867
- /** @publicDocs */
867
+ /** @private */
868
868
  export interface AccessibilityRoleProps {
869
869
  /**
870
870
  * Sets the semantic meaning of the component’s content. When set,
@@ -878,7 +878,7 @@ export interface AccessibilityRoleProps {
878
878
  */
879
879
  accessibilityRole?: AccessibilityRole;
880
880
  }
881
- /** @publicDocs */
881
+ /** @private */
882
882
  export type AccessibilityRole =
883
883
  /**
884
884
  * Used to indicate the primary content.
@@ -994,7 +994,7 @@ export type AccessibilityRole =
994
994
  * Learn more about the [`none` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/none_role) in the MDN web docs.
995
995
  */
996
996
  | 'none';
997
- /** @publicDocs */
997
+ /** @private */
998
998
  export interface AccessibilityVisibilityProps {
999
999
  /**
1000
1000
  * Changes the visibility of the element.
@@ -1007,7 +1007,7 @@ export interface AccessibilityVisibilityProps {
1007
1007
  */
1008
1008
  accessibilityVisibility?: 'visible' | 'hidden' | 'exclusive';
1009
1009
  }
1010
- /** @publicDocs */
1010
+ /** @private */
1011
1011
  export interface LabelAccessibilityVisibilityProps {
1012
1012
  /**
1013
1013
  * Changes the visibility of the component's label.
@@ -1022,9 +1022,9 @@ export interface LabelAccessibilityVisibilityProps {
1022
1022
  'visible' | 'exclusive'
1023
1023
  >;
1024
1024
  }
1025
- /** @publicDocs */
1025
+ /** @private */
1026
1026
  export type PaddingKeyword = SizeKeyword | 'none';
1027
- /** @publicDocs */
1027
+ /** @private */
1028
1028
  export interface PaddingProps {
1029
1029
  /**
1030
1030
  * Adjust the padding of all edges.
@@ -1104,13 +1104,13 @@ export interface PaddingProps {
1104
1104
  */
1105
1105
  paddingInlineEnd?: MaybeResponsive<PaddingKeyword | ''>;
1106
1106
  }
1107
- /** @publicDocs */
1107
+ /** @private */
1108
1108
  export type SizeUnits = `${number}px` | `${number}%` | `0`;
1109
- /** @publicDocs */
1109
+ /** @private */
1110
1110
  export type SizeUnitsOrAuto = SizeUnits | 'auto';
1111
- /** @publicDocs */
1111
+ /** @private */
1112
1112
  export type SizeUnitsOrNone = SizeUnits | 'none';
1113
- /** @publicDocs */
1113
+ /** @private */
1114
1114
  export interface SizingProps {
1115
1115
  /**
1116
1116
  * Adjust the block size.
@@ -1161,26 +1161,26 @@ export interface SizingProps {
1161
1161
  */
1162
1162
  maxInlineSize?: MaybeResponsive<SizeUnitsOrNone>;
1163
1163
  }
1164
- /** @publicDocs */
1164
+ /** @private */
1165
1165
  export type BorderStyleKeyword =
1166
1166
  | 'none'
1167
1167
  | 'solid'
1168
1168
  | 'dashed'
1169
1169
  | 'dotted'
1170
1170
  | 'auto';
1171
- /** @publicDocs */
1171
+ /** @private */
1172
1172
  export type BorderSizeKeyword = SizeKeyword | 'none';
1173
- /** @publicDocs */
1173
+ /** @private */
1174
1174
  export type BorderRadiusKeyword = SizeKeyword | 'max' | 'none';
1175
1175
  /**
1176
1176
  * Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.
1177
- * @publicDocs
1177
+ * @private
1178
1178
  */
1179
1179
  export type BorderShorthand =
1180
1180
  | BorderSizeKeyword
1181
1181
  | `${BorderSizeKeyword} ${ColorKeyword}`
1182
1182
  | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`;
1183
- /** @publicDocs */
1183
+ /** @private */
1184
1184
  export interface BorderProps {
1185
1185
  /**
1186
1186
  * Set the border via the shorthand property.
@@ -1265,7 +1265,7 @@ export interface BorderProps {
1265
1265
  */
1266
1266
  borderRadius?: MaybeAllValuesShorthandProperty<BorderRadiusKeyword>;
1267
1267
  }
1268
- /** @publicDocs */
1268
+ /** @private */
1269
1269
  export interface OverflowProps {
1270
1270
  /**
1271
1271
  * Sets the overflow behavior of the element.
@@ -1279,7 +1279,7 @@ export interface OverflowProps {
1279
1279
  */
1280
1280
  overflow?: 'hidden' | 'visible';
1281
1281
  }
1282
- /** @publicDocs */
1282
+ /** @private */
1283
1283
  export interface BaseBoxProps
1284
1284
  extends AccessibilityVisibilityProps,
1285
1285
  BackgroundProps,
@@ -1300,11 +1300,11 @@ export interface BaseBoxProps
1300
1300
  */
1301
1301
  accessibilityLabel?: string;
1302
1302
  }
1303
- /** @publicDocs */
1303
+ /** @private */
1304
1304
  export interface BaseBoxPropsWithRole
1305
1305
  extends BaseBoxProps,
1306
1306
  AccessibilityRoleProps {}
1307
- /** @publicDocs */
1307
+ /** @private */
1308
1308
  export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
1309
1309
  /**
1310
1310
  * The behavior of the button.
@@ -1340,7 +1340,7 @@ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
1340
1340
  */
1341
1341
  loading?: boolean;
1342
1342
  }
1343
- /** @publicDocs */
1343
+ /** @private */
1344
1344
  export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
1345
1345
  /**
1346
1346
  * The URL to link to.
@@ -1377,7 +1377,7 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
1377
1377
  */
1378
1378
  onClick?: (event: Event) => void;
1379
1379
  }
1380
- /** @publicDocs */
1380
+ /** @private */
1381
1381
  export interface InteractionProps {
1382
1382
  /**
1383
1383
  * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
@@ -1402,11 +1402,11 @@ export interface InteractionProps {
1402
1402
  */
1403
1403
  interestFor?: string;
1404
1404
  }
1405
- /** @publicDocs */
1405
+ /** @private */
1406
1406
  export interface BaseClickableProps
1407
1407
  extends ButtonBehaviorProps,
1408
1408
  LinkBehaviorProps {}
1409
- /** @publicDocs */
1409
+ /** @private */
1410
1410
  export interface ButtonProps extends GlobalProps, BaseClickableProps {
1411
1411
  /**
1412
1412
  * A label that describes the purpose or contents of the button. It will be read to users using assistive technologies such as screen readers.
@@ -1454,7 +1454,7 @@ export interface ButtonProps extends GlobalProps, BaseClickableProps {
1454
1454
  */
1455
1455
  lang?: string;
1456
1456
  }
1457
- /** @publicDocs */
1457
+ /** @private */
1458
1458
  export interface BaseInputProps {
1459
1459
  /**
1460
1460
  * An identifier for the field that is unique within the nearest containing form.
@@ -1467,7 +1467,7 @@ export interface BaseInputProps {
1467
1467
  */
1468
1468
  disabled?: boolean;
1469
1469
  }
1470
- /** @publicDocs */
1470
+ /** @private */
1471
1471
  export interface InputProps extends BaseInputProps {
1472
1472
  /**
1473
1473
  * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.
@@ -1492,7 +1492,7 @@ export interface InputProps extends BaseInputProps {
1492
1492
  */
1493
1493
  defaultValue?: string;
1494
1494
  }
1495
- /** @publicDocs */
1495
+ /** @private */
1496
1496
  export interface MultipleInputProps extends BaseInputProps {
1497
1497
  /**
1498
1498
  * Callback when the user has selected option(s).
@@ -1513,7 +1513,7 @@ export interface MultipleInputProps extends BaseInputProps {
1513
1513
  */
1514
1514
  values?: string[];
1515
1515
  }
1516
- /** @publicDocs */
1516
+ /** @private */
1517
1517
  export interface FieldErrorProps {
1518
1518
  /**
1519
1519
  * Indicate an error to the user. The field will be given a specific stylistic treatment
@@ -1521,7 +1521,7 @@ export interface FieldErrorProps {
1521
1521
  */
1522
1522
  error?: string;
1523
1523
  }
1524
- /** @publicDocs */
1524
+ /** @private */
1525
1525
  export interface BasicFieldProps
1526
1526
  extends FieldErrorProps,
1527
1527
  LabelAccessibilityVisibilityProps {
@@ -1539,7 +1539,7 @@ export interface BasicFieldProps
1539
1539
  */
1540
1540
  label?: string;
1541
1541
  }
1542
- /** @publicDocs */
1542
+ /** @private */
1543
1543
  export interface FieldDetailsProps {
1544
1544
  /**
1545
1545
  * Additional text to provide context or guidance for the field.
@@ -1550,7 +1550,7 @@ export interface FieldDetailsProps {
1550
1550
  */
1551
1551
  details?: string;
1552
1552
  }
1553
- /** @publicDocs */
1553
+ /** @private */
1554
1554
  export interface FieldProps
1555
1555
  extends BasicFieldProps,
1556
1556
  InputProps,
@@ -1561,7 +1561,7 @@ export interface FieldProps
1561
1561
  */
1562
1562
  placeholder?: string;
1563
1563
  }
1564
- /** @publicDocs */
1564
+ /** @private */
1565
1565
  export interface BaseTextFieldProps extends FieldProps {
1566
1566
  /**
1567
1567
  * The field cannot be edited by the user. It is focusable will be announced by screen readers.
@@ -1570,7 +1570,7 @@ export interface BaseTextFieldProps extends FieldProps {
1570
1570
  */
1571
1571
  readOnly?: boolean;
1572
1572
  }
1573
- /** @publicDocs */
1573
+ /** @private */
1574
1574
  export interface FieldDecorationProps {
1575
1575
  /**
1576
1576
  * A value to be displayed immediately after the editable portion of the field.
@@ -1610,7 +1610,7 @@ export interface FieldDecorationProps {
1610
1610
  */
1611
1611
  accessory?: ComponentChildren;
1612
1612
  }
1613
- /** @publicDocs */
1613
+ /** @private */
1614
1614
  export interface NumberConstraintsProps {
1615
1615
  /**
1616
1616
  * The highest decimal or integer to be accepted for the field.
@@ -1653,7 +1653,7 @@ export interface NumberConstraintsProps {
1653
1653
  */
1654
1654
  controls?: 'auto' | 'stepper' | 'none';
1655
1655
  }
1656
- /** @publicDocs */
1656
+ /** @private */
1657
1657
  export interface MinMaxLengthProps {
1658
1658
  /**
1659
1659
  * Specifies the maximum number of characters allowed.
@@ -1668,7 +1668,7 @@ export interface MinMaxLengthProps {
1668
1668
  */
1669
1669
  minLength?: number;
1670
1670
  }
1671
- /** @publicDocs */
1671
+ /** @private */
1672
1672
  export interface BaseSelectableProps {
1673
1673
  /**
1674
1674
  * A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced.
@@ -1686,7 +1686,7 @@ export interface BaseSelectableProps {
1686
1686
  */
1687
1687
  value?: string;
1688
1688
  }
1689
- /** @publicDocs */
1689
+ /** @private */
1690
1690
  export interface BaseOptionProps extends BaseSelectableProps {
1691
1691
  /**
1692
1692
  * Whether the control is active.
@@ -1703,7 +1703,7 @@ export interface BaseOptionProps extends BaseSelectableProps {
1703
1703
  */
1704
1704
  defaultSelected?: boolean;
1705
1705
  }
1706
- /** @publicDocs */
1706
+ /** @private */
1707
1707
  export interface BaseCheckableProps
1708
1708
  extends BaseSelectableProps,
1709
1709
  InteractionProps {
@@ -1743,7 +1743,7 @@ export interface BaseCheckableProps
1743
1743
  */
1744
1744
  onInput?: (event: Event) => void;
1745
1745
  }
1746
- /** @publicDocs */
1746
+ /** @private */
1747
1747
  export interface ChoiceProps extends GlobalProps, BaseOptionProps {
1748
1748
  /**
1749
1749
  * Content to use as the choice label.
@@ -1783,7 +1783,7 @@ export interface ChoiceProps extends GlobalProps, BaseOptionProps {
1783
1783
  */
1784
1784
  selectedContent?: ComponentChildren;
1785
1785
  }
1786
- /** @publicDocs */
1786
+ /** @private */
1787
1787
  export interface ChoiceListProps
1788
1788
  extends GlobalProps,
1789
1789
  Pick<BasicFieldProps, 'label' | 'labelAccessibilityVisibility' | 'error'>,
@@ -1825,7 +1825,7 @@ export interface ChoiceListProps
1825
1825
  */
1826
1826
  variant?: 'auto' | 'list' | 'inline' | 'block' | 'grid';
1827
1827
  }
1828
- /** @publicDocs */
1828
+ /** @private */
1829
1829
  export interface ClickableProps
1830
1830
  extends GlobalProps,
1831
1831
  BaseBoxProps,
@@ -1857,7 +1857,7 @@ export interface ClickableProps
1857
1857
  */
1858
1858
  lang?: string;
1859
1859
  }
1860
- /** @publicDocs */
1860
+ /** @private */
1861
1861
  export interface AutocompleteProps<
1862
1862
  AutocompleteField extends AnyAutocompleteField,
1863
1863
  > {
@@ -1895,20 +1895,20 @@ export interface AutocompleteProps<
1895
1895
  *
1896
1896
  * Commonly used when there are multiple fields with the same autocomplete needs
1897
1897
  * in the same page. For example: 2 shipping address forms in the same page.
1898
- * @publicDocs
1898
+ * @private
1899
1899
  */
1900
1900
  export type AutocompleteSection = `section-${string}`;
1901
1901
  /**
1902
1902
  * The contact information group the autocomplete data should be sourced from.
1903
- * @publicDocs
1903
+ * @private
1904
1904
  */
1905
1905
  export type AutocompleteGroup = 'shipping' | 'billing';
1906
1906
  /**
1907
1907
  * The contact information subgroup the autocomplete data should be sourced from.
1908
- * @publicDocs
1908
+ * @private
1909
1909
  */
1910
1910
  export type AutocompleteAddressGroup = 'fax' | 'home' | 'mobile' | 'pager';
1911
- /** @publicDocs */
1911
+ /** @private */
1912
1912
  export type AnyAutocompleteField =
1913
1913
  | 'additional-name'
1914
1914
  | 'address-level1'
@@ -1974,7 +1974,7 @@ export type AnyAutocompleteField =
1974
1974
  | `${AutocompleteAddressGroup} tel-local-suffix`
1975
1975
  | `${AutocompleteAddressGroup} tel-local`
1976
1976
  | `${AutocompleteAddressGroup} tel-national`;
1977
- /** @publicDocs */
1977
+ /** @private */
1978
1978
  export type TextAutocompleteField = ExtractStrict<
1979
1979
  AnyAutocompleteField,
1980
1980
  | 'additional-name'
@@ -2008,7 +2008,7 @@ export type TextAutocompleteField = ExtractStrict<
2008
2008
  | 'cc-family-name'
2009
2009
  | 'cc-type'
2010
2010
  >;
2011
- /** @publicDocs */
2011
+ /** @private */
2012
2012
  export interface DatePickerProps
2013
2013
  extends GlobalProps,
2014
2014
  InputProps,
@@ -2175,7 +2175,7 @@ export interface DatePickerProps
2175
2175
  */
2176
2176
  onChange?: (event: Event) => void;
2177
2177
  }
2178
- /** @publicDocs */
2178
+ /** @private */
2179
2179
  export interface DateFieldProps
2180
2180
  extends GlobalProps,
2181
2181
  BaseTextFieldProps,
@@ -2219,7 +2219,7 @@ export interface DateFieldProps
2219
2219
  */
2220
2220
  onInvalid?: (event: Event) => void;
2221
2221
  }
2222
- /** @publicDocs */
2222
+ /** @private */
2223
2223
  export type DateAutocompleteField = ExtractStrict<
2224
2224
  AnyAutocompleteField,
2225
2225
  | 'bday'
@@ -2230,7 +2230,7 @@ export type DateAutocompleteField = ExtractStrict<
2230
2230
  | 'cc-expiry-month'
2231
2231
  | 'cc-expiry-year'
2232
2232
  >;
2233
- /** @publicDocs */
2233
+ /** @private */
2234
2234
  export interface DateSpinnerProps
2235
2235
  extends GlobalProps,
2236
2236
  Pick<
@@ -2269,7 +2269,7 @@ export interface DateSpinnerProps
2269
2269
  */
2270
2270
  onChange?: (event: Event) => void;
2271
2271
  }
2272
- /** @publicDocs */
2272
+ /** @private */
2273
2273
  export interface DividerProps extends GlobalProps {
2274
2274
  /**
2275
2275
  * Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
@@ -2284,18 +2284,18 @@ export interface DividerProps extends GlobalProps {
2284
2284
  */
2285
2285
  color?: ColorKeyword;
2286
2286
  }
2287
- /** @publicDocs */
2287
+ /** @private */
2288
2288
  export interface EmailFieldProps
2289
2289
  extends GlobalProps,
2290
2290
  BaseTextFieldProps,
2291
2291
  MinMaxLengthProps,
2292
2292
  AutocompleteProps<EmailAutocompleteField> {}
2293
- /** @publicDocs */
2293
+ /** @private */
2294
2294
  export type EmailAutocompleteField = ExtractStrict<
2295
2295
  AnyAutocompleteField,
2296
2296
  'email' | `${AutocompleteAddressGroup} email`
2297
2297
  >;
2298
- /** @publicDocs */
2298
+ /** @private */
2299
2299
  export interface EmbedProps extends GlobalProps, SizingProps {
2300
2300
  /**
2301
2301
  * The content type of the file to display.
@@ -2326,7 +2326,7 @@ export interface EmbedProps extends GlobalProps, SizingProps {
2326
2326
  */
2327
2327
  accessibilityLabel?: string;
2328
2328
  }
2329
- /** @publicDocs */
2329
+ /** @private */
2330
2330
  export interface EmptyStateProps extends GlobalProps, ActionSlots {
2331
2331
  /**
2332
2332
  * The heading of the empty state.
@@ -2341,9 +2341,9 @@ export interface EmptyStateProps extends GlobalProps, ActionSlots {
2341
2341
  */
2342
2342
  graphic?: ComponentChildren;
2343
2343
  }
2344
- /** @publicDocs */
2344
+ /** @private */
2345
2345
  export type SpacingKeyword = SizeKeyword | 'none';
2346
- /** @publicDocs */
2346
+ /** @private */
2347
2347
  export interface GapProps {
2348
2348
  /**
2349
2349
  * Adjust spacing between elements.
@@ -2371,17 +2371,17 @@ export interface GapProps {
2371
2371
  */
2372
2372
  columnGap?: MaybeResponsive<SpacingKeyword | ''>;
2373
2373
  }
2374
- /** @publicDocs */
2374
+ /** @private */
2375
2375
  export type BaselinePosition = 'baseline' | 'first baseline' | 'last baseline';
2376
- /** @publicDocs */
2376
+ /** @private */
2377
2377
  export type ContentDistribution =
2378
2378
  | 'space-between'
2379
2379
  | 'space-around'
2380
2380
  | 'space-evenly'
2381
2381
  | 'stretch';
2382
- /** @publicDocs */
2382
+ /** @private */
2383
2383
  export type ContentPosition = 'center' | 'start' | 'end';
2384
- /** @publicDocs */
2384
+ /** @private */
2385
2385
  export type OverflowPosition =
2386
2386
  | `unsafe ${ContentPosition}`
2387
2387
  | `safe ${ContentPosition}`;
@@ -2389,7 +2389,7 @@ export type OverflowPosition =
2389
2389
  * Align items sets the align-self value on all direct children as a group.
2390
2390
  *
2391
2391
  * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
2392
- * @publicDocs
2392
+ * @private
2393
2393
  */
2394
2394
  export type AlignItemsKeyword =
2395
2395
  | 'normal'
@@ -2401,7 +2401,7 @@ export type AlignItemsKeyword =
2401
2401
  * Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container.
2402
2402
  *
2403
2403
  * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
2404
- * @publicDocs
2404
+ * @private
2405
2405
  */
2406
2406
  export type JustifyContentKeyword =
2407
2407
  | 'normal'
@@ -2412,7 +2412,7 @@ export type JustifyContentKeyword =
2412
2412
  *Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.
2413
2413
  *
2414
2414
  * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
2415
- * @publicDocs
2415
+ * @private
2416
2416
  */
2417
2417
  export type AlignContentKeyword =
2418
2418
  | 'normal'
@@ -2420,7 +2420,7 @@ export type AlignContentKeyword =
2420
2420
  | ContentDistribution
2421
2421
  | OverflowPosition
2422
2422
  | ContentPosition;
2423
- /** @publicDocs */
2423
+ /** @private */
2424
2424
  export interface BaseTypographyProps {
2425
2425
  /**
2426
2426
  * Modify the color to be more or less intense.
@@ -2466,7 +2466,7 @@ export interface BaseTypographyProps {
2466
2466
  */
2467
2467
  dir?: 'ltr' | 'rtl' | 'auto' | '';
2468
2468
  }
2469
- /** @publicDocs */
2469
+ /** @private */
2470
2470
  export interface BlockTypographyProps {
2471
2471
  /**
2472
2472
  * Truncates the text content to the specified number of lines.
@@ -2477,7 +2477,7 @@ export interface BlockTypographyProps {
2477
2477
  */
2478
2478
  lineClamp?: number;
2479
2479
  }
2480
- /** @publicDocs */
2480
+ /** @private */
2481
2481
  export interface HeadingProps
2482
2482
  extends GlobalProps,
2483
2483
  AccessibilityVisibilityProps,
@@ -2507,7 +2507,7 @@ export interface HeadingProps
2507
2507
  | 'heading'
2508
2508
  | ExtractStrict<AccessibilityRole, 'presentation' | 'none'>;
2509
2509
  }
2510
- /** @publicDocs */
2510
+ /** @private */
2511
2511
  export interface IconProps
2512
2512
  extends GlobalProps,
2513
2513
  Pick<InteractionProps, 'interestFor'> {
@@ -2531,7 +2531,7 @@ export interface IconProps
2531
2531
  size?: SizeKeyword;
2532
2532
  type?: IconType | AnyString;
2533
2533
  }
2534
- /** @publicDocs */
2534
+ /** @private */
2535
2535
  export interface BaseImageProps {
2536
2536
  /**
2537
2537
  * An alternative text description that describe the image for the reader to
@@ -2577,7 +2577,7 @@ export interface BaseImageProps {
2577
2577
  */
2578
2578
  srcSet?: string;
2579
2579
  }
2580
- /** @publicDocs */
2580
+ /** @private */
2581
2581
  export interface ImageProps extends GlobalProps, BaseImageProps, BorderProps {
2582
2582
  /**
2583
2583
  * Sets the semantic meaning of the component’s content. When set,
@@ -2653,7 +2653,7 @@ export interface ImageProps extends GlobalProps, BaseImageProps, BorderProps {
2653
2653
  */
2654
2654
  onError?: (event: Event) => void;
2655
2655
  }
2656
- /** @publicDocs */
2656
+ /** @private */
2657
2657
  export interface LinkProps extends GlobalProps, LinkBehaviorProps {
2658
2658
  /**
2659
2659
  * The content of the link.
@@ -2679,7 +2679,7 @@ export interface LinkProps extends GlobalProps, LinkBehaviorProps {
2679
2679
  */
2680
2680
  lang?: string;
2681
2681
  }
2682
- /** @publicDocs */
2682
+ /** @private */
2683
2683
  export interface ModalProps
2684
2684
  extends GlobalProps,
2685
2685
  BaseOverlayProps,
@@ -2723,7 +2723,7 @@ export interface ModalProps
2723
2723
  */
2724
2724
  children?: ComponentChildren;
2725
2725
  }
2726
- /** @publicDocs */
2726
+ /** @private */
2727
2727
  export interface NumberFieldProps
2728
2728
  extends GlobalProps,
2729
2729
  BaseTextFieldProps,
@@ -2753,12 +2753,12 @@ export interface NumberFieldProps
2753
2753
  */
2754
2754
  onInput?: (event: Event) => void;
2755
2755
  }
2756
- /** @publicDocs */
2756
+ /** @private */
2757
2757
  export type NumberAutocompleteField = ExtractStrict<
2758
2758
  AnyAutocompleteField,
2759
2759
  'one-time-code' | 'cc-number' | 'cc-csc'
2760
2760
  >;
2761
- /** @publicDocs */
2761
+ /** @private */
2762
2762
  export interface PageProps extends GlobalProps, ActionSlots {
2763
2763
  /**
2764
2764
  * The content of the page.
@@ -2795,7 +2795,7 @@ export interface PageProps extends GlobalProps, ActionSlots {
2795
2795
  */
2796
2796
  inlineSize?: SizeKeyword;
2797
2797
  }
2798
- /** @publicDocs */
2798
+ /** @private */
2799
2799
  export interface POSBlockProps
2800
2800
  extends GlobalProps,
2801
2801
  Pick<ActionSlots, 'secondaryActions'> {
@@ -2814,7 +2814,7 @@ export interface POSBlockProps
2814
2814
  */
2815
2815
  secondaryActions?: ComponentChildren;
2816
2816
  }
2817
- /** @publicDocs */
2817
+ /** @private */
2818
2818
  export interface QRCodeProps extends GlobalProps {
2819
2819
  /**
2820
2820
  * Set the border of the QR code.