@shopify/ui-extensions 2026.4.0-rc.2 → 2026.4.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.
Files changed (1178) hide show
  1. package/build/cjs/surfaces/checkout/preact/api.js +2 -0
  2. package/build/cjs/surfaces/checkout/preact/app-metafields.js +1 -0
  3. package/build/cjs/surfaces/checkout/preact/attributes.js +3 -0
  4. package/build/cjs/surfaces/checkout/preact/billing-address.js +1 -0
  5. package/build/cjs/surfaces/checkout/preact/buyer-identity.js +4 -0
  6. package/build/cjs/surfaces/checkout/preact/buyer-journey.js +5 -0
  7. package/build/cjs/surfaces/checkout/preact/capabilities.js +2 -0
  8. package/build/cjs/surfaces/checkout/preact/cart-line-target.js +1 -0
  9. package/build/cjs/surfaces/checkout/preact/cart-lines.js +2 -0
  10. package/build/cjs/surfaces/checkout/preact/checkout-settings.js +1 -0
  11. package/build/cjs/surfaces/checkout/preact/checkout-token.js +1 -0
  12. package/build/cjs/surfaces/checkout/preact/cost.js +4 -0
  13. package/build/cjs/surfaces/checkout/preact/country.js +1 -0
  14. package/build/cjs/surfaces/checkout/preact/currency.js +1 -0
  15. package/build/cjs/surfaces/checkout/preact/customer-privacy.js +1 -0
  16. package/build/cjs/surfaces/checkout/preact/delivery-group-list-target.js +1 -0
  17. package/build/cjs/surfaces/checkout/preact/delivery-group-target.js +1 -0
  18. package/build/cjs/surfaces/checkout/preact/delivery-group.js +1 -0
  19. package/build/cjs/surfaces/checkout/preact/delivery-groups.js +1 -0
  20. package/build/cjs/surfaces/checkout/preact/delivery-selection-groups.js +1 -0
  21. package/build/cjs/surfaces/checkout/preact/discounts.js +3 -0
  22. package/build/cjs/surfaces/checkout/preact/extension-editor.js +1 -0
  23. package/build/cjs/surfaces/checkout/preact/extension-language.js +1 -0
  24. package/build/cjs/surfaces/checkout/preact/extension.js +2 -0
  25. package/build/cjs/surfaces/checkout/preact/gift-cards.js +2 -0
  26. package/build/cjs/surfaces/checkout/preact/instructions.js +1 -0
  27. package/build/cjs/surfaces/checkout/preact/language.js +1 -0
  28. package/build/cjs/surfaces/checkout/preact/localized-fields.js +2 -0
  29. package/build/cjs/surfaces/checkout/preact/market.js +1 -0
  30. package/build/cjs/surfaces/checkout/preact/metafields.js +1 -0
  31. package/build/cjs/surfaces/checkout/preact/note.js +2 -0
  32. package/build/cjs/surfaces/checkout/preact/payment-method.js +3 -0
  33. package/build/cjs/surfaces/checkout/preact/payment-options.js +2 -0
  34. package/build/cjs/surfaces/checkout/preact/pickup-location-option-target.js +1 -0
  35. package/build/cjs/surfaces/checkout/preact/redeemable.js +1 -0
  36. package/build/cjs/surfaces/checkout/preact/session-token.js +1 -0
  37. package/build/cjs/surfaces/checkout/preact/settings.js +1 -0
  38. package/build/cjs/surfaces/checkout/preact/shipping-address.js +2 -0
  39. package/build/cjs/surfaces/checkout/preact/shipping-option-target.js +1 -0
  40. package/build/cjs/surfaces/checkout/preact/shop.js +1 -0
  41. package/build/cjs/surfaces/checkout/preact/storage.js +1 -0
  42. package/build/cjs/surfaces/checkout/preact/subscription.js +1 -0
  43. package/build/cjs/surfaces/checkout/preact/target.js +1 -0
  44. package/build/cjs/surfaces/checkout/preact/timezone.js +1 -0
  45. package/build/cjs/surfaces/checkout/preact/translate.js +1 -0
  46. package/build/cjs/surfaces/checkout/shared.js +3 -16
  47. package/build/cjs/surfaces/checkout/style/style.js +1 -0
  48. package/build/cjs/surfaces/point-of-sale/types/storage.js +4 -0
  49. package/build/esm/surfaces/checkout/preact/api.mjs +2 -0
  50. package/build/esm/surfaces/checkout/preact/app-metafields.mjs +1 -0
  51. package/build/esm/surfaces/checkout/preact/attributes.mjs +3 -0
  52. package/build/esm/surfaces/checkout/preact/billing-address.mjs +1 -0
  53. package/build/esm/surfaces/checkout/preact/buyer-identity.mjs +4 -0
  54. package/build/esm/surfaces/checkout/preact/buyer-journey.mjs +5 -0
  55. package/build/esm/surfaces/checkout/preact/capabilities.mjs +2 -0
  56. package/build/esm/surfaces/checkout/preact/cart-line-target.mjs +1 -0
  57. package/build/esm/surfaces/checkout/preact/cart-lines.mjs +2 -0
  58. package/build/esm/surfaces/checkout/preact/checkout-settings.mjs +1 -0
  59. package/build/esm/surfaces/checkout/preact/checkout-token.mjs +1 -0
  60. package/build/esm/surfaces/checkout/preact/cost.mjs +4 -0
  61. package/build/esm/surfaces/checkout/preact/country.mjs +1 -0
  62. package/build/esm/surfaces/checkout/preact/currency.mjs +1 -0
  63. package/build/esm/surfaces/checkout/preact/customer-privacy.mjs +1 -0
  64. package/build/esm/surfaces/checkout/preact/delivery-group-list-target.mjs +1 -0
  65. package/build/esm/surfaces/checkout/preact/delivery-group-target.mjs +1 -0
  66. package/build/esm/surfaces/checkout/preact/delivery-group.mjs +1 -0
  67. package/build/esm/surfaces/checkout/preact/delivery-groups.mjs +1 -0
  68. package/build/esm/surfaces/checkout/preact/delivery-selection-groups.mjs +1 -0
  69. package/build/esm/surfaces/checkout/preact/discounts.mjs +3 -0
  70. package/build/esm/surfaces/checkout/preact/extension-editor.mjs +1 -0
  71. package/build/esm/surfaces/checkout/preact/extension-language.mjs +1 -0
  72. package/build/esm/surfaces/checkout/preact/extension.mjs +2 -0
  73. package/build/esm/surfaces/checkout/preact/gift-cards.mjs +2 -0
  74. package/build/esm/surfaces/checkout/preact/instructions.mjs +1 -0
  75. package/build/esm/surfaces/checkout/preact/language.mjs +1 -0
  76. package/build/esm/surfaces/checkout/preact/localized-fields.mjs +2 -0
  77. package/build/esm/surfaces/checkout/preact/market.mjs +1 -0
  78. package/build/esm/surfaces/checkout/preact/metafields.mjs +1 -0
  79. package/build/esm/surfaces/checkout/preact/note.mjs +2 -0
  80. package/build/esm/surfaces/checkout/preact/payment-method.mjs +3 -0
  81. package/build/esm/surfaces/checkout/preact/payment-options.mjs +2 -0
  82. package/build/esm/surfaces/checkout/preact/pickup-location-option-target.mjs +1 -0
  83. package/build/esm/surfaces/checkout/preact/redeemable.mjs +1 -0
  84. package/build/esm/surfaces/checkout/preact/session-token.mjs +1 -0
  85. package/build/esm/surfaces/checkout/preact/settings.mjs +1 -0
  86. package/build/esm/surfaces/checkout/preact/shipping-address.mjs +2 -0
  87. package/build/esm/surfaces/checkout/preact/shipping-option-target.mjs +1 -0
  88. package/build/esm/surfaces/checkout/preact/shop.mjs +1 -0
  89. package/build/esm/surfaces/checkout/preact/storage.mjs +1 -0
  90. package/build/esm/surfaces/checkout/preact/subscription.mjs +1 -0
  91. package/build/esm/surfaces/checkout/preact/target.mjs +1 -0
  92. package/build/esm/surfaces/checkout/preact/timezone.mjs +1 -0
  93. package/build/esm/surfaces/checkout/preact/translate.mjs +1 -0
  94. package/build/esm/surfaces/checkout/shared.mjs +3 -16
  95. package/build/esm/surfaces/checkout/style/style.mjs +1 -0
  96. package/build/esm/surfaces/point-of-sale/types/storage.mjs +4 -0
  97. package/build/esnext/surfaces/checkout/preact/api.esnext +2 -0
  98. package/build/esnext/surfaces/checkout/preact/app-metafields.esnext +1 -0
  99. package/build/esnext/surfaces/checkout/preact/attributes.esnext +3 -0
  100. package/build/esnext/surfaces/checkout/preact/billing-address.esnext +1 -0
  101. package/build/esnext/surfaces/checkout/preact/buyer-identity.esnext +4 -0
  102. package/build/esnext/surfaces/checkout/preact/buyer-journey.esnext +5 -0
  103. package/build/esnext/surfaces/checkout/preact/capabilities.esnext +2 -0
  104. package/build/esnext/surfaces/checkout/preact/cart-line-target.esnext +1 -0
  105. package/build/esnext/surfaces/checkout/preact/cart-lines.esnext +2 -0
  106. package/build/esnext/surfaces/checkout/preact/checkout-settings.esnext +1 -0
  107. package/build/esnext/surfaces/checkout/preact/checkout-token.esnext +1 -0
  108. package/build/esnext/surfaces/checkout/preact/cost.esnext +4 -0
  109. package/build/esnext/surfaces/checkout/preact/country.esnext +1 -0
  110. package/build/esnext/surfaces/checkout/preact/currency.esnext +1 -0
  111. package/build/esnext/surfaces/checkout/preact/customer-privacy.esnext +1 -0
  112. package/build/esnext/surfaces/checkout/preact/delivery-group-list-target.esnext +1 -0
  113. package/build/esnext/surfaces/checkout/preact/delivery-group-target.esnext +1 -0
  114. package/build/esnext/surfaces/checkout/preact/delivery-group.esnext +1 -0
  115. package/build/esnext/surfaces/checkout/preact/delivery-groups.esnext +1 -0
  116. package/build/esnext/surfaces/checkout/preact/delivery-selection-groups.esnext +1 -0
  117. package/build/esnext/surfaces/checkout/preact/discounts.esnext +3 -0
  118. package/build/esnext/surfaces/checkout/preact/extension-editor.esnext +1 -0
  119. package/build/esnext/surfaces/checkout/preact/extension-language.esnext +1 -0
  120. package/build/esnext/surfaces/checkout/preact/extension.esnext +2 -0
  121. package/build/esnext/surfaces/checkout/preact/gift-cards.esnext +2 -0
  122. package/build/esnext/surfaces/checkout/preact/instructions.esnext +1 -0
  123. package/build/esnext/surfaces/checkout/preact/language.esnext +1 -0
  124. package/build/esnext/surfaces/checkout/preact/localized-fields.esnext +2 -0
  125. package/build/esnext/surfaces/checkout/preact/market.esnext +1 -0
  126. package/build/esnext/surfaces/checkout/preact/metafields.esnext +1 -0
  127. package/build/esnext/surfaces/checkout/preact/note.esnext +2 -0
  128. package/build/esnext/surfaces/checkout/preact/payment-method.esnext +3 -0
  129. package/build/esnext/surfaces/checkout/preact/payment-options.esnext +2 -0
  130. package/build/esnext/surfaces/checkout/preact/pickup-location-option-target.esnext +1 -0
  131. package/build/esnext/surfaces/checkout/preact/redeemable.esnext +1 -0
  132. package/build/esnext/surfaces/checkout/preact/session-token.esnext +1 -0
  133. package/build/esnext/surfaces/checkout/preact/settings.esnext +1 -0
  134. package/build/esnext/surfaces/checkout/preact/shipping-address.esnext +2 -0
  135. package/build/esnext/surfaces/checkout/preact/shipping-option-target.esnext +1 -0
  136. package/build/esnext/surfaces/checkout/preact/shop.esnext +1 -0
  137. package/build/esnext/surfaces/checkout/preact/storage.esnext +1 -0
  138. package/build/esnext/surfaces/checkout/preact/subscription.esnext +1 -0
  139. package/build/esnext/surfaces/checkout/preact/target.esnext +1 -0
  140. package/build/esnext/surfaces/checkout/preact/timezone.esnext +1 -0
  141. package/build/esnext/surfaces/checkout/preact/translate.esnext +1 -0
  142. package/build/esnext/surfaces/checkout/shared.esnext +3 -16
  143. package/build/esnext/surfaces/checkout/style/style.esnext +1 -0
  144. package/build/esnext/surfaces/point-of-sale/types/storage.esnext +4 -0
  145. package/build/ts/shared.d.ts +32 -12
  146. package/build/ts/shared.d.ts.map +1 -1
  147. package/build/ts/surfaces/admin/api/action/action.d.ts +1 -0
  148. package/build/ts/surfaces/admin/api/action/action.d.ts.map +1 -1
  149. package/build/ts/surfaces/admin/api/block/block.d.ts +2 -0
  150. package/build/ts/surfaces/admin/api/block/block.d.ts.map +1 -1
  151. package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts +7 -4
  152. package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts.map +1 -1
  153. package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts +13 -7
  154. package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts.map +1 -1
  155. package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts +1 -0
  156. package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts.map +1 -1
  157. package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts +3 -0
  158. package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts.map +1 -1
  159. package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts +1 -0
  160. package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts.map +1 -1
  161. package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +7 -3
  162. package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
  163. package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts +13 -7
  164. package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts.map +1 -1
  165. package/build/ts/surfaces/admin/api/intents/intent-render.d.ts +24 -0
  166. package/build/ts/surfaces/admin/api/intents/intent-render.d.ts.map +1 -0
  167. package/build/ts/surfaces/admin/api/intents/intents.d.ts +44 -8
  168. package/build/ts/surfaces/admin/api/intents/intents.d.ts.map +1 -1
  169. package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts +5 -3
  170. package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts.map +1 -1
  171. package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts +8 -3
  172. package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts.map +1 -1
  173. package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts +1 -0
  174. package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts.map +1 -1
  175. package/build/ts/surfaces/admin/api/picker/picker.d.ts +15 -7
  176. package/build/ts/surfaces/admin/api/picker/picker.d.ts.map +1 -1
  177. package/build/ts/surfaces/admin/api/print-action/print-action.d.ts +1 -0
  178. package/build/ts/surfaces/admin/api/print-action/print-action.d.ts.map +1 -1
  179. package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts +4 -2
  180. package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts.map +1 -1
  181. package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts +4 -2
  182. package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts.map +1 -1
  183. package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts +1 -0
  184. package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts.map +1 -1
  185. package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts +36 -17
  186. package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts.map +1 -1
  187. package/build/ts/surfaces/admin/api/shared.d.ts +2 -0
  188. package/build/ts/surfaces/admin/api/shared.d.ts.map +1 -1
  189. package/build/ts/surfaces/admin/api/standard/standard-rendering.d.ts +3 -0
  190. package/build/ts/surfaces/admin/api/standard/standard-rendering.d.ts.map +1 -1
  191. package/build/ts/surfaces/admin/api/standard/standard.d.ts +4 -1
  192. package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
  193. package/build/ts/surfaces/admin/api/standard/storage.d.ts +4 -0
  194. package/build/ts/surfaces/admin/api/standard/storage.d.ts.map +1 -1
  195. package/build/ts/surfaces/admin/api.d.ts +1 -0
  196. package/build/ts/surfaces/admin/api.d.ts.map +1 -1
  197. package/build/ts/surfaces/admin/components/AdminAction.d.ts +6 -0
  198. package/build/ts/surfaces/admin/components/AdminBlock.d.ts +6 -0
  199. package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +6 -0
  200. package/build/ts/surfaces/admin/components/Avatar.d.ts +9 -0
  201. package/build/ts/surfaces/admin/components/Badge.d.ts +10 -1
  202. package/build/ts/surfaces/admin/components/Banner.d.ts +11 -0
  203. package/build/ts/surfaces/admin/components/Box.d.ts +14 -0
  204. package/build/ts/surfaces/admin/components/Button.d.ts +15 -1
  205. package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +8 -0
  206. package/build/ts/surfaces/admin/components/Checkbox.d.ts +12 -1
  207. package/build/ts/surfaces/admin/components/Chip.d.ts +4 -2
  208. package/build/ts/surfaces/admin/components/Choice.d.ts +10 -2
  209. package/build/ts/surfaces/admin/components/ChoiceList.d.ts +12 -2
  210. package/build/ts/surfaces/admin/components/Clickable.d.ts +23 -11
  211. package/build/ts/surfaces/admin/components/ClickableChip.d.ts +11 -0
  212. package/build/ts/surfaces/admin/components/ColorField.d.ts +12 -0
  213. package/build/ts/surfaces/admin/components/ColorPicker.d.ts +9 -0
  214. package/build/ts/surfaces/admin/components/DateField.d.ts +11 -0
  215. package/build/ts/surfaces/admin/components/DatePicker.d.ts +10 -1
  216. package/build/ts/surfaces/admin/components/Divider.d.ts +7 -0
  217. package/build/ts/surfaces/admin/components/DropZone.d.ts +8 -4
  218. package/build/ts/surfaces/admin/components/EmailField.d.ts +12 -0
  219. package/build/ts/surfaces/admin/components/Form.d.ts +10 -0
  220. package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +12 -0
  221. package/build/ts/surfaces/admin/components/Grid.d.ts +28 -12
  222. package/build/ts/surfaces/admin/components/GridItem.d.ts +22 -7
  223. package/build/ts/surfaces/admin/components/Heading.d.ts +8 -0
  224. package/build/ts/surfaces/admin/components/Icon.d.ts +6 -3
  225. package/build/ts/surfaces/admin/components/Image.d.ts +22 -7
  226. package/build/ts/surfaces/admin/components/Link.d.ts +13 -3
  227. package/build/ts/surfaces/admin/components/ListItem.d.ts +8 -0
  228. package/build/ts/surfaces/admin/components/Menu.d.ts +11 -0
  229. package/build/ts/surfaces/admin/components/Modal.d.ts +8 -4
  230. package/build/ts/surfaces/admin/components/MoneyField.d.ts +13 -0
  231. package/build/ts/surfaces/admin/components/NumberField.d.ts +12 -0
  232. package/build/ts/surfaces/admin/components/Option.d.ts +10 -2
  233. package/build/ts/surfaces/admin/components/OptionGroup.d.ts +10 -2
  234. package/build/ts/surfaces/admin/components/OrderedList.d.ts +8 -0
  235. package/build/ts/surfaces/admin/components/Page.d.ts +4 -2
  236. package/build/ts/surfaces/admin/components/Paragraph.d.ts +8 -0
  237. package/build/ts/surfaces/admin/components/PasswordField.d.ts +12 -0
  238. package/build/ts/surfaces/admin/components/QueryContainer.d.ts +8 -0
  239. package/build/ts/surfaces/admin/components/SearchField.d.ts +13 -1
  240. package/build/ts/surfaces/admin/components/Section.d.ts +9 -0
  241. package/build/ts/surfaces/admin/components/Select.d.ts +14 -2
  242. package/build/ts/surfaces/admin/components/Spinner.d.ts +7 -0
  243. package/build/ts/surfaces/admin/components/Stack.d.ts +27 -11
  244. package/build/ts/surfaces/admin/components/Switch.d.ts +12 -1
  245. package/build/ts/surfaces/admin/components/Table.d.ts +15 -0
  246. package/build/ts/surfaces/admin/components/TableBody.d.ts +8 -0
  247. package/build/ts/surfaces/admin/components/TableCell.d.ts +9 -0
  248. package/build/ts/surfaces/admin/components/TableHeader.d.ts +9 -0
  249. package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +8 -0
  250. package/build/ts/surfaces/admin/components/TableRow.d.ts +8 -0
  251. package/build/ts/surfaces/admin/components/Text.d.ts +19 -0
  252. package/build/ts/surfaces/admin/components/TextArea.d.ts +12 -0
  253. package/build/ts/surfaces/admin/components/TextField.d.ts +14 -1
  254. package/build/ts/surfaces/admin/components/Thumbnail.d.ts +9 -0
  255. package/build/ts/surfaces/admin/components/Tooltip.d.ts +11 -0
  256. package/build/ts/surfaces/admin/components/URLField.d.ts +12 -0
  257. package/build/ts/surfaces/admin/components/UnorderedList.d.ts +14 -0
  258. package/build/ts/surfaces/admin/components/shared.d.ts +267 -0
  259. package/build/ts/surfaces/admin/extension-targets.d.ts +8 -1
  260. package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
  261. package/build/ts/surfaces/admin/targets/admin.app.intent.render.d.ts +61 -0
  262. package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts +2 -0
  263. package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts.map +1 -1
  264. package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts +3 -0
  265. package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts.map +1 -1
  266. package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts +1 -0
  267. package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts.map +1 -1
  268. package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts +2 -0
  269. package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts.map +1 -1
  270. package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts +1 -0
  271. package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts.map +1 -1
  272. package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts +5 -1
  273. package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts.map +1 -1
  274. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +258 -122
  275. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
  276. package/build/ts/surfaces/checkout/api/docs.d.ts +33 -8
  277. package/build/ts/surfaces/checkout/api/docs.d.ts.map +1 -1
  278. package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts +12 -5
  279. package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts.map +1 -1
  280. package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts +7 -0
  281. package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts.map +1 -1
  282. package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts +3 -2
  283. package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts.map +1 -1
  284. package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts +4 -1
  285. package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts.map +1 -1
  286. package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts +4 -1
  287. package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts.map +1 -1
  288. package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts +7 -0
  289. package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts.map +1 -1
  290. package/build/ts/surfaces/checkout/api/shared.d.ts +79 -31
  291. package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
  292. package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts +6 -4
  293. package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
  294. package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts +18 -12
  295. package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts.map +1 -1
  296. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +659 -443
  297. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  298. package/build/ts/surfaces/checkout/components/Abbreviation.d.ts +4 -0
  299. package/build/ts/surfaces/checkout/components/Announcement.d.ts +38 -9
  300. package/build/ts/surfaces/checkout/components/Badge.d.ts +46 -3
  301. package/build/ts/surfaces/checkout/components/Banner.d.ts +64 -9
  302. package/build/ts/surfaces/checkout/components/Box.d.ts +52 -0
  303. package/build/ts/surfaces/checkout/components/Button.d.ts +16 -3
  304. package/build/ts/surfaces/checkout/components/Chat.d.ts +20 -0
  305. package/build/ts/surfaces/checkout/components/Checkbox.d.ts +17 -2
  306. package/build/ts/surfaces/checkout/components/Chip.d.ts +8 -0
  307. package/build/ts/surfaces/checkout/components/Choice.d.ts +8 -0
  308. package/build/ts/surfaces/checkout/components/ChoiceList.d.ts +17 -2
  309. package/build/ts/surfaces/checkout/components/Clickable.d.ts +37 -7
  310. package/build/ts/surfaces/checkout/components/ClickableChip.d.ts +23 -5
  311. package/build/ts/surfaces/checkout/components/ClipboardItem.d.ts +16 -2
  312. package/build/ts/surfaces/checkout/components/ConsentCheckbox.d.ts +17 -2
  313. package/build/ts/surfaces/checkout/components/ConsentPhoneField.d.ts +29 -10
  314. package/build/ts/surfaces/checkout/components/DateField.d.ts +31 -6
  315. package/build/ts/surfaces/checkout/components/DatePicker.d.ts +28 -5
  316. package/build/ts/surfaces/checkout/components/Details.d.ts +14 -0
  317. package/build/ts/surfaces/checkout/components/Divider.d.ts +1 -0
  318. package/build/ts/surfaces/checkout/components/DropZone.d.ts +22 -3
  319. package/build/ts/surfaces/checkout/components/EmailField.d.ts +29 -10
  320. package/build/ts/surfaces/checkout/components/Form.d.ts +16 -1
  321. package/build/ts/surfaces/checkout/components/Grid.d.ts +139 -0
  322. package/build/ts/surfaces/checkout/components/GridItem.d.ts +57 -0
  323. package/build/ts/surfaces/checkout/components/Heading.d.ts +4 -0
  324. package/build/ts/surfaces/checkout/components/Icon.d.ts +49 -4
  325. package/build/ts/surfaces/checkout/components/Image.d.ts +43 -1
  326. package/build/ts/surfaces/checkout/components/Link.d.ts +16 -3
  327. package/build/ts/surfaces/checkout/components/ListItem.d.ts +4 -0
  328. package/build/ts/surfaces/checkout/components/Map.d.ts +68 -6
  329. package/build/ts/surfaces/checkout/components/MapMarker.d.ts +39 -8
  330. package/build/ts/surfaces/checkout/components/Modal.d.ts +52 -8
  331. package/build/ts/surfaces/checkout/components/MoneyField.d.ts +23 -8
  332. package/build/ts/surfaces/checkout/components/NumberField.d.ts +29 -10
  333. package/build/ts/surfaces/checkout/components/Option.d.ts +4 -0
  334. package/build/ts/surfaces/checkout/components/OrderedList.d.ts +4 -0
  335. package/build/ts/surfaces/checkout/components/Paragraph.d.ts +4 -0
  336. package/build/ts/surfaces/checkout/components/PasswordField.d.ts +29 -10
  337. package/build/ts/surfaces/checkout/components/PaymentIcon.d.ts +17 -1
  338. package/build/ts/surfaces/checkout/components/PhoneField.d.ts +29 -10
  339. package/build/ts/surfaces/checkout/components/Popover.d.ts +39 -22
  340. package/build/ts/surfaces/checkout/components/PressButton.d.ts +20 -6
  341. package/build/ts/surfaces/checkout/components/ProductThumbnail.d.ts +26 -1
  342. package/build/ts/surfaces/checkout/components/Progress.d.ts +29 -0
  343. package/build/ts/surfaces/checkout/components/QRCode.d.ts +28 -3
  344. package/build/ts/surfaces/checkout/components/QueryContainer.d.ts +1 -0
  345. package/build/ts/surfaces/checkout/components/ScrollBox.d.ts +57 -0
  346. package/build/ts/surfaces/checkout/components/Section.d.ts +4 -0
  347. package/build/ts/surfaces/checkout/components/Select.d.ts +21 -6
  348. package/build/ts/surfaces/checkout/components/Sheet.d.ts +40 -13
  349. package/build/ts/surfaces/checkout/components/SkeletonParagraph.d.ts +4 -0
  350. package/build/ts/surfaces/checkout/components/Spinner.d.ts +18 -0
  351. package/build/ts/surfaces/checkout/components/Stack.d.ts +112 -0
  352. package/build/ts/surfaces/checkout/components/Summary.d.ts +4 -0
  353. package/build/ts/surfaces/checkout/components/Switch.d.ts +17 -2
  354. package/build/ts/surfaces/checkout/components/Text.d.ts +4 -0
  355. package/build/ts/surfaces/checkout/components/TextArea.d.ts +23 -8
  356. package/build/ts/surfaces/checkout/components/TextField.d.ts +29 -10
  357. package/build/ts/surfaces/checkout/components/Time.d.ts +4 -0
  358. package/build/ts/surfaces/checkout/components/Tooltip.d.ts +21 -2
  359. package/build/ts/surfaces/checkout/components/UnorderedList.d.ts +4 -0
  360. package/build/ts/surfaces/checkout/components/UrlField.d.ts +29 -10
  361. package/build/ts/surfaces/checkout/components/components-shared.d.ts +616 -605
  362. package/build/ts/surfaces/checkout/components/components.d.ts +568 -288
  363. package/build/ts/surfaces/checkout/extension-targets.d.ts +13 -0
  364. package/build/ts/surfaces/checkout/extension-targets.d.ts.map +1 -1
  365. package/build/ts/surfaces/checkout/globals.d.ts +1 -0
  366. package/build/ts/surfaces/checkout/globals.d.ts.map +1 -1
  367. package/build/ts/surfaces/checkout/preact/api.d.ts +2 -0
  368. package/build/ts/surfaces/checkout/preact/api.d.ts.map +1 -1
  369. package/build/ts/surfaces/checkout/preact/app-metafields.d.ts +1 -0
  370. package/build/ts/surfaces/checkout/preact/app-metafields.d.ts.map +1 -1
  371. package/build/ts/surfaces/checkout/preact/attributes.d.ts +3 -0
  372. package/build/ts/surfaces/checkout/preact/attributes.d.ts.map +1 -1
  373. package/build/ts/surfaces/checkout/preact/billing-address.d.ts +1 -0
  374. package/build/ts/surfaces/checkout/preact/billing-address.d.ts.map +1 -1
  375. package/build/ts/surfaces/checkout/preact/buyer-identity.d.ts +4 -0
  376. package/build/ts/surfaces/checkout/preact/buyer-identity.d.ts.map +1 -1
  377. package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts +5 -0
  378. package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts.map +1 -1
  379. package/build/ts/surfaces/checkout/preact/capabilities.d.ts +2 -0
  380. package/build/ts/surfaces/checkout/preact/capabilities.d.ts.map +1 -1
  381. package/build/ts/surfaces/checkout/preact/cart-line-target.d.ts +1 -0
  382. package/build/ts/surfaces/checkout/preact/cart-line-target.d.ts.map +1 -1
  383. package/build/ts/surfaces/checkout/preact/cart-lines.d.ts +2 -0
  384. package/build/ts/surfaces/checkout/preact/cart-lines.d.ts.map +1 -1
  385. package/build/ts/surfaces/checkout/preact/checkout-settings.d.ts +1 -0
  386. package/build/ts/surfaces/checkout/preact/checkout-settings.d.ts.map +1 -1
  387. package/build/ts/surfaces/checkout/preact/checkout-token.d.ts +1 -0
  388. package/build/ts/surfaces/checkout/preact/checkout-token.d.ts.map +1 -1
  389. package/build/ts/surfaces/checkout/preact/cost.d.ts +4 -0
  390. package/build/ts/surfaces/checkout/preact/cost.d.ts.map +1 -1
  391. package/build/ts/surfaces/checkout/preact/country.d.ts +1 -0
  392. package/build/ts/surfaces/checkout/preact/country.d.ts.map +1 -1
  393. package/build/ts/surfaces/checkout/preact/currency.d.ts +1 -0
  394. package/build/ts/surfaces/checkout/preact/currency.d.ts.map +1 -1
  395. package/build/ts/surfaces/checkout/preact/customer-privacy.d.ts +1 -0
  396. package/build/ts/surfaces/checkout/preact/customer-privacy.d.ts.map +1 -1
  397. package/build/ts/surfaces/checkout/preact/delivery-group-list-target.d.ts +1 -0
  398. package/build/ts/surfaces/checkout/preact/delivery-group-list-target.d.ts.map +1 -1
  399. package/build/ts/surfaces/checkout/preact/delivery-group-target.d.ts +1 -0
  400. package/build/ts/surfaces/checkout/preact/delivery-group-target.d.ts.map +1 -1
  401. package/build/ts/surfaces/checkout/preact/delivery-group.d.ts +1 -0
  402. package/build/ts/surfaces/checkout/preact/delivery-group.d.ts.map +1 -1
  403. package/build/ts/surfaces/checkout/preact/delivery-groups.d.ts +1 -0
  404. package/build/ts/surfaces/checkout/preact/delivery-groups.d.ts.map +1 -1
  405. package/build/ts/surfaces/checkout/preact/delivery-selection-groups.d.ts +1 -0
  406. package/build/ts/surfaces/checkout/preact/delivery-selection-groups.d.ts.map +1 -1
  407. package/build/ts/surfaces/checkout/preact/discounts.d.ts +3 -0
  408. package/build/ts/surfaces/checkout/preact/discounts.d.ts.map +1 -1
  409. package/build/ts/surfaces/checkout/preact/extension-editor.d.ts +1 -0
  410. package/build/ts/surfaces/checkout/preact/extension-editor.d.ts.map +1 -1
  411. package/build/ts/surfaces/checkout/preact/extension-language.d.ts +1 -0
  412. package/build/ts/surfaces/checkout/preact/extension-language.d.ts.map +1 -1
  413. package/build/ts/surfaces/checkout/preact/extension.d.ts +2 -0
  414. package/build/ts/surfaces/checkout/preact/extension.d.ts.map +1 -1
  415. package/build/ts/surfaces/checkout/preact/gift-cards.d.ts +2 -0
  416. package/build/ts/surfaces/checkout/preact/gift-cards.d.ts.map +1 -1
  417. package/build/ts/surfaces/checkout/preact/instructions.d.ts +1 -0
  418. package/build/ts/surfaces/checkout/preact/instructions.d.ts.map +1 -1
  419. package/build/ts/surfaces/checkout/preact/language.d.ts +1 -0
  420. package/build/ts/surfaces/checkout/preact/language.d.ts.map +1 -1
  421. package/build/ts/surfaces/checkout/preact/localized-fields.d.ts +2 -0
  422. package/build/ts/surfaces/checkout/preact/localized-fields.d.ts.map +1 -1
  423. package/build/ts/surfaces/checkout/preact/market.d.ts +1 -0
  424. package/build/ts/surfaces/checkout/preact/market.d.ts.map +1 -1
  425. package/build/ts/surfaces/checkout/preact/metafields.d.ts +1 -0
  426. package/build/ts/surfaces/checkout/preact/metafields.d.ts.map +1 -1
  427. package/build/ts/surfaces/checkout/preact/note.d.ts +2 -0
  428. package/build/ts/surfaces/checkout/preact/note.d.ts.map +1 -1
  429. package/build/ts/surfaces/checkout/preact/payment-method.d.ts +3 -0
  430. package/build/ts/surfaces/checkout/preact/payment-method.d.ts.map +1 -1
  431. package/build/ts/surfaces/checkout/preact/payment-options.d.ts +2 -0
  432. package/build/ts/surfaces/checkout/preact/payment-options.d.ts.map +1 -1
  433. package/build/ts/surfaces/checkout/preact/pickup-location-option-target.d.ts +1 -0
  434. package/build/ts/surfaces/checkout/preact/pickup-location-option-target.d.ts.map +1 -1
  435. package/build/ts/surfaces/checkout/preact/redeemable.d.ts +1 -0
  436. package/build/ts/surfaces/checkout/preact/redeemable.d.ts.map +1 -1
  437. package/build/ts/surfaces/checkout/preact/session-token.d.ts +1 -0
  438. package/build/ts/surfaces/checkout/preact/session-token.d.ts.map +1 -1
  439. package/build/ts/surfaces/checkout/preact/settings.d.ts +1 -0
  440. package/build/ts/surfaces/checkout/preact/settings.d.ts.map +1 -1
  441. package/build/ts/surfaces/checkout/preact/shipping-address.d.ts +2 -0
  442. package/build/ts/surfaces/checkout/preact/shipping-address.d.ts.map +1 -1
  443. package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts +1 -0
  444. package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts.map +1 -1
  445. package/build/ts/surfaces/checkout/preact/shop.d.ts +1 -0
  446. package/build/ts/surfaces/checkout/preact/shop.d.ts.map +1 -1
  447. package/build/ts/surfaces/checkout/preact/storage.d.ts +1 -0
  448. package/build/ts/surfaces/checkout/preact/storage.d.ts.map +1 -1
  449. package/build/ts/surfaces/checkout/preact/subscription.d.ts +1 -0
  450. package/build/ts/surfaces/checkout/preact/subscription.d.ts.map +1 -1
  451. package/build/ts/surfaces/checkout/preact/target.d.ts +1 -0
  452. package/build/ts/surfaces/checkout/preact/target.d.ts.map +1 -1
  453. package/build/ts/surfaces/checkout/preact/timezone.d.ts +1 -0
  454. package/build/ts/surfaces/checkout/preact/timezone.d.ts.map +1 -1
  455. package/build/ts/surfaces/checkout/preact/translate.d.ts +1 -0
  456. package/build/ts/surfaces/checkout/preact/translate.d.ts.map +1 -1
  457. package/build/ts/surfaces/checkout/shared.d.ts +11 -19
  458. package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
  459. package/build/ts/surfaces/checkout/style/style.d.ts +1 -0
  460. package/build/ts/surfaces/checkout/style/style.d.ts.map +1 -1
  461. package/build/ts/surfaces/checkout/style/types.d.ts +20 -8
  462. package/build/ts/surfaces/checkout/style/types.d.ts.map +1 -1
  463. package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +1 -0
  464. package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +1 -0
  465. package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +1 -0
  466. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +1 -0
  467. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +1 -0
  468. package/build/ts/surfaces/checkout/targets/purchase.checkout.chat.render.d.ts +2 -1
  469. package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +1 -0
  470. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +1 -0
  471. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +1 -0
  472. package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +1 -0
  473. package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +1 -0
  474. package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +1 -0
  475. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +1 -0
  476. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +1 -0
  477. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +1 -0
  478. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +1 -0
  479. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +1 -0
  480. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +1 -0
  481. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +1 -0
  482. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +1 -0
  483. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +1 -0
  484. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +1 -0
  485. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +1 -0
  486. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +1 -0
  487. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +1 -0
  488. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +1 -0
  489. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +1 -0
  490. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +1 -0
  491. package/build/ts/surfaces/checkout/targets/purchase.thank-you.announcement.render.d.ts +1 -0
  492. package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +1 -0
  493. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +1 -0
  494. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +1 -0
  495. package/build/ts/surfaces/checkout/targets/purchase.thank-you.chat.render.d.ts +2 -1
  496. package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +1 -0
  497. package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +1 -0
  498. package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +1 -0
  499. package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts +3 -0
  500. package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts.map +1 -1
  501. package/build/ts/surfaces/customer-account/api/docs.d.ts +231 -3
  502. package/build/ts/surfaces/customer-account/api/docs.d.ts.map +1 -1
  503. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +454 -295
  504. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
  505. package/build/ts/surfaces/customer-account/api/shared.d.ts +209 -137
  506. package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -1
  507. package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts +84 -68
  508. package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
  509. package/build/ts/surfaces/customer-account/components/Abbreviation.d.ts +4 -0
  510. package/build/ts/surfaces/customer-account/components/Announcement.d.ts +38 -9
  511. package/build/ts/surfaces/customer-account/components/Avatar.d.ts +43 -15
  512. package/build/ts/surfaces/customer-account/components/Badge.d.ts +46 -3
  513. package/build/ts/surfaces/customer-account/components/Banner.d.ts +64 -9
  514. package/build/ts/surfaces/customer-account/components/Box.d.ts +52 -0
  515. package/build/ts/surfaces/customer-account/components/Button.d.ts +16 -3
  516. package/build/ts/surfaces/customer-account/components/ButtonGroup.d.ts +3 -3
  517. package/build/ts/surfaces/customer-account/components/Chat.d.ts +20 -0
  518. package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +17 -2
  519. package/build/ts/surfaces/customer-account/components/Chip.d.ts +8 -0
  520. package/build/ts/surfaces/customer-account/components/Choice.d.ts +8 -0
  521. package/build/ts/surfaces/customer-account/components/ChoiceList.d.ts +17 -2
  522. package/build/ts/surfaces/customer-account/components/Clickable.d.ts +37 -7
  523. package/build/ts/surfaces/customer-account/components/ClickableChip.d.ts +23 -5
  524. package/build/ts/surfaces/customer-account/components/ClipboardItem.d.ts +16 -2
  525. package/build/ts/surfaces/customer-account/components/ConsentCheckbox.d.ts +17 -2
  526. package/build/ts/surfaces/customer-account/components/ConsentPhoneField.d.ts +29 -10
  527. package/build/ts/surfaces/customer-account/components/CustomerAccountAction.d.ts +3 -3
  528. package/build/ts/surfaces/customer-account/components/DateField.d.ts +31 -6
  529. package/build/ts/surfaces/customer-account/components/DatePicker.d.ts +28 -5
  530. package/build/ts/surfaces/customer-account/components/Details.d.ts +14 -0
  531. package/build/ts/surfaces/customer-account/components/Divider.d.ts +1 -0
  532. package/build/ts/surfaces/customer-account/components/DropZone.d.ts +22 -3
  533. package/build/ts/surfaces/customer-account/components/EmailField.d.ts +29 -10
  534. package/build/ts/surfaces/customer-account/components/Form.d.ts +16 -1
  535. package/build/ts/surfaces/customer-account/components/Grid.d.ts +139 -0
  536. package/build/ts/surfaces/customer-account/components/GridItem.d.ts +57 -0
  537. package/build/ts/surfaces/customer-account/components/Heading.d.ts +4 -0
  538. package/build/ts/surfaces/customer-account/components/Icon.d.ts +49 -4
  539. package/build/ts/surfaces/customer-account/components/Image.d.ts +43 -1
  540. package/build/ts/surfaces/customer-account/components/ImageGroup.d.ts +7 -2
  541. package/build/ts/surfaces/customer-account/components/Link.d.ts +16 -3
  542. package/build/ts/surfaces/customer-account/components/ListItem.d.ts +4 -0
  543. package/build/ts/surfaces/customer-account/components/Map.d.ts +68 -6
  544. package/build/ts/surfaces/customer-account/components/MapMarker.d.ts +39 -8
  545. package/build/ts/surfaces/customer-account/components/Menu.d.ts +1 -1
  546. package/build/ts/surfaces/customer-account/components/Modal.d.ts +52 -8
  547. package/build/ts/surfaces/customer-account/components/MoneyField.d.ts +23 -8
  548. package/build/ts/surfaces/customer-account/components/NumberField.d.ts +29 -10
  549. package/build/ts/surfaces/customer-account/components/Option.d.ts +4 -0
  550. package/build/ts/surfaces/customer-account/components/OrderedList.d.ts +4 -0
  551. package/build/ts/surfaces/customer-account/components/Page.d.ts +5 -5
  552. package/build/ts/surfaces/customer-account/components/Paragraph.d.ts +4 -0
  553. package/build/ts/surfaces/customer-account/components/PasswordField.d.ts +29 -10
  554. package/build/ts/surfaces/customer-account/components/PaymentIcon.d.ts +17 -1
  555. package/build/ts/surfaces/customer-account/components/PhoneField.d.ts +29 -10
  556. package/build/ts/surfaces/customer-account/components/Popover.d.ts +39 -22
  557. package/build/ts/surfaces/customer-account/components/PressButton.d.ts +20 -6
  558. package/build/ts/surfaces/customer-account/components/ProductThumbnail.d.ts +26 -1
  559. package/build/ts/surfaces/customer-account/components/Progress.d.ts +29 -0
  560. package/build/ts/surfaces/customer-account/components/QRCode.d.ts +28 -3
  561. package/build/ts/surfaces/customer-account/components/QueryContainer.d.ts +1 -0
  562. package/build/ts/surfaces/customer-account/components/ScrollBox.d.ts +57 -0
  563. package/build/ts/surfaces/customer-account/components/Section.d.ts +4 -0
  564. package/build/ts/surfaces/customer-account/components/Select.d.ts +21 -6
  565. package/build/ts/surfaces/customer-account/components/Sheet.d.ts +40 -13
  566. package/build/ts/surfaces/customer-account/components/SkeletonParagraph.d.ts +4 -0
  567. package/build/ts/surfaces/customer-account/components/Spinner.d.ts +18 -0
  568. package/build/ts/surfaces/customer-account/components/Stack.d.ts +112 -0
  569. package/build/ts/surfaces/customer-account/components/Summary.d.ts +4 -0
  570. package/build/ts/surfaces/customer-account/components/Switch.d.ts +17 -2
  571. package/build/ts/surfaces/customer-account/components/Text.d.ts +4 -0
  572. package/build/ts/surfaces/customer-account/components/TextArea.d.ts +23 -8
  573. package/build/ts/surfaces/customer-account/components/TextField.d.ts +29 -10
  574. package/build/ts/surfaces/customer-account/components/Time.d.ts +4 -0
  575. package/build/ts/surfaces/customer-account/components/Tooltip.d.ts +21 -2
  576. package/build/ts/surfaces/customer-account/components/UnorderedList.d.ts +4 -0
  577. package/build/ts/surfaces/customer-account/components/UrlField.d.ts +29 -10
  578. package/build/ts/surfaces/customer-account/components/components-shared.d.ts +616 -605
  579. package/build/ts/surfaces/customer-account/components/components.d.ts +568 -288
  580. package/build/ts/surfaces/customer-account/components/shared.d.ts +23 -2
  581. package/build/ts/surfaces/customer-account/components/shared.d.ts.map +1 -1
  582. package/build/ts/surfaces/customer-account/components/shared.ts +23 -5
  583. package/build/ts/surfaces/customer-account/extension-targets.d.ts +8 -0
  584. package/build/ts/surfaces/customer-account/extension-targets.d.ts.map +1 -1
  585. package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +1 -0
  586. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +1 -0
  587. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +1 -0
  588. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +1 -0
  589. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +1 -0
  590. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +1 -0
  591. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +1 -0
  592. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +1 -0
  593. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +1 -0
  594. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +1 -0
  595. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +1 -0
  596. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +1 -0
  597. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +1 -0
  598. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +1 -0
  599. package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +1 -0
  600. package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +1 -0
  601. package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +1 -0
  602. package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +1 -0
  603. package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +1 -0
  604. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +1 -0
  605. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +1 -0
  606. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +1 -0
  607. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +1 -0
  608. package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +1 -0
  609. package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts +4 -0
  610. package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts.map +1 -1
  611. package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts +3 -0
  612. package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts.map +1 -1
  613. package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts +4 -0
  614. package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts.map +1 -1
  615. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +7 -0
  616. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
  617. package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts +1 -0
  618. package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts.map +1 -1
  619. package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts +2 -0
  620. package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts.map +1 -1
  621. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts +9 -0
  622. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts.map +1 -1
  623. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +5 -0
  624. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -1
  625. package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts +5 -0
  626. package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts.map +1 -1
  627. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +5 -0
  628. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -1
  629. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts +5 -0
  630. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts.map +1 -1
  631. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts +9 -0
  632. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map +1 -1
  633. package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +2 -0
  634. package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts.map +1 -1
  635. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +5 -0
  636. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map +1 -1
  637. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +2 -0
  638. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -1
  639. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +5 -0
  640. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -1
  641. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts +10 -0
  642. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts.map +1 -1
  643. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +12 -1
  644. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts.map +1 -1
  645. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts +5 -0
  646. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts.map +1 -1
  647. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +3 -0
  648. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -1
  649. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts +1 -0
  650. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -1
  651. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +5 -0
  652. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -1
  653. package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +5 -0
  654. package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +6 -0
  655. package/build/ts/surfaces/point-of-sale/components/Box.d.ts +6 -0
  656. package/build/ts/surfaces/point-of-sale/components/Button.d.ts +6 -0
  657. package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +5 -0
  658. package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +6 -0
  659. package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +6 -0
  660. package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +7 -0
  661. package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +6 -0
  662. package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +6 -0
  663. package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +5 -0
  664. package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +8 -0
  665. package/build/ts/surfaces/point-of-sale/components/Embed.d.ts +6 -0
  666. package/build/ts/surfaces/point-of-sale/components/EmptyState.d.ts +7 -0
  667. package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +5 -0
  668. package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +6 -0
  669. package/build/ts/surfaces/point-of-sale/components/Image.d.ts +5 -0
  670. package/build/ts/surfaces/point-of-sale/components/Link.d.ts +7 -0
  671. package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +7 -0
  672. package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +7 -0
  673. package/build/ts/surfaces/point-of-sale/components/Page.d.ts +6 -0
  674. package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +6 -0
  675. package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +5 -0
  676. package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +6 -0
  677. package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +6 -0
  678. package/build/ts/surfaces/point-of-sale/components/Section.d.ts +6 -0
  679. package/build/ts/surfaces/point-of-sale/components/Spinner.d.ts +6 -0
  680. package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +7 -0
  681. package/build/ts/surfaces/point-of-sale/components/Switch.d.ts +7 -0
  682. package/build/ts/surfaces/point-of-sale/components/Tab.d.ts +6 -0
  683. package/build/ts/surfaces/point-of-sale/components/TabList.d.ts +6 -0
  684. package/build/ts/surfaces/point-of-sale/components/TabPanel.d.ts +6 -0
  685. package/build/ts/surfaces/point-of-sale/components/Tabs.d.ts +7 -0
  686. package/build/ts/surfaces/point-of-sale/components/Text.d.ts +5 -0
  687. package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +8 -0
  688. package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +7 -0
  689. package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +6 -0
  690. package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +6 -0
  691. package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +6 -0
  692. package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +135 -0
  693. package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts +3 -0
  694. package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts.map +1 -1
  695. package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts +3 -0
  696. package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts.map +1 -1
  697. package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts +3 -0
  698. package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts.map +1 -1
  699. package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +3 -0
  700. package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts.map +1 -1
  701. package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts +3 -0
  702. package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts.map +1 -1
  703. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +3 -0
  704. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
  705. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +1 -0
  706. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
  707. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +3 -2
  708. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
  709. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +1 -0
  710. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
  711. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +2 -0
  712. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
  713. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +1 -0
  714. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
  715. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +24 -2
  716. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
  717. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +1 -0
  718. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
  719. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +1 -0
  720. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
  721. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +2 -0
  722. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
  723. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +1 -0
  724. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
  725. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +18 -0
  726. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
  727. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +1 -0
  728. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
  729. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +13 -0
  730. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
  731. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +1 -0
  732. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
  733. package/build/ts/surfaces/point-of-sale/types/device.d.ts +1 -0
  734. package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
  735. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +1 -0
  736. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts.map +1 -1
  737. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +1 -0
  738. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -1
  739. package/build/ts/surfaces/point-of-sale/types/money.d.ts +2 -0
  740. package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
  741. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -0
  742. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
  743. package/build/ts/surfaces/point-of-sale/types/order.d.ts +2 -0
  744. package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
  745. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +1 -0
  746. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
  747. package/build/ts/surfaces/point-of-sale/types/payment.d.ts +2 -0
  748. package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
  749. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +5 -0
  750. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -1
  751. package/build/ts/surfaces/point-of-sale/types/product.d.ts +5 -0
  752. package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
  753. package/build/ts/surfaces/point-of-sale/types/session.d.ts +1 -0
  754. package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
  755. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +3 -0
  756. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
  757. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +4 -0
  758. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
  759. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +1 -0
  760. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
  761. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +1 -0
  762. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
  763. package/build/tsconfig.tsbuildinfo +1 -1
  764. package/package.json +2 -2
  765. package/src/docs/shared/components/Abbreviation.ts +1 -1
  766. package/src/docs/shared/components/Announcement.ts +1 -1
  767. package/src/docs/shared/components/Avatar.ts +2 -2
  768. package/src/docs/shared/components/Badge.ts +2 -2
  769. package/src/docs/shared/components/Banner.ts +2 -2
  770. package/src/docs/shared/components/Box.ts +2 -2
  771. package/src/docs/shared/components/Button.ts +2 -2
  772. package/src/docs/shared/components/ButtonGroup.ts +2 -2
  773. package/src/docs/shared/components/Checkbox.ts +2 -2
  774. package/src/docs/shared/components/Chip.ts +2 -2
  775. package/src/docs/shared/components/Choice.ts +1 -1
  776. package/src/docs/shared/components/ChoiceList.ts +2 -2
  777. package/src/docs/shared/components/Clickable.ts +2 -2
  778. package/src/docs/shared/components/ClickableChip.ts +2 -2
  779. package/src/docs/shared/components/ClipboardItem.ts +1 -1
  780. package/src/docs/shared/components/ColorField.ts +2 -2
  781. package/src/docs/shared/components/ColorPicker.ts +2 -2
  782. package/src/docs/shared/components/ConsentCheckbox.ts +1 -1
  783. package/src/docs/shared/components/ConsentPhoneField.ts +1 -1
  784. package/src/docs/shared/components/DateField.ts +2 -2
  785. package/src/docs/shared/components/DatePicker.ts +2 -2
  786. package/src/docs/shared/components/Details.ts +1 -1
  787. package/src/docs/shared/components/Divider.ts +2 -2
  788. package/src/docs/shared/components/DropZone.ts +1 -1
  789. package/src/docs/shared/components/EmailField.ts +2 -2
  790. package/src/docs/shared/components/Form.ts +2 -2
  791. package/src/docs/shared/components/FunctionSettings.ts +2 -2
  792. package/src/docs/shared/components/Grid.ts +2 -2
  793. package/src/docs/shared/components/GridItem.ts +1 -1
  794. package/src/docs/shared/components/Heading.ts +2 -2
  795. package/src/docs/shared/components/Icon.ts +2 -2
  796. package/src/docs/shared/components/Image.ts +2 -2
  797. package/src/docs/shared/components/Link.ts +2 -2
  798. package/src/docs/shared/components/ListItem.ts +1 -1
  799. package/src/docs/shared/components/Map.ts +1 -1
  800. package/src/docs/shared/components/MapMarker.ts +1 -1
  801. package/src/docs/shared/components/Menu.ts +1 -1
  802. package/src/docs/shared/components/Modal.ts +1 -1
  803. package/src/docs/shared/components/MoneyField.ts +2 -2
  804. package/src/docs/shared/components/NumberField.ts +2 -2
  805. package/src/docs/shared/components/Option.ts +1 -1
  806. package/src/docs/shared/components/OptionGroup.ts +1 -1
  807. package/src/docs/shared/components/OrderedList.ts +2 -2
  808. package/src/docs/shared/components/Page.ts +2 -2
  809. package/src/docs/shared/components/Paragraph.ts +2 -2
  810. package/src/docs/shared/components/PasswordField.ts +2 -2
  811. package/src/docs/shared/components/PaymentIcon.ts +1 -1
  812. package/src/docs/shared/components/PhoneField.ts +1 -1
  813. package/src/docs/shared/components/Popover.ts +1 -1
  814. package/src/docs/shared/components/PressButton.ts +1 -1
  815. package/src/docs/shared/components/ProductThumbnail.ts +1 -1
  816. package/src/docs/shared/components/Progress.ts +1 -1
  817. package/src/docs/shared/components/QRCode.ts +1 -1
  818. package/src/docs/shared/components/QueryContainer.ts +1 -1
  819. package/src/docs/shared/components/ScrollBox.ts +1 -1
  820. package/src/docs/shared/components/SearchField.ts +2 -2
  821. package/src/docs/shared/components/Section.ts +2 -2
  822. package/src/docs/shared/components/Select.ts +2 -2
  823. package/src/docs/shared/components/Sheet.ts +1 -1
  824. package/src/docs/shared/components/SkeletonParagraph.ts +1 -1
  825. package/src/docs/shared/components/Spinner.ts +2 -2
  826. package/src/docs/shared/components/Stack.ts +2 -2
  827. package/src/docs/shared/components/Summary.ts +1 -1
  828. package/src/docs/shared/components/Switch.ts +2 -2
  829. package/src/docs/shared/components/Table.ts +1 -1
  830. package/src/docs/shared/components/TableBody.ts +1 -1
  831. package/src/docs/shared/components/TableCell.ts +1 -1
  832. package/src/docs/shared/components/TableHeader.ts +1 -1
  833. package/src/docs/shared/components/TableHeaderRow.ts +1 -1
  834. package/src/docs/shared/components/TableRow.ts +1 -1
  835. package/src/docs/shared/components/Text.ts +2 -2
  836. package/src/docs/shared/components/TextArea.ts +2 -2
  837. package/src/docs/shared/components/TextField.ts +2 -2
  838. package/src/docs/shared/components/Thumbnail.ts +2 -2
  839. package/src/docs/shared/components/Time.ts +1 -1
  840. package/src/docs/shared/components/Tooltip.ts +1 -1
  841. package/src/docs/shared/components/URLField.ts +2 -2
  842. package/src/docs/shared/components/UnorderedList.ts +2 -2
  843. package/src/shared.ts +32 -12
  844. package/src/surfaces/admin/api/action/action.ts +1 -0
  845. package/src/surfaces/admin/api/block/block.ts +2 -0
  846. package/src/surfaces/admin/api/checkout-rules/launch-options.ts +7 -3
  847. package/src/surfaces/admin/api/checkout-rules/metafields.ts +13 -6
  848. package/src/surfaces/admin/api/checkout-rules/validation-settings.ts +1 -0
  849. package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts +3 -0
  850. package/src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts +1 -0
  851. package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +7 -2
  852. package/src/surfaces/admin/api/discount-function-settings/metafields.ts +13 -6
  853. package/src/surfaces/admin/api/intents/intent-render.ts +26 -0
  854. package/src/surfaces/admin/api/intents/intents.ts +49 -8
  855. package/src/surfaces/admin/api/order-routing-rule/data.ts +5 -2
  856. package/src/surfaces/admin/api/order-routing-rule/metafields.ts +8 -3
  857. package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts +1 -0
  858. package/src/surfaces/admin/api/picker/picker.ts +15 -6
  859. package/src/surfaces/admin/api/print-action/print-action.ts +1 -0
  860. package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts +4 -1
  861. package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts +4 -1
  862. package/src/surfaces/admin/api/purchase-options-card-action.ts +1 -0
  863. package/src/surfaces/admin/api/resource-picker/resource-picker.ts +36 -17
  864. package/src/surfaces/admin/api/shared.ts +2 -0
  865. package/src/surfaces/admin/api/standard/standard-rendering.ts +3 -0
  866. package/src/surfaces/admin/api/standard/standard.ts +4 -1
  867. package/src/surfaces/admin/api/standard/storage.ts +4 -0
  868. package/src/surfaces/admin/api.ts +1 -0
  869. package/src/surfaces/admin/components/AdminAction.d.ts +6 -0
  870. package/src/surfaces/admin/components/AdminBlock.d.ts +6 -0
  871. package/src/surfaces/admin/components/AdminPrintAction.d.ts +6 -0
  872. package/src/surfaces/admin/components/Avatar.d.ts +9 -0
  873. package/src/surfaces/admin/components/Badge.d.ts +10 -1
  874. package/src/surfaces/admin/components/Banner.d.ts +11 -0
  875. package/src/surfaces/admin/components/Box.d.ts +14 -0
  876. package/src/surfaces/admin/components/Button.d.ts +15 -1
  877. package/src/surfaces/admin/components/ButtonGroup.d.ts +8 -0
  878. package/src/surfaces/admin/components/Checkbox.d.ts +12 -1
  879. package/src/surfaces/admin/components/Chip.d.ts +4 -2
  880. package/src/surfaces/admin/components/Choice.d.ts +10 -2
  881. package/src/surfaces/admin/components/ChoiceList.d.ts +12 -2
  882. package/src/surfaces/admin/components/Clickable.d.ts +23 -11
  883. package/src/surfaces/admin/components/ClickableChip.d.ts +11 -0
  884. package/src/surfaces/admin/components/ColorField.d.ts +12 -0
  885. package/src/surfaces/admin/components/ColorPicker.d.ts +9 -0
  886. package/src/surfaces/admin/components/DateField.d.ts +11 -0
  887. package/src/surfaces/admin/components/DatePicker.d.ts +10 -1
  888. package/src/surfaces/admin/components/Divider.d.ts +7 -0
  889. package/src/surfaces/admin/components/DropZone.d.ts +8 -4
  890. package/src/surfaces/admin/components/EmailField.d.ts +12 -0
  891. package/src/surfaces/admin/components/Form.d.ts +10 -0
  892. package/src/surfaces/admin/components/FunctionSettings.d.ts +12 -0
  893. package/src/surfaces/admin/components/Grid.d.ts +28 -12
  894. package/src/surfaces/admin/components/GridItem.d.ts +22 -7
  895. package/src/surfaces/admin/components/Heading.d.ts +8 -0
  896. package/src/surfaces/admin/components/Icon.d.ts +6 -3
  897. package/src/surfaces/admin/components/Image.d.ts +22 -7
  898. package/src/surfaces/admin/components/Link.d.ts +13 -3
  899. package/src/surfaces/admin/components/ListItem.d.ts +8 -0
  900. package/src/surfaces/admin/components/Menu.d.ts +11 -0
  901. package/src/surfaces/admin/components/Modal.d.ts +8 -4
  902. package/src/surfaces/admin/components/MoneyField.d.ts +13 -0
  903. package/src/surfaces/admin/components/NumberField.d.ts +12 -0
  904. package/src/surfaces/admin/components/Option.d.ts +10 -2
  905. package/src/surfaces/admin/components/OptionGroup.d.ts +10 -2
  906. package/src/surfaces/admin/components/OrderedList.d.ts +8 -0
  907. package/src/surfaces/admin/components/Page.d.ts +4 -2
  908. package/src/surfaces/admin/components/Paragraph.d.ts +8 -0
  909. package/src/surfaces/admin/components/PasswordField.d.ts +12 -0
  910. package/src/surfaces/admin/components/QueryContainer.d.ts +8 -0
  911. package/src/surfaces/admin/components/SearchField.d.ts +13 -1
  912. package/src/surfaces/admin/components/Section.d.ts +9 -0
  913. package/src/surfaces/admin/components/Select.d.ts +14 -2
  914. package/src/surfaces/admin/components/Spinner.d.ts +7 -0
  915. package/src/surfaces/admin/components/Stack.d.ts +27 -11
  916. package/src/surfaces/admin/components/Switch.d.ts +12 -1
  917. package/src/surfaces/admin/components/Table.d.ts +15 -0
  918. package/src/surfaces/admin/components/TableBody.d.ts +8 -0
  919. package/src/surfaces/admin/components/TableCell.d.ts +9 -0
  920. package/src/surfaces/admin/components/TableHeader.d.ts +9 -0
  921. package/src/surfaces/admin/components/TableHeaderRow.d.ts +8 -0
  922. package/src/surfaces/admin/components/TableRow.d.ts +8 -0
  923. package/src/surfaces/admin/components/Text.d.ts +19 -0
  924. package/src/surfaces/admin/components/TextArea.d.ts +12 -0
  925. package/src/surfaces/admin/components/TextField.d.ts +14 -1
  926. package/src/surfaces/admin/components/Thumbnail.d.ts +9 -0
  927. package/src/surfaces/admin/components/Tooltip.d.ts +11 -0
  928. package/src/surfaces/admin/components/URLField.d.ts +12 -0
  929. package/src/surfaces/admin/components/UnorderedList.d.ts +14 -0
  930. package/src/surfaces/admin/components/shared.d.ts +267 -0
  931. package/src/surfaces/admin/components.d.ts +722 -22
  932. package/src/surfaces/admin/extension-targets.ts +12 -0
  933. package/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts +2 -0
  934. package/src/surfaces/checkout/api/address-autocomplete/shared.ts +3 -0
  935. package/src/surfaces/checkout/api/address-autocomplete/standard.ts +1 -0
  936. package/src/surfaces/checkout/api/address-autocomplete/suggest.ts +2 -0
  937. package/src/surfaces/checkout/api/announcement/announcement.ts +1 -0
  938. package/src/surfaces/checkout/api/cart-line/cart-line-item.ts +5 -1
  939. package/src/surfaces/checkout/api/checkout/checkout.ts +258 -122
  940. package/src/surfaces/checkout/api/docs.ts +34 -3
  941. package/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts +12 -5
  942. package/src/surfaces/checkout/api/payment/payment-option-item.ts +7 -0
  943. package/src/surfaces/checkout/api/pickup/pickup-location-item.ts +3 -2
  944. package/src/surfaces/checkout/api/pickup/pickup-location-list.ts +4 -1
  945. package/src/surfaces/checkout/api/pickup/pickup-point-list.ts +4 -1
  946. package/src/surfaces/checkout/api/redeemable/redeemable.ts +7 -0
  947. package/src/surfaces/checkout/api/shared.ts +79 -31
  948. package/src/surfaces/checkout/api/shipping/shipping-option-item.ts +6 -4
  949. package/src/surfaces/checkout/api/shipping/shipping-option-list.ts +18 -12
  950. package/src/surfaces/checkout/api/standard/standard.ts +661 -446
  951. package/src/surfaces/checkout/components/Abbreviation.d.ts +4 -0
  952. package/src/surfaces/checkout/components/Announcement.d.ts +38 -9
  953. package/src/surfaces/checkout/components/Badge.d.ts +46 -3
  954. package/src/surfaces/checkout/components/Banner.d.ts +64 -9
  955. package/src/surfaces/checkout/components/Box.d.ts +52 -0
  956. package/src/surfaces/checkout/components/Button.d.ts +16 -3
  957. package/src/surfaces/checkout/components/Chat.d.ts +20 -0
  958. package/src/surfaces/checkout/components/Checkbox.d.ts +17 -2
  959. package/src/surfaces/checkout/components/Chip.d.ts +8 -0
  960. package/src/surfaces/checkout/components/Choice.d.ts +8 -0
  961. package/src/surfaces/checkout/components/ChoiceList.d.ts +17 -2
  962. package/src/surfaces/checkout/components/Clickable.d.ts +37 -7
  963. package/src/surfaces/checkout/components/ClickableChip.d.ts +23 -5
  964. package/src/surfaces/checkout/components/ClipboardItem.d.ts +16 -2
  965. package/src/surfaces/checkout/components/ConsentCheckbox.d.ts +17 -2
  966. package/src/surfaces/checkout/components/ConsentPhoneField.d.ts +29 -10
  967. package/src/surfaces/checkout/components/DateField.d.ts +31 -6
  968. package/src/surfaces/checkout/components/DatePicker.d.ts +28 -5
  969. package/src/surfaces/checkout/components/Details.d.ts +14 -0
  970. package/src/surfaces/checkout/components/Divider.d.ts +1 -0
  971. package/src/surfaces/checkout/components/DropZone.d.ts +22 -3
  972. package/src/surfaces/checkout/components/EmailField.d.ts +29 -10
  973. package/src/surfaces/checkout/components/Form.d.ts +16 -1
  974. package/src/surfaces/checkout/components/Grid.d.ts +139 -0
  975. package/src/surfaces/checkout/components/GridItem.d.ts +57 -0
  976. package/src/surfaces/checkout/components/Heading.d.ts +4 -0
  977. package/src/surfaces/checkout/components/Icon.d.ts +49 -4
  978. package/src/surfaces/checkout/components/Image.d.ts +43 -1
  979. package/src/surfaces/checkout/components/Link.d.ts +16 -3
  980. package/src/surfaces/checkout/components/ListItem.d.ts +4 -0
  981. package/src/surfaces/checkout/components/Map.d.ts +68 -6
  982. package/src/surfaces/checkout/components/MapMarker.d.ts +39 -8
  983. package/src/surfaces/checkout/components/Modal.d.ts +52 -8
  984. package/src/surfaces/checkout/components/MoneyField.d.ts +23 -8
  985. package/src/surfaces/checkout/components/NumberField.d.ts +29 -10
  986. package/src/surfaces/checkout/components/Option.d.ts +4 -0
  987. package/src/surfaces/checkout/components/OrderedList.d.ts +4 -0
  988. package/src/surfaces/checkout/components/Paragraph.d.ts +4 -0
  989. package/src/surfaces/checkout/components/PasswordField.d.ts +29 -10
  990. package/src/surfaces/checkout/components/PaymentIcon.d.ts +17 -1
  991. package/src/surfaces/checkout/components/PhoneField.d.ts +29 -10
  992. package/src/surfaces/checkout/components/Popover.d.ts +39 -22
  993. package/src/surfaces/checkout/components/PressButton.d.ts +20 -6
  994. package/src/surfaces/checkout/components/ProductThumbnail.d.ts +26 -1
  995. package/src/surfaces/checkout/components/Progress.d.ts +29 -0
  996. package/src/surfaces/checkout/components/QRCode.d.ts +28 -3
  997. package/src/surfaces/checkout/components/QueryContainer.d.ts +1 -0
  998. package/src/surfaces/checkout/components/ScrollBox.d.ts +57 -0
  999. package/src/surfaces/checkout/components/Section.d.ts +4 -0
  1000. package/src/surfaces/checkout/components/Select.d.ts +21 -6
  1001. package/src/surfaces/checkout/components/Sheet.d.ts +40 -13
  1002. package/src/surfaces/checkout/components/SkeletonParagraph.d.ts +4 -0
  1003. package/src/surfaces/checkout/components/Spinner.d.ts +18 -0
  1004. package/src/surfaces/checkout/components/Stack.d.ts +112 -0
  1005. package/src/surfaces/checkout/components/Summary.d.ts +4 -0
  1006. package/src/surfaces/checkout/components/Switch.d.ts +17 -2
  1007. package/src/surfaces/checkout/components/Text.d.ts +4 -0
  1008. package/src/surfaces/checkout/components/TextArea.d.ts +23 -8
  1009. package/src/surfaces/checkout/components/TextField.d.ts +29 -10
  1010. package/src/surfaces/checkout/components/Time.d.ts +4 -0
  1011. package/src/surfaces/checkout/components/Tooltip.d.ts +21 -2
  1012. package/src/surfaces/checkout/components/UnorderedList.d.ts +4 -0
  1013. package/src/surfaces/checkout/components/UrlField.d.ts +29 -10
  1014. package/src/surfaces/checkout/components/components-shared.d.ts +616 -605
  1015. package/src/surfaces/checkout/components/components.d.ts +568 -288
  1016. package/src/surfaces/checkout/extension-targets.ts +13 -0
  1017. package/src/surfaces/checkout/globals.ts +1 -0
  1018. package/src/surfaces/checkout/preact/api.ts +2 -0
  1019. package/src/surfaces/checkout/preact/app-metafields.ts +1 -0
  1020. package/src/surfaces/checkout/preact/attributes.ts +3 -0
  1021. package/src/surfaces/checkout/preact/billing-address.ts +1 -0
  1022. package/src/surfaces/checkout/preact/buyer-identity.ts +4 -0
  1023. package/src/surfaces/checkout/preact/buyer-journey.ts +5 -0
  1024. package/src/surfaces/checkout/preact/capabilities.ts +2 -0
  1025. package/src/surfaces/checkout/preact/cart-line-target.ts +1 -0
  1026. package/src/surfaces/checkout/preact/cart-lines.ts +2 -0
  1027. package/src/surfaces/checkout/preact/checkout-settings.ts +1 -0
  1028. package/src/surfaces/checkout/preact/checkout-token.ts +1 -0
  1029. package/src/surfaces/checkout/preact/cost.ts +4 -0
  1030. package/src/surfaces/checkout/preact/country.ts +1 -0
  1031. package/src/surfaces/checkout/preact/currency.ts +1 -0
  1032. package/src/surfaces/checkout/preact/customer-privacy.ts +1 -0
  1033. package/src/surfaces/checkout/preact/delivery-group-list-target.ts +1 -0
  1034. package/src/surfaces/checkout/preact/delivery-group-target.ts +1 -0
  1035. package/src/surfaces/checkout/preact/delivery-group.ts +1 -0
  1036. package/src/surfaces/checkout/preact/delivery-groups.ts +1 -0
  1037. package/src/surfaces/checkout/preact/delivery-selection-groups.ts +1 -0
  1038. package/src/surfaces/checkout/preact/discounts.ts +3 -0
  1039. package/src/surfaces/checkout/preact/extension-editor.ts +1 -0
  1040. package/src/surfaces/checkout/preact/extension-language.ts +1 -0
  1041. package/src/surfaces/checkout/preact/extension.ts +2 -0
  1042. package/src/surfaces/checkout/preact/gift-cards.ts +2 -0
  1043. package/src/surfaces/checkout/preact/instructions.ts +1 -0
  1044. package/src/surfaces/checkout/preact/language.ts +1 -0
  1045. package/src/surfaces/checkout/preact/localized-fields.ts +2 -0
  1046. package/src/surfaces/checkout/preact/market.ts +1 -0
  1047. package/src/surfaces/checkout/preact/metafields.ts +1 -0
  1048. package/src/surfaces/checkout/preact/note.ts +2 -0
  1049. package/src/surfaces/checkout/preact/payment-method.ts +3 -0
  1050. package/src/surfaces/checkout/preact/payment-options.ts +2 -0
  1051. package/src/surfaces/checkout/preact/pickup-location-option-target.ts +1 -0
  1052. package/src/surfaces/checkout/preact/redeemable.ts +1 -0
  1053. package/src/surfaces/checkout/preact/session-token.ts +1 -0
  1054. package/src/surfaces/checkout/preact/settings.ts +1 -0
  1055. package/src/surfaces/checkout/preact/shipping-address.ts +2 -0
  1056. package/src/surfaces/checkout/preact/shipping-option-target.ts +1 -0
  1057. package/src/surfaces/checkout/preact/shop.ts +1 -0
  1058. package/src/surfaces/checkout/preact/storage.ts +1 -0
  1059. package/src/surfaces/checkout/preact/subscription.ts +1 -0
  1060. package/src/surfaces/checkout/preact/target.ts +1 -0
  1061. package/src/surfaces/checkout/preact/timezone.ts +1 -0
  1062. package/src/surfaces/checkout/preact/translate.ts +1 -0
  1063. package/src/surfaces/checkout/shared.ts +11 -21
  1064. package/src/surfaces/checkout/style/style.ts +1 -0
  1065. package/src/surfaces/checkout/style/types.ts +20 -7
  1066. package/src/surfaces/customer-account/api/cart-line/cart-line-item.ts +3 -0
  1067. package/src/surfaces/customer-account/api/docs.ts +236 -5
  1068. package/src/surfaces/customer-account/api/order-status/order-status.ts +461 -295
  1069. package/src/surfaces/customer-account/api/shared.ts +210 -137
  1070. package/src/surfaces/customer-account/api/standard-api/standard-api.ts +84 -68
  1071. package/src/surfaces/customer-account/components/Avatar.d.ts +43 -15
  1072. package/src/surfaces/customer-account/components/ButtonGroup.d.ts +3 -3
  1073. package/src/surfaces/customer-account/components/CustomerAccountAction.d.ts +3 -3
  1074. package/src/surfaces/customer-account/components/ImageGroup.d.ts +7 -2
  1075. package/src/surfaces/customer-account/components/Menu.d.ts +1 -1
  1076. package/src/surfaces/customer-account/components/Page.d.ts +5 -5
  1077. package/src/surfaces/customer-account/components/Section.d.ts +3 -7
  1078. package/src/surfaces/customer-account/components/shared.ts +23 -5
  1079. package/src/surfaces/customer-account/components.d.ts +93 -0
  1080. package/src/surfaces/customer-account/extension-targets.ts +8 -0
  1081. package/src/surfaces/point-of-sale/api/action-api/action-api.ts +4 -0
  1082. package/src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts +3 -0
  1083. package/src/surfaces/point-of-sale/api/camera-api/camera-api.ts +4 -0
  1084. package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +7 -0
  1085. package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +1 -0
  1086. package/src/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.ts +2 -0
  1087. package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +9 -0
  1088. package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +5 -0
  1089. package/src/surfaces/point-of-sale/api/device-api/device-api.ts +5 -0
  1090. package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +5 -0
  1091. package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +5 -0
  1092. package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +9 -0
  1093. package/src/surfaces/point-of-sale/api/order-api/order-api.ts +2 -0
  1094. package/src/surfaces/point-of-sale/api/pin-pad-api.ts +5 -0
  1095. package/src/surfaces/point-of-sale/api/print-api/print-api.ts +2 -0
  1096. package/src/surfaces/point-of-sale/api/product-api/product-api.ts +5 -0
  1097. package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +10 -0
  1098. package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +12 -1
  1099. package/src/surfaces/point-of-sale/api/session-api/session-api.ts +5 -0
  1100. package/src/surfaces/point-of-sale/api/standard/standard-api.ts +3 -0
  1101. package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +1 -0
  1102. package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +5 -0
  1103. package/src/surfaces/point-of-sale/components/Badge.d.ts +5 -0
  1104. package/src/surfaces/point-of-sale/components/Banner.d.ts +6 -0
  1105. package/src/surfaces/point-of-sale/components/Box.d.ts +6 -0
  1106. package/src/surfaces/point-of-sale/components/Button.d.ts +6 -0
  1107. package/src/surfaces/point-of-sale/components/Choice.d.ts +5 -0
  1108. package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +6 -0
  1109. package/src/surfaces/point-of-sale/components/Clickable.d.ts +6 -0
  1110. package/src/surfaces/point-of-sale/components/DateField.d.ts +7 -0
  1111. package/src/surfaces/point-of-sale/components/DatePicker.d.ts +6 -0
  1112. package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +6 -0
  1113. package/src/surfaces/point-of-sale/components/Divider.d.ts +5 -0
  1114. package/src/surfaces/point-of-sale/components/EmailField.d.ts +8 -0
  1115. package/src/surfaces/point-of-sale/components/Embed.d.ts +6 -0
  1116. package/src/surfaces/point-of-sale/components/EmptyState.d.ts +7 -0
  1117. package/src/surfaces/point-of-sale/components/Heading.d.ts +5 -0
  1118. package/src/surfaces/point-of-sale/components/Icon.d.ts +6 -0
  1119. package/src/surfaces/point-of-sale/components/Image.d.ts +5 -0
  1120. package/src/surfaces/point-of-sale/components/Link.d.ts +7 -0
  1121. package/src/surfaces/point-of-sale/components/Modal.d.ts +7 -0
  1122. package/src/surfaces/point-of-sale/components/NumberField.d.ts +7 -0
  1123. package/src/surfaces/point-of-sale/components/Page.d.ts +6 -0
  1124. package/src/surfaces/point-of-sale/components/PosBlock.d.ts +6 -0
  1125. package/src/surfaces/point-of-sale/components/QrCode.d.ts +5 -0
  1126. package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +6 -0
  1127. package/src/surfaces/point-of-sale/components/SearchField.d.ts +6 -0
  1128. package/src/surfaces/point-of-sale/components/Section.d.ts +6 -0
  1129. package/src/surfaces/point-of-sale/components/Spinner.d.ts +6 -0
  1130. package/src/surfaces/point-of-sale/components/Stack.d.ts +7 -0
  1131. package/src/surfaces/point-of-sale/components/Switch.d.ts +7 -0
  1132. package/src/surfaces/point-of-sale/components/Tab.d.ts +6 -0
  1133. package/src/surfaces/point-of-sale/components/TabList.d.ts +6 -0
  1134. package/src/surfaces/point-of-sale/components/TabPanel.d.ts +6 -0
  1135. package/src/surfaces/point-of-sale/components/Tabs.d.ts +7 -0
  1136. package/src/surfaces/point-of-sale/components/Text.d.ts +5 -0
  1137. package/src/surfaces/point-of-sale/components/TextArea.d.ts +8 -0
  1138. package/src/surfaces/point-of-sale/components/TextField.d.ts +7 -0
  1139. package/src/surfaces/point-of-sale/components/Tile.d.ts +6 -0
  1140. package/src/surfaces/point-of-sale/components/TimeField.d.ts +6 -0
  1141. package/src/surfaces/point-of-sale/components/TimePicker.d.ts +6 -0
  1142. package/src/surfaces/point-of-sale/components/components-shared.d.ts +135 -0
  1143. package/src/surfaces/point-of-sale/components/targets/ActionExtensionComponents.ts +3 -0
  1144. package/src/surfaces/point-of-sale/components/targets/BasicComponents.ts +3 -0
  1145. package/src/surfaces/point-of-sale/components/targets/BlockExtensionComponents.ts +3 -0
  1146. package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +3 -0
  1147. package/src/surfaces/point-of-sale/components/targets/SmartGridComponents.ts +3 -0
  1148. package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +3 -0
  1149. package/src/surfaces/point-of-sale/components.d.ts +286 -0
  1150. package/src/surfaces/point-of-sale/event/data/BaseApi.ts +1 -0
  1151. package/src/surfaces/point-of-sale/event/data/BaseData.ts +7 -2
  1152. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +1 -0
  1153. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +2 -0
  1154. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +1 -0
  1155. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +24 -2
  1156. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +1 -0
  1157. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +1 -0
  1158. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +2 -0
  1159. package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +1 -0
  1160. package/src/surfaces/point-of-sale/extension-targets.ts +18 -0
  1161. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +1 -0
  1162. package/src/surfaces/point-of-sale/types/cart.ts +13 -0
  1163. package/src/surfaces/point-of-sale/types/country-code.ts +1 -0
  1164. package/src/surfaces/point-of-sale/types/device.ts +1 -0
  1165. package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +1 -0
  1166. package/src/surfaces/point-of-sale/types/discount-allocation.ts +1 -0
  1167. package/src/surfaces/point-of-sale/types/money.ts +2 -0
  1168. package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -0
  1169. package/src/surfaces/point-of-sale/types/order.ts +2 -0
  1170. package/src/surfaces/point-of-sale/types/paginated-result.ts +1 -0
  1171. package/src/surfaces/point-of-sale/types/payment.ts +2 -0
  1172. package/src/surfaces/point-of-sale/types/pin-pad.ts +5 -0
  1173. package/src/surfaces/point-of-sale/types/product.ts +5 -0
  1174. package/src/surfaces/point-of-sale/types/session.ts +1 -0
  1175. package/src/surfaces/point-of-sale/types/shipping-line.ts +3 -0
  1176. package/src/surfaces/point-of-sale/types/storage.ts +4 -0
  1177. package/src/surfaces/point-of-sale/types/tax-line.ts +1 -0
  1178. package/src/surfaces/point-of-sale/types/transaction-type.ts +1 -0
@@ -14,7 +14,7 @@ export type ComponentChildren = any;
14
14
  export type StringChildren = string;
15
15
  export interface GlobalProps {
16
16
  /**
17
- * A unique identifier for the element.
17
+ * A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.
18
18
  */
19
19
  id?: string;
20
20
  }
@@ -46,19 +46,19 @@ export interface ActionSlots {
46
46
  }
47
47
  export interface BaseOverlayProps {
48
48
  /**
49
- * Callback fired after the overlay is shown.
49
+ * A callback fired immediately after the overlay is shown.
50
50
  */
51
51
  onShow?: (event: Event) => void;
52
52
  /**
53
- * Callback fired when the overlay is shown **after** any animations to show the overlay have finished.
53
+ * A callback fired when the overlay is shown, after any show animations have completed.
54
54
  */
55
55
  onAfterShow?: (event: Event) => void;
56
56
  /**
57
- * Callback fired after the overlay is hidden.
57
+ * A callback fired immediately after the overlay is hidden.
58
58
  */
59
59
  onHide?: (event: Event) => void;
60
60
  /**
61
- * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished.
61
+ * A callback fired when the overlay is hidden, after any hide animations have completed.
62
62
  */
63
63
  onAfterHide?: (event: Event) => void;
64
64
  }
@@ -72,19 +72,19 @@ export interface BaseOverlayProps {
72
72
  */
73
73
  export interface BaseOverlayMethods {
74
74
  /**
75
- * Method to show an overlay.
75
+ * A method to programmatically show the overlay.
76
76
  *
77
77
  * @implementation This is a method to be called on the element and not a callback and should hence be camelCase
78
78
  */
79
79
  showOverlay: () => void;
80
80
  /**
81
- * Method to hide an overlay.
81
+ * A method to programmatically hide the overlay and run any associated hide animations.
82
82
  *
83
83
  * @implementation This is a method to be called on the element and not a callback and should hence be camelCase
84
84
  */
85
85
  hideOverlay: () => void;
86
86
  /**
87
- * Method to toggle the visiblity of an overlay.
87
+ * A method to programmatically toggle the visibility of the overlay.
88
88
  *
89
89
  * @implementation This is a method to be called on the element and not a callback and should hence be camelCase
90
90
  */
@@ -92,48 +92,56 @@ export interface BaseOverlayMethods {
92
92
  }
93
93
  export interface FocusEventProps {
94
94
  /**
95
- * Callback when the element loses focus.
96
- *
97
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event
95
+ * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).
98
96
  */
99
97
  onBlur?: (event: FocusEvent) => void;
100
98
  /**
101
- * Callback when the element receives focus.
102
- *
103
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event
99
+ * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).
104
100
  */
105
101
  onFocus?: (event: FocusEvent) => void;
106
102
  }
107
103
  export interface ToggleEventProps {
108
104
  /**
109
- * Callback fired when the element state changes **after** any animations have finished.
105
+ * A callback that fires when the element state changes, after any toggle animations have finished.
110
106
  *
111
107
  * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the
112
108
  * `newState` property will be set to `open`.
113
109
  * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the
114
110
  * `newState` will be `closed`.
115
111
  *
116
- * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState
117
- * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
112
+ * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).
118
113
  */
119
114
  onAfterToggle?: (event: ToggleEvent$1) => void;
120
115
  /**
121
- * Callback straight after the element state changes.
116
+ * A callback that fires immediately when the element state changes, before any animations.
122
117
  *
123
118
  * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the
124
119
  * `newState` property will be set to `open`.
125
120
  * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the
126
121
  * `newState` will be `closed`.
127
122
  *
128
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event
129
- * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState
130
- * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
123
+ * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).
131
124
  */
132
125
  onToggle?: (event: ToggleEvent$1) => void;
133
126
  }
127
+ /**
128
+ * The visibility state of a toggleable element.
129
+ *
130
+ * - `open`: The element is visible and showing its content.
131
+ * - `closed`: The element is hidden and its content is not visible.
132
+ */
134
133
  export type ToggleState = "open" | "closed";
134
+ /**
135
+ * The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element.
136
+ */
135
137
  interface ToggleEvent$1 extends Event {
138
+ /**
139
+ * The visibility state of the element after the toggle occurred.
140
+ */
136
141
  readonly newState: ToggleState;
142
+ /**
143
+ * The visibility state of the element before the toggle occurred.
144
+ */
137
145
  readonly oldState: ToggleState;
138
146
  }
139
147
  export interface ExtendableEvent extends Event {
@@ -153,8 +161,7 @@ interface AnnouncementProps$1 extends GlobalProps, ToggleEventProps {
153
161
  */
154
162
  children?: ComponentChildren;
155
163
  /**
156
- * Callback fired when the announcement is dismissed by the user
157
- * (either via the built-in dismiss button or programmatically).
164
+ * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.
158
165
  */
159
166
  onDismiss?: (event: Event) => void;
160
167
  /**
@@ -162,12 +169,32 @@ interface AnnouncementProps$1 extends GlobalProps, ToggleEventProps {
162
169
  */
163
170
  dismiss: () => void;
164
171
  }
172
+ /**
173
+ * The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `"small-500"` (smallest) through `"base"` (standard) to `"large-500"` (largest). Not all components support every size — check the component's `size` property type for its available options.
174
+ */
165
175
  export type SizeKeyword = "small-500" | "small-400" | "small-300" | "small-200" | "small-100" | "small" | "base" | "large" | "large-100" | "large-200" | "large-300" | "large-400" | "large-500";
176
+ /**
177
+ * Defines the color intensity or emphasis level for text and UI elements.
178
+ *
179
+ * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
180
+ * - `base`: Primary color for body text, standard UI elements, and general content with good readability.
181
+ * - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
182
+ */
166
183
  export type ColorKeyword = "subdued" | "base" | "strong";
167
184
  export type BackgroundColorKeyword = "transparent" | ColorKeyword;
168
185
  export interface BackgroundProps {
169
186
  /**
170
- * Adjust the background of the element.
187
+ * The background color of the element.
188
+ *
189
+ * - `base`: The standard background color for general content areas.
190
+ * - `subdued`: A muted background for secondary or supporting content.
191
+ * - `transparent`: No background color (the default).
192
+ * - `strong`: An emphasized background for prominent sections.
193
+ *
194
+ * - `'transparent'`: No visible background.
195
+ * - `'subdued'`: A subtle, low-emphasis background.
196
+ * - `'base'`: The standard background color.
197
+ * - `'strong'`: A high-emphasis background for prominence.
171
198
  *
172
199
  * @default 'transparent'
173
200
  */
@@ -738,8 +765,28 @@ export type IconType = (typeof privateIconArray)[number];
738
765
  * Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.
739
766
  */
740
767
  export type ExtractStrict<T, U extends T> = Extract<T, U>;
768
+ /**
769
+ * Represents CSS shorthand properties that accept one to four values, following the [CSS shorthand syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box). Supports specifying values for all four sides: top, right, bottom, and left.
770
+ *
771
+ * - `T`: Single value that applies to all four sides.
772
+ * - `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).
773
+ * - `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).
774
+ * - `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left).
775
+ */
741
776
  export type MaybeAllValuesShorthandProperty<T extends string> = T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`;
777
+ /**
778
+ * Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values.
779
+ *
780
+ * - `T`: Single value that applies to both dimensions.
781
+ * - `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal).
782
+ */
742
783
  export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
784
+ /**
785
+ * Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string.
786
+ *
787
+ * - `T`: Base value that applies in all conditions.
788
+ * - `@container${string}`: Container query string for conditional responsive styling based on container size.
789
+ */
743
790
  export type MaybeResponsive<T> = T | `@container${string}`;
744
791
  /**
745
792
  * Prevents widening string literal types in a union to `string`.
@@ -763,29 +810,32 @@ interface BadgeProps$1 extends GlobalProps {
763
810
  */
764
811
  children?: ComponentChildren;
765
812
  /**
766
- * Sets the tone of the Badge, based on the intention of the information being conveyed.
813
+ * The semantic meaning and color treatment of the badge.
767
814
  *
768
815
  * @default 'auto'
769
816
  */
770
817
  tone?: ToneKeyword;
771
818
  /**
772
- * Modify the color to be more or less intense.
819
+ * Controls the visual weight and emphasis of the badge.
773
820
  *
774
821
  * @default 'base'
775
822
  */
776
823
  color?: ColorKeyword;
777
824
  /**
778
- * The type of icon to be displayed in the badge.
825
+ * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.
779
826
  *
780
827
  * @default ''
781
828
  */
782
829
  icon?: IconType | AnyString;
783
830
  /**
784
- * The position of the icon in relation to the text.
831
+ * The position of the icon relative to the badge text.
832
+ *
833
+ * - `start`: Places the icon before the text.
834
+ * - `end`: Places the icon after the text.
785
835
  */
786
836
  iconPosition?: "start" | "end";
787
837
  /**
788
- * Adjusts the size.
838
+ * The size of the badge.
789
839
  *
790
840
  * @default 'base'
791
841
  */
@@ -793,42 +843,34 @@ interface BadgeProps$1 extends GlobalProps {
793
843
  }
794
844
  interface BannerProps$1 extends GlobalProps, ActionSlots {
795
845
  /**
796
- * The title of the banner.
846
+ * The heading text displayed at the top of the banner to summarize the message or alert.
797
847
  *
798
848
  * @default ''
799
849
  */
800
850
  heading?: string;
801
851
  /**
802
- * The content of the Banner.
852
+ * The main content displayed within the banner component, typically descriptive text or other elements providing details about the message or alert.
803
853
  */
804
854
  children?: ComponentChildren;
805
855
  /**
806
- * Sets the tone of the Banner, based on the intention of the information being conveyed.
856
+ * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.
807
857
  *
808
- * The banner is a live region and the type of status will be dictated by the Tone selected.
809
- *
810
- * - `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.
811
- * - `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.
812
- *
813
- * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions
814
- * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role
815
- * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role
858
+ * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `neutral`, `info`, `success`, `warning`, and `caution` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.
816
859
  *
817
860
  * @default 'auto'
818
861
  */
819
862
  tone?: ToneKeyword;
820
863
  /**
821
- * Makes the content collapsible.
822
- * A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.
864
+ * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.
823
865
  *
824
866
  * @default false
825
867
  */
826
868
  collapsible?: boolean;
827
869
  /**
828
- * Determines whether the close button of the banner is present.
870
+ * Whether the banner displays a close button that allows users to dismiss it.
829
871
  *
830
872
  * When the close button is pressed, the `dismiss` event will fire,
831
- * then `hidden` will be true,
873
+ * then `hidden` will be set to `true`,
832
874
  * any animation will complete,
833
875
  * and the `afterhide` event will fire.
834
876
  *
@@ -836,31 +878,26 @@ interface BannerProps$1 extends GlobalProps, ActionSlots {
836
878
  */
837
879
  dismissible?: boolean;
838
880
  /**
839
- * Event handler when the banner is dismissed by the user.
881
+ * A callback that fires when the banner is dismissed by the user clicking the close button.
840
882
  *
841
- * This does not fire when setting `hidden` manually.
883
+ * This doesn't fire when setting `hidden` manually.
842
884
  *
843
- * The `hidden` property will be `false` when this event fires.
885
+ * The `hidden` property is `false` when this event fires.
844
886
  */
845
887
  onDismiss?: (event: Event) => void;
846
888
  /**
847
- * Event handler when the banner has fully hidden.
848
- *
849
- * The `hidden` property will be `true` when this event fires.
889
+ * A callback that fires when the banner has fully hidden, including after any hide animations have completed.
850
890
  *
851
- * @implementation If implementations animate the hiding of the banner,
852
- * this event must fire after the banner has fully hidden.
853
- * We can add an `onHide` event in future if we want to provide a hook for the start of the animation.
891
+ * The `hidden` property is `true` when this event fires.
854
892
  */
855
893
  onAfterHide?: (event: Event) => void;
856
894
  /**
857
- * Determines whether the banner is hidden.
895
+ * Controls whether the banner is visible or hidden.
858
896
  *
859
- * If this property is being set on each framework render (as in 'controlled' usage),
860
- * and the banner is `dismissible`,
861
- * ensure you update app state for this property when the `dismiss` event fires.
897
+ * When using a controlled component pattern and the banner is `dismissible`,
898
+ * update this property to `true` when the `dismiss` event fires.
862
899
  *
863
- * If the banner is not `dismissible`, it can still be hidden by setting this property.
900
+ * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.
864
901
  *
865
902
  * @default false
866
903
  */
@@ -880,17 +917,32 @@ export interface DisplayProps {
880
917
  }
881
918
  export interface AccessibilityRoleProps {
882
919
  /**
883
- * Sets the semantic meaning of the components content. When set,
884
- * the role will be used by assistive technologies to help users
885
- * navigate the page.
886
- *
887
- * @implementation Although, in HTML hosts, this property changes the element used,
888
- * changing this property must not impact the visual styling of inside or outside of the box.
920
+ * The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.
889
921
  *
890
922
  * @default 'generic'
891
923
  */
892
924
  accessibilityRole?: AccessibilityRole;
893
925
  }
926
+ /**
927
+ * The semantic role of a component, used by assistive technologies to convey the element's purpose to users. Each role maps to a specific HTML element or ARIA role.
928
+ *
929
+ * - `main`: The primary content of the page.
930
+ * - `header`: A page or section header.
931
+ * - `footer`: Information such as copyright, navigation links, and privacy statements.
932
+ * - `section`: A generic section that should have a heading or `accessibilityLabel`.
933
+ * - `aside`: Supporting content related to the main content.
934
+ * - `navigation`: A major group of navigation links.
935
+ * - `ordered-list`: A list of ordered items.
936
+ * - `list-item`: An item inside a list.
937
+ * - `list-item-separator`: A divider between list items.
938
+ * - `unordered-list`: A list of unordered items.
939
+ * - `separator`: A divider that separates sections of content.
940
+ * - `status`: A live region with advisory information that is not urgent.
941
+ * - `alert`: Important, usually time-sensitive information.
942
+ * - `generic`: A nameless container with no semantic meaning (renders a `<div>`).
943
+ * - `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.
944
+ * - `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.
945
+ */
894
946
  export type AccessibilityRole =
895
947
  /**
896
948
  * Used to indicate the primary content.
@@ -1020,162 +1072,198 @@ export interface AccessibilityVisibilityProps {
1020
1072
  }
1021
1073
  export interface LabelAccessibilityVisibilityProps {
1022
1074
  /**
1023
- * Changes the visibility of the component's label.
1075
+ * Controls whether the label is visible to all users or only to screen readers.
1024
1076
  *
1025
- * - `visible`: the label is visible to all users.
1026
- * - `exclusive`: the label is visually hidden but remains in the accessibility tree.
1077
+ * - `visible`: The label is shown to everyone.
1078
+ * - `exclusive`: The label is visually hidden but still announced by screen readers.
1027
1079
  *
1028
1080
  * @default 'visible'
1029
1081
  */
1030
1082
  labelAccessibilityVisibility?: ExtractStrict<AccessibilityVisibilityProps["accessibilityVisibility"], "visible" | "exclusive">;
1031
1083
  }
1084
+ /**
1085
+ * Defines the padding size for elements, using the standard size scale or `none` for no padding.
1086
+ *
1087
+ * - `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.
1088
+ * - `none`: No padding.
1089
+ */
1032
1090
  export type PaddingKeyword = SizeKeyword | "none";
1033
1091
  export interface PaddingProps {
1034
1092
  /**
1035
- * Adjust the padding of all edges.
1093
+ * The padding applied to all edges of the component.
1036
1094
  *
1037
- * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
1038
- * supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
1095
+ * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:
1096
+ * - 1 value applies to all sides
1097
+ * - 2 values apply to block (top/bottom) and inline (left/right)
1098
+ * - 3 values apply to block-start (top), inline (left/right), and block-end (bottom)
1099
+ * - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)
1039
1100
  *
1040
- * - 4 values: `block-start inline-end block-end inline-start`
1041
- * - 3 values: `block-start inline block-end`
1042
- * - 2 values: `block inline`
1101
+ * **Examples:** `base`, `large none`, `base large-100 base small`
1043
1102
  *
1044
- * For example:
1045
- * - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
1046
- * - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
1047
- * - `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.
1048
- * - `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.
1049
- *
1050
- * A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
1103
+ * Use `auto` to inherit padding from the nearest container with removed padding.
1051
1104
  *
1052
1105
  * @default 'none'
1053
1106
  */
1054
1107
  padding?: MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>;
1055
1108
  /**
1056
- * Adjust the block-padding.
1109
+ * The block-direction padding (top and bottom in horizontal writing modes).
1110
+ *
1111
+ * Accepts a single value for both sides or two space-separated values for block-start and block-end.
1057
1112
  *
1058
- * - `large none` means block-start padding is `large`, block-end padding is `none`.
1113
+ * **Example:** `large none` applies `large` to the top and `none` to the bottom.
1059
1114
  *
1060
- * This overrides the block value of `padding`.
1115
+ * Overrides the block value from `padding`.
1061
1116
  *
1062
1117
  * @default '' - meaning no override
1063
1118
  */
1064
1119
  paddingBlock?: MaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">;
1065
1120
  /**
1066
- * Adjust the block-start padding.
1121
+ * The block-start padding (top in horizontal writing modes).
1067
1122
  *
1068
- * This overrides the block-start value of `paddingBlock`.
1123
+ * Overrides the block-start value from `paddingBlock`.
1069
1124
  *
1070
1125
  * @default '' - meaning no override
1071
1126
  */
1072
1127
  paddingBlockStart?: MaybeResponsive<PaddingKeyword | "">;
1073
1128
  /**
1074
- * Adjust the block-end padding.
1129
+ * The block-end padding (bottom in horizontal writing modes).
1075
1130
  *
1076
- * This overrides the block-end value of `paddingBlock`.
1131
+ * Overrides the block-end value from `paddingBlock`.
1077
1132
  *
1078
1133
  * @default '' - meaning no override
1079
1134
  */
1080
1135
  paddingBlockEnd?: MaybeResponsive<PaddingKeyword | "">;
1081
1136
  /**
1082
- * Adjust the inline padding.
1137
+ * The inline-direction padding (left and right in horizontal writing modes).
1083
1138
  *
1084
- * - `large none` means inline-start padding is `large`, inline-end padding is `none`.
1139
+ * Accepts a single value for both sides or two space-separated values for inline-start and inline-end.
1085
1140
  *
1086
- * This overrides the inline value of `padding`.
1141
+ * **Example:** `large none` applies `large` to the left and `none` to the right.
1142
+ *
1143
+ * Overrides the inline value from `padding`.
1087
1144
  *
1088
1145
  * @default '' - meaning no override
1089
1146
  */
1090
1147
  paddingInline?: MaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">;
1091
1148
  /**
1092
- * Adjust the inline-start padding.
1149
+ * The inline-start padding (left in LTR writing modes, right in RTL).
1093
1150
  *
1094
- * This overrides the inline-start value of `paddingInline`.
1151
+ * Overrides the inline-start value from `paddingInline`.
1095
1152
  *
1096
1153
  * @default '' - meaning no override
1097
1154
  */
1098
1155
  paddingInlineStart?: MaybeResponsive<PaddingKeyword | "">;
1099
1156
  /**
1100
- * Adjust the inline-end padding.
1157
+ * The inline-end padding (right in LTR writing modes, left in RTL).
1101
1158
  *
1102
- * This overrides the inline-end value of `paddingInline`.
1159
+ * Overrides the inline-end value from `paddingInline`.
1103
1160
  *
1104
1161
  * @default '' - meaning no override
1105
1162
  */
1106
1163
  paddingInlineEnd?: MaybeResponsive<PaddingKeyword | "">;
1107
1164
  }
1165
+ /**
1166
+ * Represents size values in pixels, percentages, or zero.
1167
+ *
1168
+ * - `` `${number}px` ``: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).
1169
+ * - `` `${number}%` ``: Relative size as a percentage of the parent container (such as `50%`, `100%`).
1170
+ * - `0`: Zero size, equivalent to no dimension.
1171
+ */
1108
1172
  export type SizeUnits = `${number}px` | `${number}%` | `0`;
1173
+ /**
1174
+ * Represents size values that can also be set to `auto` for automatic sizing.
1175
+ *
1176
+ * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
1177
+ * - `auto`: Automatically sizes based on content and layout constraints. Learn more about the [auto value](https://developer.mozilla.org/en-US/docs/Web/CSS/width#auto).
1178
+ */
1109
1179
  export type SizeUnitsOrAuto = SizeUnits | "auto";
1180
+ /**
1181
+ * Represents size values that can also be set to `none` to remove the size constraint.
1182
+ *
1183
+ * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
1184
+ * - `none`: No size constraint, allowing unlimited growth. Learn more about the [none value](https://developer.mozilla.org/en-US/docs/Web/CSS/max-width#none).
1185
+ */
1110
1186
  export type SizeUnitsOrNone = SizeUnits | "none";
1111
1187
  export interface SizingProps {
1112
1188
  /**
1113
- * Adjust the block size.
1189
+ * The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
1114
1190
  *
1115
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size
1191
+ * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
1192
+ * - `auto`: Automatically sizes based on content and layout constraints.
1116
1193
  *
1117
1194
  * @default 'auto'
1118
1195
  */
1119
1196
  blockSize?: MaybeResponsive<SizeUnitsOrAuto>;
1120
1197
  /**
1121
- * Adjust the minimum block size.
1122
- *
1123
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size
1198
+ * The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
1124
1199
  *
1125
1200
  * @default '0'
1126
1201
  */
1127
1202
  minBlockSize?: MaybeResponsive<SizeUnits>;
1128
1203
  /**
1129
- * Adjust the maximum block size.
1130
- *
1131
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size
1204
+ * The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
1132
1205
  *
1133
1206
  * @default 'none'
1134
1207
  */
1135
1208
  maxBlockSize?: MaybeResponsive<SizeUnitsOrNone>;
1136
1209
  /**
1137
- * Adjust the inline size.
1210
+ * The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).
1138
1211
  *
1139
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size
1212
+ * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
1213
+ * - `auto`: Automatically sizes based on content and layout constraints.
1140
1214
  *
1141
1215
  * @default 'auto'
1142
1216
  */
1143
1217
  inlineSize?: MaybeResponsive<SizeUnitsOrAuto>;
1144
1218
  /**
1145
- * Adjust the minimum inline size.
1146
- *
1147
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size
1219
+ * The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
1148
1220
  *
1149
1221
  * @default '0'
1150
1222
  */
1151
1223
  minInlineSize?: MaybeResponsive<SizeUnits>;
1152
1224
  /**
1153
- * Adjust the maximum inline size.
1154
- *
1155
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size
1225
+ * The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
1156
1226
  *
1157
1227
  * @default 'none'
1158
1228
  */
1159
1229
  maxInlineSize?: MaybeResponsive<SizeUnitsOrNone>;
1160
1230
  }
1231
+ /**
1232
+ * The visual style of a border. Learn more about [border-style](https://developer.mozilla.org/en-US/docs/Web/CSS/border-style).
1233
+ *
1234
+ * - `"none"`: No border is rendered.
1235
+ * - `"solid"`: A single continuous line.
1236
+ * - `"dashed"`: A series of short dashes.
1237
+ * - `"dotted"`: A series of round dots.
1238
+ * - `"auto"`: The border style is determined automatically based on the surface's design system.
1239
+ */
1161
1240
  export type BorderStyleKeyword = "none" | "solid" | "dashed" | "dotted" | "auto";
1241
+ /**
1242
+ * Defines the width of borders, using the standard size scale or `none` for no border.
1243
+ *
1244
+ * - `SizeKeyword`: Standard border widths from the size scale for consistent thickness.
1245
+ * - `none`: No border width (removes the border).
1246
+ */
1162
1247
  export type BorderSizeKeyword = SizeKeyword | "none";
1248
+ /**
1249
+ * The corner radius of a border, using the design system's `SizeKeyword` scale with additional options:
1250
+ *
1251
+ * - `"max"`: The maximum possible radius, creating a pill or circular shape.
1252
+ * - `"none"`: No rounding — corners are sharp (0 radius).
1253
+ */
1163
1254
  export type BorderRadiusKeyword = SizeKeyword | "max" | "none";
1164
1255
  /**
1165
- * Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.
1256
+ * A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base strong'`), or size with color and style (`'base strong dashed'`). Omitted values use their defaults.
1166
1257
  */
1167
1258
  export type BorderShorthand = BorderSizeKeyword | `${BorderSizeKeyword} ${ColorKeyword}` | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`;
1168
1259
  export interface BorderProps {
1169
1260
  /**
1170
- * Set the border via the shorthand property.
1261
+ * Applies a border using shorthand syntax to specify width, color, and style in a single property.
1171
1262
  *
1172
- * This can be a size, optionally followed by a color, optionally followed by a style.
1263
+ * Accepts a size value, optionally followed by a color, optionally followed by a style.
1264
+ * Omitted values use defaults: color defaults to `base`, style defaults to `auto`.
1173
1265
  *
1174
- * If the color is not specified, it will be `base`.
1175
- *
1176
- * If the style is not specified, it will be `auto`.
1177
- *
1178
- * Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.
1266
+ * Individual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.
1179
1267
  *
1180
1268
  * @example
1181
1269
  * // The following are equivalent:
@@ -1186,64 +1274,54 @@ export interface BorderProps {
1186
1274
  */
1187
1275
  border?: BorderShorthand;
1188
1276
  /**
1189
- * Set the width of the border.
1190
- *
1191
- * If set, it takes precedence over the `border` property's width.
1192
- *
1193
- * Like CSS, up to 4 values can be specified.
1277
+ * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
1194
1278
  *
1195
- * If one value is specified, it applies to all sides.
1196
- *
1197
- * If two values are specified, they apply to the block sides and inline sides respectively.
1198
- *
1199
- * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
1200
- *
1201
- * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
1279
+ * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:
1280
+ * - One value: applies to all sides
1281
+ * - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively
1282
+ * - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively
1283
+ * - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively
1202
1284
  *
1203
1285
  * @default '' - meaning no override
1204
1286
  */
1205
1287
  borderWidth?: MaybeAllValuesShorthandProperty<BorderSizeKeyword> | "";
1206
1288
  /**
1207
- * Set the style of the border.
1208
- *
1209
- * If set, it takes precedence over the `border` property's style.
1289
+ * Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
1210
1290
  *
1211
- * Like CSS, up to 4 values can be specified.
1291
+ * When set, this overrides the style value specified in the `border` property.
1212
1292
  *
1213
- * If one value is specified, it applies to all sides.
1214
- *
1215
- * If two values are specified, they apply to the block sides and inline sides respectively.
1216
- *
1217
- * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
1218
- *
1219
- * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
1293
+ * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:
1294
+ * - One value: applies to all sides
1295
+ * - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively
1296
+ * - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively
1297
+ * - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively
1220
1298
  *
1221
1299
  * @default '' - meaning no override
1222
1300
  */
1223
1301
  borderStyle?: MaybeAllValuesShorthandProperty<BorderStyleKeyword> | "";
1224
1302
  /**
1225
- * Set the color of the border.
1303
+ * Controls the color of the border using the design system's color scale.
1226
1304
  *
1227
- * If set, it takes precedence over the `border` property's color.
1305
+ * When set, this overrides the color value specified in the `border` property.
1306
+ * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.
1228
1307
  *
1229
1308
  * @default '' - meaning no override
1230
1309
  */
1231
1310
  borderColor?: ColorKeyword | "";
1232
1311
  /**
1233
- * Set the radius of the border.
1234
- *
1235
- * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
1236
- * supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
1312
+ * Controls the roundedness of the element's corners using the design system's radius scale.
1237
1313
  *
1238
- * - 4 values: `start-start start-end end-end end-start`
1239
- * - 3 values: `start-start (start-end & end-start) start-end`
1240
- * - 2 values: `(start-start & end-end) (start-end & end-start)`
1314
+ * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:
1315
+ * - One value: applies to all corners
1316
+ * - Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively
1317
+ * - Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively
1318
+ * - Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively
1241
1319
  *
1242
- * For example:
1243
- * - `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.
1244
- * - `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.
1245
- * - `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.
1246
- * - `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.
1320
+ * Examples:
1321
+ * - `small-100`: All corners have `small-100` radius
1322
+ * - `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`
1323
+ * - `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`
1324
+ * - `small-100 none large-100 base`: Each corner has its specified radius value
1247
1325
  *
1248
1326
  * @defaultValue 'none'
1249
1327
  */
@@ -1251,12 +1329,10 @@ export interface BorderProps {
1251
1329
  }
1252
1330
  export interface OverflowProps {
1253
1331
  /**
1254
- * Sets the overflow behavior of the element.
1332
+ * The overflow behavior of the element.
1255
1333
  *
1256
- * - `hidden`: clips the content when it is larger than the element’s container.
1257
- * The element will not be scrollable and the users will not be able
1258
- * to access the clipped content by dragging or using a scroll wheel on a mouse.
1259
- * - `visible`: the content that extends beyond the element’s container is visible.
1334
+ * - `visible`: Content that extends beyond the container is visible.
1335
+ * - `hidden`: Content that extends beyond the container is clipped and not scrollable.
1260
1336
  *
1261
1337
  * @default 'visible'
1262
1338
  */
@@ -1264,14 +1340,11 @@ export interface OverflowProps {
1264
1340
  }
1265
1341
  export interface BaseBoxProps extends AccessibilityVisibilityProps, BackgroundProps, DisplayProps, SizingProps, PaddingProps, BorderProps, OverflowProps {
1266
1342
  /**
1267
- * The content of the Box.
1343
+ * The child elements to render inside the container.
1268
1344
  */
1269
1345
  children?: ComponentChildren;
1270
1346
  /**
1271
- * A label that describes the purpose or contents of the element.
1272
- * When set, it will be announced to users using assistive technologies and will provide them with more context.
1273
- *
1274
- * Only use this when the element's content is not enough context for users using assistive technologies.
1347
+ * A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.
1275
1348
  */
1276
1349
  accessibilityLabel?: string;
1277
1350
  }
@@ -1281,34 +1354,28 @@ interface BoxProps$1 extends BaseBoxPropsWithRole, GlobalProps {
1281
1354
  }
1282
1355
  export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
1283
1356
  /**
1284
- * The behavior of the Button.
1285
- *
1286
- * - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.
1287
- * - `button`: Used to indicate the component acts as a button, meaning it has no default action.
1288
- * - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).
1357
+ * The behavioral type of the button component, which determines what action it performs when activated.
1358
+ * - `'submit'`: Submits the nearest containing form.
1359
+ * - `'button'`: Performs no default action, relying on the `click` event handler for behavior.
1360
+ * - `'reset'`: Resets all fields in the nearest containing form to their default values.
1289
1361
  *
1290
- * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.
1362
+ * This property is ignored if `href` or `commandFor`/`command` is set.
1291
1363
  *
1292
1364
  * @default 'button'
1293
1365
  */
1294
1366
  type?: "submit" | "button" | "reset";
1295
1367
  /**
1296
- * Callback when the Button is activated.
1297
- * This will be called before the action indicated by `type`.
1298
- *
1299
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
1368
+ * A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
1300
1369
  */
1301
1370
  onClick?: (event: Event) => void;
1302
1371
  /**
1303
- * Disables the Button meaning it cannot be clicked or receive focus.
1372
+ * Whether the button is disabled, preventing it from being clicked or receiving focus.
1304
1373
  *
1305
1374
  * @default false
1306
1375
  */
1307
1376
  disabled?: boolean;
1308
1377
  /**
1309
- * Replaces content with a loading indicator while a background action is being performed.
1310
- *
1311
- * This also disables the Button.
1378
+ * Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.
1312
1379
  *
1313
1380
  * @default false
1314
1381
  */
@@ -1316,18 +1383,14 @@ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
1316
1383
  }
1317
1384
  export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
1318
1385
  /**
1319
- * The URL to link to.
1320
- *
1321
- * - If set, it will navigate to the location specified by `href` after executing the `click` event.
1322
- * - If a `commandFor` is set, the `command` will be executed instead of the navigation.
1386
+ * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.
1323
1387
  */
1324
1388
  href?: string;
1325
1389
  /**
1326
- * Specifies where to display the linked URL.
1327
- *
1328
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target
1390
+ * Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).
1329
1391
  *
1330
- * 'auto': The target is automatically determined based on the origin of the URL.
1392
+ * - `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.
1393
+ * - `'_blank'`: Opens the URL in a new tab or window.
1331
1394
  *
1332
1395
  * @implementation Surfaces can set specific rules on how they handle each URL.
1333
1396
  * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.
@@ -1337,46 +1400,35 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
1337
1400
  */
1338
1401
  target?: "auto" | "_blank" | "_self" | "_parent" | "_top" | AnyString;
1339
1402
  /**
1340
- * Causes the browser to treat the linked URL as a download with the string being the file name.
1341
- * Download only works for same-origin URLs or the `blob:` and `data:` schemes.
1342
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download
1403
+ * A filename that causes the browser to treat the linked URL as a download. Download is only supported for same-origin URLs, or `blob:` and `data:` schemes. Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).
1343
1404
  */
1344
1405
  download?: string;
1345
1406
  /**
1346
- * Callback when the link is activated.
1347
- * This will be called before navigating to the location specified by `href`.
1348
- *
1349
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
1407
+ * A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
1350
1408
  */
1351
1409
  onClick?: (event: Event) => void;
1352
1410
  }
1353
1411
  export interface InteractionProps {
1354
1412
  /**
1355
- * ID of a component that should respond to activations (e.g. clicks) on this component.
1356
- *
1357
- * See `command` for how to control the behavior of the target.
1358
- *
1359
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor
1413
+ * 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).
1360
1414
  */
1361
1415
  commandFor?: string;
1362
1416
  /**
1363
- * Sets the action the `commandFor` should take when this clickable is activated.
1417
+ * Sets the action the [`command`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated. Available options:
1364
1418
  *
1365
- * See the documentation of particular components for the actions they support.
1419
+ * - `'--auto'`: Performs the default action appropriate for the target component.
1420
+ * - `'--show'`: Displays the target component if it's currently hidden.
1421
+ * - `'--hide'`: Conceals the target component from view.
1422
+ * - `'--toggle'`: Alternates the target component between visible and hidden states.
1423
+ * - `'--copy'`: Copies the target clipboard item.
1366
1424
  *
1367
- * - `--auto`: a default action for the target component.
1368
- * - `--show`: shows the target component.
1369
- * - `--hide`: hides the target component.
1370
- * - `--toggle`: toggles the target component.
1371
- * - `--copy`: copies the target ClipboardItem.
1425
+ * The supported actions vary by target component type.
1372
1426
  *
1373
1427
  * @default '--auto'
1374
- *
1375
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command
1376
1428
  */
1377
1429
  command?: "--auto" | "--show" | "--hide" | "--toggle" | "--copy";
1378
1430
  /**
1379
- * ID of a component that should respond to interest (e.g. hover and focus) on this component.
1431
+ * The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).
1380
1432
  */
1381
1433
  interestFor?: string;
1382
1434
  }
@@ -1384,58 +1436,62 @@ export interface BaseClickableProps extends ButtonBehaviorProps, LinkBehaviorPro
1384
1436
  }
1385
1437
  interface ButtonProps$1 extends GlobalProps, BaseClickableProps {
1386
1438
  /**
1387
- * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.
1388
- *
1389
- * Use this when using only an icon or the Button text is not enough context
1390
- * for users using assistive technologies.
1439
+ * A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.
1391
1440
  */
1392
1441
  accessibilityLabel?: string;
1393
1442
  /**
1394
- * The content of the Button.
1443
+ * The content displayed within the button component.
1395
1444
  */
1396
1445
  children?: ComponentChildren;
1397
1446
  /**
1398
- * The type of icon to be displayed in the Button.
1447
+ * An icon displayed inside the button, typically positioned before the button text.
1399
1448
  *
1400
1449
  * @default ''
1401
1450
  */
1402
1451
  icon?: IconType | AnyString;
1403
1452
  /**
1404
- * The displayed inline width of the Button.
1453
+ * The inline width of the button component.
1405
1454
  *
1406
- * - `auto`: the size of the button depends on the surface and context.
1407
- * - `fill`: the button will takes up 100% of the available inline size.
1408
- * - `fit-content`: the button will take up the minimum inline-size required to fit its content.
1455
+ * - `'auto'`: The size depends on the surface and context.
1456
+ * - `'fill'`: The button takes up 100% of the available inline size.
1457
+ * - `'fit-content'`: The button takes up the minimum inline size required to fit its content.
1409
1458
  *
1410
1459
  * @default 'auto'
1411
1460
  */
1412
1461
  inlineSize?: "auto" | "fill" | "fit-content";
1413
1462
  /**
1414
- * Changes the visual appearance of the Button.
1463
+ * The visual style variant of the button component, which controls its prominence and emphasis.
1464
+ *
1465
+ * - `'auto'`: Automatically determined by the button's context.
1466
+ * - `'primary'`: High-emphasis style for the main action.
1467
+ * - `'secondary'`: Medium-emphasis style for supporting actions.
1468
+ * - `'tertiary'`: Low-emphasis style for less prominent actions.
1415
1469
  *
1416
- * @default 'auto' - the variant is automatically determined by the Button's context
1470
+ * @default 'auto'
1417
1471
  */
1418
1472
  variant?: "auto" | "primary" | "secondary" | "tertiary";
1419
1473
  /**
1420
- * Sets the tone of the Button based on the intention of the information being conveyed.
1474
+ * The semantic meaning and color treatment of the button.
1475
+ *
1476
+ * - `'auto'`: Automatically determined based on context.
1477
+ * - `'neutral'`: General information without specific intent.
1478
+ * - `'critical'`: Urgent problems or destructive actions.
1421
1479
  *
1422
1480
  * @default 'auto'
1423
1481
  */
1424
1482
  tone?: ToneKeyword;
1425
1483
  /**
1426
- * Indicate the text language. Useful when the text is in a different language than the rest of the page.
1427
- * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
1428
- * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
1484
+ * The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label).
1429
1485
  */
1430
1486
  lang?: string;
1431
1487
  }
1432
1488
  export interface BaseInputProps {
1433
1489
  /**
1434
- * An identifier for the field that is unique within the nearest containing form.
1490
+ * The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.
1435
1491
  */
1436
1492
  name?: string;
1437
1493
  /**
1438
- * Disables the field, disallowing any interaction.
1494
+ * Whether the field is disabled, preventing any user interaction.
1439
1495
  *
1440
1496
  * @default false
1441
1497
  */
@@ -1443,15 +1499,15 @@ export interface BaseInputProps {
1443
1499
  }
1444
1500
  export interface InputProps extends BaseInputProps {
1445
1501
  /**
1446
- * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.
1502
+ * A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.
1447
1503
  *
1448
1504
  * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
1449
1505
  */
1450
1506
  onChange?: (event: Event) => void;
1451
1507
  /**
1452
- * Callback when the user makes any changes in the field.
1508
+ * A callback fired when the user makes any changes in the field, such as typing a character.
1453
1509
  *
1454
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
1510
+ * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
1455
1511
  */
1456
1512
  onInput?: (event: Event) => void;
1457
1513
  /**
@@ -1459,7 +1515,7 @@ export interface InputProps extends BaseInputProps {
1459
1515
  */
1460
1516
  value?: string;
1461
1517
  /**
1462
- * The default value for the field.
1518
+ * The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.
1463
1519
  *
1464
1520
  * @implementation `defaultValue` reflects to the `value` attribute.
1465
1521
  */
@@ -1467,15 +1523,15 @@ export interface InputProps extends BaseInputProps {
1467
1523
  }
1468
1524
  export interface MultipleInputProps extends BaseInputProps {
1469
1525
  /**
1470
- * Callback when the user has selected option(s).
1526
+ * A callback fired when the user has selected one or more options.
1471
1527
  *
1472
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
1528
+ * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
1473
1529
  */
1474
1530
  onChange?: (event: Event) => void;
1475
1531
  /**
1476
- * Callback when the user has selected option(s).
1532
+ * A callback fired when the user selects or deselects options.
1477
1533
  *
1478
- * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
1534
+ * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
1479
1535
  */
1480
1536
  onInput?: (event: Event) => void;
1481
1537
  /**
@@ -1487,11 +1543,11 @@ export interface MultipleInputProps extends BaseInputProps {
1487
1543
  }
1488
1544
  export interface FileInputProps extends BaseInputProps {
1489
1545
  /**
1490
- * Callback when the user has **finished selecting** a file or files.
1546
+ * A callback fired when the user has finished selecting one or more files.
1491
1547
  */
1492
1548
  onChange?: (event: Event) => void;
1493
1549
  /**
1494
- * Callback when the user makes any changes in the file selection.
1550
+ * A callback fired when the user makes any changes to the file selection.
1495
1551
  */
1496
1552
  onInput?: (event: Event) => void;
1497
1553
  /**
@@ -1516,8 +1572,7 @@ export interface FileInputProps extends BaseInputProps {
1516
1572
  }
1517
1573
  export interface FieldErrorProps {
1518
1574
  /**
1519
- * Indicate an error to the user. The field will be given a specific stylistic treatment
1520
- * to communicate problems that have to be resolved immediately.
1575
+ * An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.
1521
1576
  */
1522
1577
  error?: string;
1523
1578
  }
@@ -1532,7 +1587,7 @@ export interface BasicFieldProps extends FieldErrorProps, LabelAccessibilityVisi
1532
1587
  */
1533
1588
  required?: boolean;
1534
1589
  /**
1535
- * Content to use as the field label.
1590
+ * The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.
1536
1591
  */
1537
1592
  label?: string;
1538
1593
  }
@@ -1548,13 +1603,13 @@ export interface FieldDetailsProps {
1548
1603
  }
1549
1604
  export interface FieldProps extends BasicFieldProps, InputProps, FocusEventProps, FieldDetailsProps {
1550
1605
  /**
1551
- * A short hint that describes the expected value of the field.
1606
+ * The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.
1552
1607
  */
1553
1608
  placeholder?: string;
1554
1609
  }
1555
1610
  export interface BaseTextFieldProps extends FieldProps {
1556
1611
  /**
1557
- * The field cannot be edited by the user. It is focusable will be announced by screen readers.
1612
+ * Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.
1558
1613
  *
1559
1614
  * @default false
1560
1615
  */
@@ -1566,7 +1621,7 @@ export interface FieldDecorationProps {
1566
1621
  *
1567
1622
  * This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".
1568
1623
  *
1569
- * This cannot be edited by the user, and it isn't included in the value of the field.
1624
+ * This can't be edited by the user, and it isn't included in the value of the field.
1570
1625
  *
1571
1626
  * It may not be displayed until the user has interacted with the input.
1572
1627
  * For example, an inline label may take the place of the suffix until the user focuses the input.
@@ -1579,7 +1634,7 @@ export interface FieldDecorationProps {
1579
1634
  *
1580
1635
  * This is useful for displaying an implied part of the value, such as "https://" or "+353".
1581
1636
  *
1582
- * This cannot be edited by the user, and it isn't included in the value of the field.
1637
+ * This can't be edited by the user, and it isn't included in the value of the field.
1583
1638
  *
1584
1639
  * It may not be displayed until the user has interacted with the input.
1585
1640
  * For example, an inline label may take the place of the prefix until the user focuses the input.
@@ -1604,8 +1659,7 @@ export interface NumberConstraintsProps {
1604
1659
  * The highest decimal or integer to be accepted for the field.
1605
1660
  * When used with `step` the value will round down to the max number.
1606
1661
  *
1607
- * Note: a user will still be able to use the keyboard to input a number higher than
1608
- * the max. It is up to the developer to add appropriate validation.
1662
+ * Note: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.
1609
1663
  *
1610
1664
  * @default Infinity
1611
1665
  */
@@ -1614,8 +1668,7 @@ export interface NumberConstraintsProps {
1614
1668
  * The lowest decimal or integer to be accepted for the field.
1615
1669
  * When used with `step` the value will round up to the min number.
1616
1670
  *
1617
- * Note: a user will still be able to use the keyboard to input a number lower than
1618
- * the min. It is up to the developer to add appropriate validation.
1671
+ * Note: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.
1619
1672
  *
1620
1673
  * @default -Infinity
1621
1674
  */
@@ -1632,10 +1685,9 @@ export interface NumberConstraintsProps {
1632
1685
  /**
1633
1686
  * Sets the type of controls displayed in the field.
1634
1687
  *
1635
- * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.
1636
- * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.
1637
- * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.
1638
- * - `auto`: the presence of the controls depends on the surface and context.
1688
+ * - `'auto'`: The presence of the controls depends on the surface and context.
1689
+ * - `'stepper'`: Displays buttons to increase or decrease the value by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value are enabled.
1690
+ * - `'none'`: No controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.
1639
1691
  *
1640
1692
  * @default 'auto'
1641
1693
  */
@@ -1649,7 +1701,7 @@ export interface MinMaxLengthProps {
1649
1701
  */
1650
1702
  maxLength?: number;
1651
1703
  /**
1652
- * Specifies the min number of characters allowed.
1704
+ * Specifies the minimum number of characters allowed.
1653
1705
  *
1654
1706
  * @default 0
1655
1707
  */
@@ -1662,7 +1714,7 @@ export interface BaseSelectableProps {
1662
1714
  */
1663
1715
  accessibilityLabel?: string;
1664
1716
  /**
1665
- * Disables the control, disallowing any interaction.
1717
+ * Whether the control is disabled, preventing any user interaction.
1666
1718
  *
1667
1719
  * @default false
1668
1720
  */
@@ -1674,13 +1726,13 @@ export interface BaseSelectableProps {
1674
1726
  }
1675
1727
  export interface BaseOptionProps extends BaseSelectableProps {
1676
1728
  /**
1677
- * Whether the control is active.
1729
+ * Whether the control is currently selected.
1678
1730
  *
1679
1731
  * @default false
1680
1732
  */
1681
1733
  selected?: boolean;
1682
1734
  /**
1683
- * Whether the control is active by default.
1735
+ * Whether the control is selected by default.
1684
1736
  *
1685
1737
  * @implementation `defaultSelected` reflects to the `selected` attribute.
1686
1738
  *
@@ -1690,17 +1742,17 @@ export interface BaseOptionProps extends BaseSelectableProps {
1690
1742
  }
1691
1743
  export interface BaseCheckableProps extends BaseSelectableProps, InteractionProps {
1692
1744
  /**
1693
- * Visual content to use as the control label.
1745
+ * The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.
1694
1746
  */
1695
1747
  label?: string;
1696
1748
  /**
1697
- * Whether the control is active.
1749
+ * Whether the control is currently checked.
1698
1750
  *
1699
1751
  * @default false
1700
1752
  */
1701
1753
  checked?: boolean;
1702
1754
  /**
1703
- * Whether the control is active by default.
1755
+ * Whether the control is checked by default.
1704
1756
  *
1705
1757
  * @implementation `defaultChecked` reflects to the `checked` attribute.
1706
1758
  *
@@ -1708,8 +1760,7 @@ export interface BaseCheckableProps extends BaseSelectableProps, InteractionProp
1708
1760
  */
1709
1761
  defaultChecked?: boolean;
1710
1762
  /**
1711
- * An identifier for the control that is unique within the nearest
1712
- * containing `Form` component.
1763
+ * The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.
1713
1764
  */
1714
1765
  name?: string;
1715
1766
  /**
@@ -1771,7 +1822,7 @@ export interface ChipProps$1 {
1771
1822
  */
1772
1823
  graphic?: ComponentChildren;
1773
1824
  /**
1774
- * A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers.
1825
+ * A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.
1775
1826
  */
1776
1827
  accessibilityLabel?: string;
1777
1828
  /**
@@ -1806,13 +1857,13 @@ interface ChoiceProps$1 extends GlobalProps, BaseOptionProps {
1806
1857
  */
1807
1858
  details?: ComponentChildren;
1808
1859
  /**
1809
- * Set to `true` to associate a choice with the error passed to `ChoiceList`
1860
+ * Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.
1810
1861
  *
1811
1862
  * @default false
1812
1863
  */
1813
1864
  error?: boolean;
1814
1865
  /**
1815
- * Secondary content for a choice.
1866
+ * Additional text or elements displayed below the choice label, providing extra context or detail to help users make a selection.
1816
1867
  */
1817
1868
  secondaryContent?: ComponentChildren;
1818
1869
  /**
@@ -1836,7 +1887,7 @@ interface ChoiceListProps$1 extends GlobalProps, Pick<BasicFieldProps, "label" |
1836
1887
  */
1837
1888
  children?: ComponentChildren;
1838
1889
  /**
1839
- * Disables the field, disallowing any interaction.
1890
+ * Whether the field is disabled, preventing any user interaction.
1840
1891
  *
1841
1892
  * `disabled` on any child choices is ignored when this is true.
1842
1893
  *
@@ -1869,7 +1920,7 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
1869
1920
  /**
1870
1921
  * Disables the clickable, meaning it cannot be clicked or receive focus.
1871
1922
  *
1872
- * In this state, onClick will not fire.
1923
+ * In this state, the `click` event will not fire.
1873
1924
  * If the click event originates from a child element, the event will immediately stop propagating from this element.
1874
1925
  *
1875
1926
  * However, items within the clickable can still receive focus and be interacted with.
@@ -1881,7 +1932,7 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
1881
1932
  /**
1882
1933
  * Indicate the text language. Useful when the text is in a different language than the rest of the page.
1883
1934
  * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
1884
- * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
1935
+ * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)
1885
1936
  *
1886
1937
  * @default ''
1887
1938
  */
@@ -1893,9 +1944,7 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
1893
1944
  */
1894
1945
  onClick?: (event: Event) => void;
1895
1946
  /**
1896
- * The URL to link to.
1897
- *
1898
- * - If set, it will navigate to the location specified by `href` after executing the `click` event.
1947
+ * The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.
1899
1948
  */
1900
1949
  href?: string;
1901
1950
  /**
@@ -1955,7 +2004,7 @@ interface ClipboardItemProps$1 extends GlobalProps {
1955
2004
  }
1956
2005
  export interface AutocompleteProps<AutocompleteField extends AnyAutocompleteField> {
1957
2006
  /**
1958
- * A hint as to the intended content of the field.
2007
+ * A hint about the intended content of the field for browser autofill.
1959
2008
  *
1960
2009
  * When set to `on` (the default), this property indicates that the field should support
1961
2010
  * autofill, but you do not have any more semantic information on the intended
@@ -1967,12 +2016,9 @@ export interface AutocompleteProps<AutocompleteField extends AnyAutocompleteFiel
1967
2016
  * Alternatively, you can provide value which describes the
1968
2017
  * specific data you would like to be entered into this field during autofill.
1969
2018
  *
1970
- * @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers.
2019
+ * Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.
1971
2020
  *
1972
- * @default 'tel' for PhoneField
1973
- * @default 'email' for EmailField
1974
- * @default 'url' for URLField
1975
- * @default 'on' for everything else
2021
+ * @default 'on'
1976
2022
  */
1977
2023
  autocomplete?: AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | "on" | "off";
1978
2024
  }
@@ -1994,12 +2040,15 @@ export type AutocompleteGroup = "shipping" | "billing";
1994
2040
  export type AutocompleteAddressGroup = "fax" | "home" | "mobile" | "pager";
1995
2041
  export type AnyAutocompleteField = "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "current-password" | "email" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "new-password" | "nickname" | "one-time-code" | "organization-title" | "organization" | "photo" | "postal-code" | "sex" | "street-address" | "transaction-amount" | "transaction-currency" | "url" | "username" | "bday-day" | "bday-month" | "bday-year" | "bday" | "cc-additional-name" | "cc-expiry-month" | "cc-expiry-year" | "cc-expiry" | "cc-family-name" | "cc-given-name" | "cc-name" | "cc-number" | "cc-csc" | "cc-type" | `${AutocompleteAddressGroup} email` | "impp" | `${AutocompleteAddressGroup} impp` | "tel" | "tel-area-code" | "tel-country-code" | "tel-extension" | "tel-local-prefix" | "tel-local-suffix" | "tel-local" | "tel-national" | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`;
1996
2042
  export type TextAutocompleteField = ExtractStrict<AnyAutocompleteField, "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "nickname" | "one-time-code" | "organization-title" | "organization" | "postal-code" | "sex" | "street-address" | "transaction-currency" | "username" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-type">;
2043
+ /**
2044
+ * The type of consent policy being collected.
2045
+ *
2046
+ * - `'sms-marketing'`: Represents the policy for SMS marketing consent.
2047
+ */
1997
2048
  export type ConsentPolicy = "sms-marketing";
1998
2049
  interface ConsentCheckboxProps$1 extends GlobalProps, CheckboxProps$1 {
1999
2050
  /**
2000
- * The policy for which user consent is being collected for.
2001
- *
2002
- * `sms-marketing`: Represents the policy for SMS marketing consent.
2051
+ * The policy for which user consent is being collected.
2003
2052
  */
2004
2053
  policy?: ConsentPolicy;
2005
2054
  }
@@ -2016,9 +2065,7 @@ interface PhoneFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick<FieldD
2016
2065
  }
2017
2066
  interface ConsentPhoneFieldProps$1 extends GlobalProps, PhoneFieldProps$1 {
2018
2067
  /**
2019
- * The policy for which user consent is being collected for.
2020
- *
2021
- * `sms-marketing`: Represents the policy for SMS marketing consent.
2068
+ * The policy for which user consent is being collected.
2022
2069
  */
2023
2070
  policy?: ConsentPolicy;
2024
2071
  }
@@ -2237,13 +2284,20 @@ interface DetailsProps$1 extends GlobalProps, ToggleEventProps {
2237
2284
  }
2238
2285
  interface DividerProps$1 extends GlobalProps {
2239
2286
  /**
2240
- * Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
2287
+ * The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
2288
+ *
2289
+ * - `inline`: A horizontal divider that separates content stacked vertically.
2290
+ * - `block`: A vertical divider that separates content arranged horizontally.
2241
2291
  *
2242
2292
  * @default 'inline'
2243
2293
  */
2244
2294
  direction?: "inline" | "block";
2245
2295
  /**
2246
- * Modify the color to be more or less intense.
2296
+ * The visual emphasis of the divider's color.
2297
+ *
2298
+ * - `subdued`: A lighter divider for subtle separation.
2299
+ * - `base`: The standard divider color for most contexts.
2300
+ * - `strong`: A darker divider for stronger visual separation.
2247
2301
  *
2248
2302
  * @default 'base'
2249
2303
  */
@@ -2253,7 +2307,7 @@ interface DropZoneProps$1 extends GlobalProps, FileInputProps, BasicFieldProps {
2253
2307
  /**
2254
2308
  * A string representing the types of files that are accepted by the drop zone.
2255
2309
  * This string is a comma-separated list of unique file type specifiers which can be one of the following:
2256
- * - A file extension starting with a period (".") character (e.g. .jpg, .pdf, .doc)
2310
+ * - A file extension starting with a period (".") character (such as .jpg, .pdf, .doc)
2257
2311
  * - A valid MIME type string with no extensions
2258
2312
  *
2259
2313
  * If omitted, all file types are accepted.
@@ -2311,29 +2365,31 @@ interface FormProps$1 extends GlobalProps {
2311
2365
  */
2312
2366
  onReset?: (event: Event) => void;
2313
2367
  }
2368
+ /**
2369
+ * The amount of space between child elements.
2370
+ *
2371
+ * - `none`: No spacing.
2372
+ * - `small-500`: The smallest spacing.
2373
+ * - `small-400` / `small-300` / `small-200` / `small-100` / `small`: Progressively larger small spacings.
2374
+ * - `base`: The standard spacing for most use cases.
2375
+ * - `large` / `large-100` / `large-200` / `large-300` / `large-400` / `large-500`: Progressively larger spacings.
2376
+ */
2314
2377
  export type SpacingKeyword = SizeKeyword | "none";
2315
2378
  export interface GapProps {
2316
2379
  /**
2317
- * Adjust spacing between elements.
2318
- *
2319
- * A single value applies to both axes.
2320
- * A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.
2380
+ * The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.
2321
2381
  *
2322
2382
  * @default 'none'
2323
2383
  */
2324
2384
  gap?: MaybeResponsive<MaybeTwoValuesShorthandProperty<SpacingKeyword>>;
2325
2385
  /**
2326
- * Adjust spacing between elements in the block axis.
2327
- *
2328
- * This overrides the row value of `gap`.
2386
+ * The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.
2329
2387
  *
2330
2388
  * @default '' - meaning no override
2331
2389
  */
2332
2390
  rowGap?: MaybeResponsive<SpacingKeyword | "">;
2333
2391
  /**
2334
- * Adjust spacing between elements in the inline axis.
2335
- *
2336
- * This overrides the column value of `gap`.
2392
+ * The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.
2337
2393
  *
2338
2394
  * @default '' - meaning no override
2339
2395
  */
@@ -2344,108 +2400,80 @@ export type ContentDistribution = "space-between" | "space-around" | "space-even
2344
2400
  export type ContentPosition = "center" | "start" | "end";
2345
2401
  export type OverflowPosition = `unsafe ${ContentPosition}` | `safe ${ContentPosition}`;
2346
2402
  /**
2347
- * Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis.
2348
- *
2349
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
2403
+ * Controls the default inline-axis alignment for all items within a container. Learn more about [`justify-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).
2350
2404
  */
2351
2405
  export type JustifyItemsKeyword = "normal" | "stretch" | BaselinePosition | OverflowPosition | ContentPosition;
2352
2406
  /**
2353
- * Align items sets the align-self value on all direct children as a group.
2354
- *
2355
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
2407
+ * Controls how all direct children are aligned along the cross axis. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
2356
2408
  */
2357
2409
  export type AlignItemsKeyword = "normal" | "stretch" | BaselinePosition | OverflowPosition | ContentPosition;
2358
2410
  /**
2359
- * 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.
2360
- *
2361
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
2411
+ * Controls how space is distributed between and around content items along the main axis of a flex container or the inline axis of a grid container. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
2362
2412
  */
2363
2413
  export type JustifyContentKeyword = "normal" | ContentDistribution | OverflowPosition | ContentPosition;
2364
2414
  /**
2365
- *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.
2366
- *
2367
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
2415
+ * Controls the distribution of space between and around content items along the cross axis of a flex container or the block axis of a grid container. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
2368
2416
  */
2369
2417
  export type AlignContentKeyword = "normal" | BaselinePosition | ContentDistribution | OverflowPosition | ContentPosition;
2370
2418
  interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
2371
2419
  /**
2372
- Define columns and specify their size.
2373
-
2374
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns
2375
- @default 'none'
2376
- */
2420
+ * Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `"1fr 2fr"` or `"repeat(3, 1fr)"`.
2421
+ *
2422
+ * @default 'none'
2423
+ */
2377
2424
  gridTemplateColumns?: MaybeResponsive<string>;
2378
2425
  /**
2379
- Define rows and specify their size.
2380
-
2381
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows
2382
- @default 'none'
2383
- */
2426
+ * Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `"auto 1fr"` or `"repeat(2, 100px)"`.
2427
+ *
2428
+ * @default 'none'
2429
+ */
2384
2430
  gridTemplateRows?: MaybeResponsive<string>;
2385
2431
  /**
2386
- Aligns the grid items along the inline (row) axis.
2387
-
2388
- This overrides the inline value of `placeItems`.
2389
-
2390
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
2391
- @default '' - meaning no override
2392
- */
2432
+ * Aligns grid items along the inline (row) axis. Overrides the inline value of `placeItems`. Learn more about [`justify-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).
2433
+ *
2434
+ * @default '' - meaning no override
2435
+ */
2393
2436
  justifyItems?: MaybeResponsive<JustifyItemsKeyword | "">;
2394
2437
  /**
2395
- Aligns the grid items along the block (column) axis.
2396
-
2397
- This overrides the block value of `placeItems`.
2398
-
2399
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
2400
- @default '' - meaning no override
2401
- */
2438
+ * Aligns grid items along the block (column) axis. Overrides the block value of `placeItems`. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
2439
+ *
2440
+ * @default '' - meaning no override
2441
+ */
2402
2442
  alignItems?: MaybeResponsive<AlignItemsKeyword | "">;
2403
2443
  /**
2404
- A shorthand property for `justify-items` and `align-items`.
2405
-
2406
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/place-items
2407
- @default 'normal normal'
2408
- */
2444
+ * A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once. Learn more about [`place-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items).
2445
+ *
2446
+ * @default 'normal normal'
2447
+ */
2409
2448
  placeItems?: MaybeResponsive<`${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword>;
2410
2449
  /**
2411
- Aligns the grid along the inline (row) axis.
2412
-
2413
- This overrides the inline value of `placeContent`.
2414
-
2415
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
2416
- @default '' - meaning no override
2417
- */
2450
+ * Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Overrides the inline value of `placeContent`. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
2451
+ *
2452
+ * @default '' - meaning no override
2453
+ */
2418
2454
  justifyContent?: MaybeResponsive<JustifyContentKeyword | "">;
2419
2455
  /**
2420
- Aligns the grid along the block (column) axis.
2421
-
2422
- This overrides the block value of `placeContent`.
2423
-
2424
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
2425
- @default '' - meaning no override
2426
- */
2456
+ * Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Overrides the block value of `placeContent`. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
2457
+ *
2458
+ * @default '' - meaning no override
2459
+ */
2427
2460
  alignContent?: MaybeResponsive<AlignContentKeyword | "">;
2428
2461
  /**
2429
- A shorthand property for `justify-content` and `align-content`.
2430
-
2431
- @see https://developer.mozilla.org/en-US/docs/Web/CSS/place-content
2432
- @default 'normal normal'
2433
- */
2462
+ * A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once. Learn more about [`place-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content).
2463
+ *
2464
+ * @default 'normal normal'
2465
+ */
2434
2466
  placeContent?: MaybeResponsive<`${AlignContentKeyword} ${JustifyContentKeyword}` | AlignContentKeyword>;
2435
2467
  }
2436
2468
  interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
2437
2469
  /**
2438
- * Number of columns the item will span across
2439
- *
2440
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
2470
+ * The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).
2441
2471
  *
2442
2472
  * @default 'auto'
2443
2473
  */
2444
2474
  gridColumn?: `span ${number}` | "auto";
2445
2475
  /**
2446
- * Number of rows the item will span across
2447
- *
2448
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
2476
+ * The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).
2449
2477
  *
2450
2478
  * @default 'auto'
2451
2479
  */
@@ -2475,7 +2503,7 @@ export interface BaseTypographyProps {
2475
2503
  /**
2476
2504
  * Indicate the text language. Useful when the text is in a different language than the rest of the page.
2477
2505
  * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
2478
- * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
2506
+ * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label)
2479
2507
  *
2480
2508
  * It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.
2481
2509
  *
@@ -2485,8 +2513,8 @@ export interface BaseTypographyProps {
2485
2513
  /**
2486
2514
  * Indicates the directionality of the element’s text.
2487
2515
  *
2488
- * - `ltr`: languages written from left to right (e.g. English)
2489
- * - `rtl`: languages written from right to left (e.g. Arabic)
2516
+ * - `ltr`: languages written from left to right (such as English)
2517
+ * - `rtl`: languages written from right to left (such as Arabic)
2490
2518
  * - `auto`: the user agent determines the direction based on the content
2491
2519
  * - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)
2492
2520
  *
@@ -2530,94 +2558,110 @@ interface HeadingProps$1 extends GlobalProps, AccessibilityVisibilityProps, Bloc
2530
2558
  */
2531
2559
  accessibilityRole?: "heading" | ExtractStrict<AccessibilityRole, "presentation" | "none">;
2532
2560
  }
2561
+ /**
2562
+ * The shared properties for the icon component. An icon displays a graphical symbol with configurable appearance, color, and semantic meaning.
2563
+ */
2533
2564
  interface IconProps$1 extends GlobalProps, Pick<InteractionProps, "interestFor"> {
2534
2565
  /**
2535
- * Sets the tone of the icon, based on the intention of the information being conveyed.
2566
+ * The semantic meaning and color treatment of the icon.
2567
+ *
2568
+ * - `'info'`: Informational content or helpful tips.
2569
+ * - `'auto'`: Automatically determined based on context.
2570
+ * - `'neutral'`: General information without specific intent.
2571
+ * - `'success'`: Positive outcomes or successful states.
2572
+ * - `'warning'`: Important warnings about potential issues.
2573
+ * - `'critical'`: Urgent problems or destructive actions.
2574
+ * - `'custom'`: Inherits a custom color from its parent element's CSS.
2536
2575
  *
2537
2576
  * @default 'auto'
2538
2577
  */
2539
2578
  tone?: ToneKeyword;
2540
2579
  /**
2541
- * Modify the color to be more or less intense.
2580
+ * The color intensity of the icon. Use `'subdued'` for less intense, or `'base'` for standard coloring.
2542
2581
  *
2543
2582
  * @default 'base'
2544
2583
  */
2545
2584
  color?: ColorKeyword;
2546
2585
  /**
2547
- * Adjusts the size of the icon.
2586
+ * The size of the icon.
2587
+ *
2588
+ * - `'base'`: Default size that works well for most use cases.
2589
+ * - `'small'`: Small icon for inline use within text or compact UI elements.
2590
+ * - `'small-200'`: Extra small icon for the most compact contexts.
2591
+ * - `'small-100'`: Small icon suitable for tight or dense layouts.
2592
+ * - `'large'`: Large icon for emphasis or prominent display.
2593
+ * - `'large-100'`: Extra large icon for maximum visual impact.
2548
2594
  *
2549
2595
  * @default 'base'
2550
2596
  */
2551
2597
  size?: SizeKeyword;
2598
+ /**
2599
+ * The icon to display. Can be any icon name from the icon library or a custom string identifier.
2600
+ */
2552
2601
  type?: IconType | AnyString;
2553
2602
  }
2603
+ /**
2604
+ * The shared base properties for image-based components. These properties are common to all components that display images, including the image and product thumbnail components. Properties include `alt` for accessibility text, `src` for the image URL, `sizes` for responsive sizing hints, and `srcSet` for multiple image sources.
2605
+ */
2554
2606
  export interface BaseImageProps {
2555
2607
  /**
2556
- * An alternative text description that describe the image for the reader to
2557
- * understand what it is about. It is extremely useful for both users using
2558
- * assistive technology and sighted users. A well written description
2559
- * provides people with visual impairments the ability to participate in
2560
- * consuming non-text content. When a screen readers encounters an `s-image`,
2561
- * the description is read and announced aloud. If an image fails to load,
2562
- * potentially due to a poor connection, the `alt` is displayed on
2563
- * screen instead. This has the benefit of letting a sighted buyer know an
2564
- * image was meant to load here, but as an alternative, they’re still able to
2565
- * consume the text content. Read
2566
- * [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4)
2567
- * to learn more.
2568
- *
2569
- * @default `''`
2570
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
2608
+ * Alternative text that describes the image for accessibility.
2609
+ *
2610
+ * Provides a text description of the image for users with assistive technology
2611
+ * and serves as a fallback when the image fails to load. A well-written description
2612
+ * enables people with visual impairments to understand non-text content.
2613
+ *
2614
+ * When a screen reader encounters an image, it reads this description aloud.
2615
+ * When an image fails to load, this text displays on screen, helping all users
2616
+ * understand what content was intended.
2617
+ *
2618
+ * Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)
2619
+ * and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).
2620
+ *
2621
+ * @default ''
2571
2622
  */
2572
2623
  alt?: string;
2573
2624
  /**
2574
- * A set of media conditions and their corresponding sizes.
2575
- *
2576
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes
2625
+ * A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).
2577
2626
  */
2578
2627
  sizes?: string;
2579
2628
  /**
2580
2629
  * The image source (either a remote URL or a local file resource).
2581
2630
  *
2582
- * When the image is loading or no `src` is provided, a placeholder will be rendered.
2583
- *
2584
- * @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be
2585
- * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.
2586
- *
2587
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
2631
+ * When the image is loading or no `src` is provided, a placeholder is rendered.
2632
+ * Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).
2588
2633
  */
2589
2634
  src?: string;
2590
2635
  /**
2591
- * A set of image sources and their width or pixel density descriptors.
2592
- *
2593
- * This overrides the `src` property.
2594
- *
2595
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset
2636
+ * A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.
2596
2637
  */
2597
2638
  srcSet?: string;
2598
2639
  }
2640
+ /**
2641
+ * The shared properties for the image component. An image displays pictures with configurable sizing, loading behavior, and borders.
2642
+ */
2599
2643
  interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
2600
2644
  /**
2601
- * Sets the semantic meaning of the component’s content. When set,
2645
+ * Sets the semantic meaning of the image content. When set,
2602
2646
  * the role will be used by assistive technologies to help users
2603
2647
  * navigate the page.
2604
2648
  *
2605
- * @default 'img'
2649
+ * - `'img'`: Identifies the element as an image that conveys meaningful information to users.
2650
+ * - `'none'`: Completely hides the element and its content from assistive technologies.
2651
+ * - `'presentation'`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.
2606
2652
  *
2607
- * @implementation The `img` role doesn't need to be applied if
2608
- * the host applies it for you; for example, an HTML host rendering
2609
- * an `<img>` element should not apply the `img` role.
2653
+ * @default 'img'
2610
2654
  */
2611
2655
  accessibilityRole?: "img" | ExtractStrict<AccessibilityRole, "presentation" | "none">;
2612
2656
  /**
2613
- * The displayed inline width of the image.
2657
+ * The inline width (horizontal size) of the image.
2614
2658
  *
2615
- * - `fill`: the image will takes up 100% of the available inline size.
2616
- * - `auto`: the image will be displayed at its natural size.
2659
+ * - `'fill'`: The image takes up 100% of the available inline space.
2660
+ * - `'auto'`: The image is displayed at its natural size.
2617
2661
  *
2618
- * @default 'fill'
2662
+ * Learn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).
2619
2663
  *
2620
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width
2664
+ * @default 'fill'
2621
2665
  */
2622
2666
  inlineSize?: "fill" | "auto";
2623
2667
  /**
@@ -2628,67 +2672,59 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
2628
2672
  * - `inlineSize="fill"`: the aspect ratio will be respected and the image will take the necessary space.
2629
2673
  * - `inlineSize="auto"`: the image will not render until it has loaded and the aspect ratio will be ignored.
2630
2674
  *
2631
- * For example, if the value is set as `50 / 100`, the getter returns `50 / 100`.
2632
- * If the value is set as `0.5`, the getter returns `0.5 / 1`.
2675
+ * Learn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).
2633
2676
  *
2634
2677
  * @default '1/1'
2635
- *
2636
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio
2637
2678
  */
2638
2679
  aspectRatio?: `${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`;
2639
2680
  /**
2640
- * Determines how the content of the image is resized to fit its container.
2641
- * The image is positioned in the center of the container.
2681
+ * How the image should be resized to fit its container. The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).
2642
2682
  *
2643
- * @default 'contain'
2683
+ * - `'contain'`: Fits the entire image within the container, preserving aspect ratio. May leave empty space.
2684
+ * - `'cover'`: Fills the container while preserving aspect ratio, cropping the image if needed.
2644
2685
  *
2645
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
2686
+ * @default 'contain'
2646
2687
  */
2647
2688
  objectFit?: "contain" | "cover";
2648
2689
  /**
2649
2690
  * Determines the loading behavior of the image:
2650
- * - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
2651
- * - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
2691
+ * - `'eager'`: Immediately loads the image, irrespective of its position within the visible viewport.
2692
+ * - `'lazy'`: Delays loading the image until it approaches a specified distance from the viewport.
2693
+ *
2694
+ * Learn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).
2652
2695
  *
2653
2696
  * @default 'eager'
2654
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
2655
2697
  */
2656
2698
  loading?: "eager" | "lazy";
2657
2699
  /**
2658
- * Invoked when load completes successfully.
2659
- *
2660
- * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
2700
+ * A callback fired when the image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload).
2661
2701
  */
2662
2702
  onLoad?: (event: Event) => void;
2663
2703
  /**
2664
- * Invoked on load error.
2665
- *
2666
- * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
2704
+ * A callback fired when the image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror).
2667
2705
  */
2668
2706
  onError?: (event: Event) => void;
2669
2707
  }
2670
2708
  interface LinkProps$1 extends GlobalProps, LinkBehaviorProps {
2671
2709
  /**
2672
- * The content of the Link.
2710
+ * The text or elements displayed as the link's content.
2673
2711
  */
2674
2712
  children?: ComponentChildren;
2675
2713
  /**
2676
- * Sets the tone of the Link, based on the intention of the information being conveyed.
2714
+ * The semantic meaning and color treatment of the link.
2715
+ *
2716
+ * - `'auto'`: Automatically determined based on context.
2717
+ * - `'neutral'`: Removes the default link color, inheriting the surrounding text style.
2677
2718
  *
2678
2719
  * @default 'auto'
2679
2720
  */
2680
2721
  tone?: ToneKeyword;
2681
2722
  /**
2682
- * A label that describes the purpose or contents of the Link. It will be read to users using assistive technologies such as screen readers.
2683
- *
2684
- * Use this when using only an icon or the content of the link is not enough context
2685
- * for users using assistive technologies.
2723
+ * A label that describes the purpose or content of the link for users of assistive technologies such as screen readers.
2686
2724
  */
2687
2725
  accessibilityLabel?: string;
2688
2726
  /**
2689
- * Indicate the text language. Useful when the text is in a different language than the rest of the page.
2690
- * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
2691
- * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
2727
+ * The language of the link's text content. Use this when the link text is in a different language than the rest of the page.
2692
2728
  */
2693
2729
  lang?: string;
2694
2730
  }
@@ -2700,166 +2736,186 @@ interface ListItemProps$1 extends GlobalProps {
2700
2736
  }
2701
2737
  interface MapProps$1 extends GlobalProps, SizingProps {
2702
2738
  /**
2703
- * A valid API key for the map service provider.
2704
- *
2705
- * The map service provider may require an API key. Without an API key the map could be hidden or render in a limited developer mode.
2739
+ * A valid API key for the map service provider. This key is required to load and render the map tiles. Obtain a key from a supported provider such as [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key).
2706
2740
  */
2707
2741
  apiKey?: string;
2708
2742
  /**
2709
- * Map center’s latitude in degrees.
2743
+ * The latitude of the map's center point, in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).
2710
2744
  *
2711
2745
  * @default 0
2712
2746
  */
2713
2747
  latitude?: number;
2714
2748
  /**
2715
- * Map center’s longitude in degrees.
2749
+ * The longitude of the map's center point, in degrees. Valid values range from -180 (west) to 180 (east).
2716
2750
  *
2717
2751
  * @default 0
2718
2752
  */
2719
2753
  longitude?: number;
2720
2754
  /**
2721
- * A label that describes the purpose or contents of the map.
2722
- *
2723
- * When set, it will be announced to users using assistive technologies and will provide them with more context.
2755
+ * A label that describes the purpose or contents of the map for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the map displays.
2724
2756
  */
2725
2757
  accessibilityLabel?: string;
2726
2758
  /**
2727
- * The initial Map zoom level.
2728
- *
2729
- * Valid zoom values are numbers from zero up to 18.
2730
- * Larger zoom values correspond to a higher resolution.
2759
+ * The initial zoom level of the map. Valid values are numbers from 0 (fully zoomed out, world view) to 18 (fully zoomed in, street level).
2731
2760
  *
2732
2761
  * @default 4
2733
2762
  */
2734
2763
  zoom?: number;
2735
2764
  /**
2736
- * The maximum zoom level which will be displayed on the map.
2737
- *
2738
- * Valid zoom values are numbers from zero up to 18.
2765
+ * The maximum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming in beyond a useful level of detail.
2739
2766
  *
2740
2767
  * @default 18
2741
2768
  */
2742
2769
  maxZoom?: number;
2743
2770
  /**
2744
- * The minimum zoom level which will be displayed on the map.
2745
- *
2746
- * Valid zoom values are numbers from zero up to 18.
2771
+ * The minimum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming out beyond a useful level of context.
2747
2772
  *
2748
2773
  * @default 0
2749
2774
  */
2750
2775
  minZoom?: number;
2751
2776
  /**
2752
- * Callback when the viewport bounds have changed or the map is resized.
2777
+ * A callback fired when the visible map boundaries change, such as after a pan or zoom completes.
2753
2778
  */
2754
2779
  onBoundsChange?: (event: MapBoundsChangeEvent) => void;
2755
2780
  /**
2756
- * Callback when the map view changes.
2781
+ * A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level.
2757
2782
  */
2758
2783
  onViewChange?: (event: MapViewChangeEvent) => void;
2759
2784
  /**
2760
- * Callback when the user clicks on the map.
2785
+ * A callback fired when the user clicks on the map. Provides the geographic location of the click.
2761
2786
  */
2762
2787
  onClick?: (event: MapClickEvent) => void;
2763
2788
  /**
2764
- * Callback when the user double-clicks on the map.
2789
+ * A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click.
2765
2790
  */
2766
2791
  onDblClick?: (event: MapDblClickEvent) => void;
2767
2792
  }
2793
+ /**
2794
+ * A geographic coordinate pair representing a location on the map, defined by latitude and longitude values.
2795
+ */
2768
2796
  interface Location$1 {
2797
+ /**
2798
+ * The latitude of the location in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).
2799
+ */
2769
2800
  latitude?: number;
2801
+ /**
2802
+ * The longitude of the location in degrees. Valid values range from -180 (west) to 180 (east).
2803
+ */
2770
2804
  longitude?: number;
2771
2805
  }
2806
+ /**
2807
+ * The geographic boundaries of a visible map area, defined by its north-east and south-west corners. Used by `MapBoundsChangeEvent` to report the currently visible map region.
2808
+ */
2772
2809
  export interface Bounds {
2810
+ /**
2811
+ * The north-east corner of the bounded area, representing the top-right of the visible map region.
2812
+ */
2773
2813
  northEast?: Location$1;
2814
+ /**
2815
+ * The south-west corner of the bounded area, representing the bottom-left of the visible map region.
2816
+ */
2774
2817
  southWest?: Location$1;
2775
2818
  }
2819
+ /**
2820
+ * The event data provided when the map view changes, such as after the user pans or zooms. Contains the new center location and zoom level.
2821
+ */
2776
2822
  export interface MapViewChangeEvent extends Event {
2823
+ /**
2824
+ * The geographic location of the new map center after the view change.
2825
+ */
2777
2826
  location?: Location$1;
2827
+ /**
2828
+ * The current zoom level of the map after the view change, as a number from 0 (world view) to 18 (street level).
2829
+ */
2778
2830
  zoom?: number;
2779
2831
  }
2832
+ /**
2833
+ * The event data provided when the visible map boundaries change, such as after a pan or zoom completes. Contains the new geographic bounds of the visible area.
2834
+ */
2780
2835
  export interface MapBoundsChangeEvent extends Event {
2836
+ /**
2837
+ * The geographic boundaries of the currently visible map area, defined by its north-east and south-west corners.
2838
+ */
2781
2839
  bounds?: Bounds;
2782
2840
  }
2841
+ /**
2842
+ * The event data provided when the user clicks on the map. Contains the geographic location of the click.
2843
+ */
2783
2844
  export interface MapClickEvent extends Event {
2845
+ /**
2846
+ * The geographic location on the map where the click occurred, as a latitude/longitude coordinate pair.
2847
+ */
2784
2848
  location?: Location$1;
2785
2849
  }
2850
+ /**
2851
+ * The event data provided when the user double-clicks on the map. Contains the geographic location of the double-click.
2852
+ */
2786
2853
  export interface MapDblClickEvent extends Event {
2854
+ /**
2855
+ * The geographic location on the map where the double-click occurred, as a latitude/longitude coordinate pair.
2856
+ */
2787
2857
  location?: Location$1;
2788
2858
  }
2789
2859
  interface MapMarkerProps$1 extends GlobalProps, InteractionProps, Pick<SizingProps, "blockSize" | "inlineSize"> {
2790
2860
  /**
2791
- * Marker’s location latitude in degrees.
2861
+ * The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).
2792
2862
  *
2793
2863
  * @default 0
2794
2864
  */
2795
2865
  latitude?: number;
2796
2866
  /**
2797
- * Marker’s longitude latitude in degrees.
2867
+ * The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).
2798
2868
  *
2799
2869
  * @default 0
2800
2870
  */
2801
2871
  longitude?: number;
2802
2872
  /**
2803
- * A label that describes the purpose of the marker. When set,
2804
- * it will be announced to users using assistive technologies and will
2805
- * provide them with more context.
2873
+ * A label that describes the purpose or location of the marker for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the marker represents.
2806
2874
  */
2807
2875
  accessibilityLabel?: string;
2808
2876
  /**
2809
- * Allows grouping the marker in clusters when zoomed out.
2877
+ * Whether the marker can be grouped into clusters when the map is zoomed out. Clustering helps reduce visual clutter when many markers are close together at low zoom levels.
2810
2878
  *
2811
2879
  * @default false
2812
2880
  */
2813
2881
  clusterable?: boolean;
2814
2882
  /**
2815
- * The graphic to use as the marker.
2816
- *
2817
- * If unset, it will default to the provider’s default marker.
2883
+ * A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed.
2818
2884
  */
2819
2885
  graphic?: ComponentChildren;
2820
2886
  /**
2821
- * Callback when a marker is clicked.
2822
- *
2823
- * It does not trigger a click event on the map itself.
2887
+ * A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.
2824
2888
  */
2825
2889
  onClick?: (event: Event) => void;
2826
2890
  }
2827
2891
  interface ModalProps$1 extends GlobalProps, BaseOverlayProps, BaseOverlayMethods, ActionSlots {
2828
2892
  /**
2829
- * A label that describes the purpose of the modal. When set,
2830
- * it will be announced to users using assistive technologies and will
2831
- * provide them with more context.
2832
- *
2833
- * This overrides the `heading` prop for screen readers.
2893
+ * A label that describes the purpose of the modal, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the modal.
2834
2894
  */
2835
2895
  accessibilityLabel?: string;
2836
2896
  /**
2837
- * A title that describes the content of the Modal.
2838
- *
2897
+ * A title that describes the content of the modal.
2839
2898
  */
2840
2899
  heading?: string;
2841
2900
  /**
2842
- * Adjust the padding around the Modal content.
2901
+ * Adjust the padding around the modal content.
2843
2902
  *
2844
- * `base`: applies padding that is appropriate for the element.
2845
- *
2846
- * `none`: removes all padding from the element. This can be useful when elements inside the Modal need to span
2847
- * to the edge of the Modal. For example, a full-width image. In this case, rely on `Box` with a padding of 'base'
2848
- * to bring back the desired padding for the rest of the content.
2903
+ * - `base`: Applies padding that is appropriate for the element.
2904
+ * - `none`: Removes all padding from the element. This can be useful when elements inside the modal need to span to the edge of the modal. For example, a full-width image. In this case, rely on box with a padding of `base` to bring back the desired padding for the rest of the content.
2849
2905
  *
2850
2906
  * @default 'base'
2851
2907
  */
2852
2908
  padding?: "base" | "none";
2853
2909
  /**
2854
- * Adjust the size of the Modal.
2910
+ * Adjust the size of the modal.
2855
2911
  *
2856
- * `max`: expands the Modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.
2912
+ * `max`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.
2857
2913
  *
2858
2914
  * @default 'base'
2859
2915
  */
2860
2916
  size?: SizeKeyword | "max";
2861
2917
  /**
2862
- * The content of the Modal.
2918
+ * The content of the modal.
2863
2919
  */
2864
2920
  children?: ComponentChildren;
2865
2921
  }
@@ -2868,9 +2924,13 @@ interface MoneyFieldProps$1 extends GlobalProps, BaseTextFieldProps, NumberConst
2868
2924
  export type MoneyAutocompleteField = ExtractStrict<AnyAutocompleteField, "transaction-amount">;
2869
2925
  interface NumberFieldProps$1 extends GlobalProps, BaseTextFieldProps, AutocompleteProps<NumberAutocompleteField>, NumberConstraintsProps, FieldDecorationProps {
2870
2926
  /**
2871
- * Sets the virtual keyboard.
2927
+ * Sets the virtual keyboard layout for the field.
2928
+ *
2929
+ * - `'decimal'`: A numeric keyboard with a decimal point, suitable for decimal numbers.
2930
+ * - `'numeric'`: A numeric keyboard without a decimal point, suitable for integers.
2931
+ *
2932
+ * Learn more about the [inputMode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).
2872
2933
  *
2873
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
2874
2934
  * @default 'decimal'
2875
2935
  */
2876
2936
  inputMode?: "decimal" | "numeric";
@@ -2919,26 +2979,28 @@ export type ParagraphType =
2919
2979
  interface PasswordFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps<PasswordAutocompleteField> {
2920
2980
  }
2921
2981
  export type PasswordAutocompleteField = ExtractStrict<AnyAutocompleteField, "new-password" | "current-password">;
2982
+ /**
2983
+ * The shared properties for the payment icon component. A payment icon displays a recognizable icon for a payment method, such as Visa, Mastercard, or PayPal.
2984
+ */
2922
2985
  interface PaymentIconProps$1 extends GlobalProps {
2923
2986
  /**
2924
- * The icon type of the payment method
2987
+ * The payment method to display. Specify a payment method name from the available set (for example, `'visa'`, `'mastercard'`, or `'paypal'`), or use an empty string to show no icon.
2925
2988
  *
2926
2989
  * @default ''
2927
2990
  */
2928
2991
  type?: PaymentIconName | AnyString;
2929
2992
  /**
2930
- * A label that describes the purpose or contents of the icon.
2931
- *
2932
- * When set, it will be announced to users using assistive technologies and will provide them with more context.
2933
- * This should only be used if the icon requires an alternative internationalised label
2934
- * or if it is otherwise inappropriate to make use of the default label included with the icon.
2993
+ * A label that describes the payment icon for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about which payment method the icon represents.
2935
2994
  */
2936
2995
  accessibilityLabel?: string;
2937
2996
  }
2997
+ /**
2998
+ * The recognized payment method identifiers used by the `PaymentIcon` component. Each value maps to a branded icon for a specific payment provider, card network, digital wallet, or buy-now-pay-later service. Pass one of these names as the `type` property of `PaymentIcon` to display the corresponding icon — for example, `"visa"`, `"apple-pay"`, or `"afterpay"`.
2999
+ */
2938
3000
  export type PaymentIconName = "abn" | "acima-leasing" | "acuotaz" | "ada" | "addi" | "adyen" | "aeropay" | "affin-bank" | "affirm" | "aftee" | "afterpay-paynl-version" | "afterpay" | "airtel-money" | "airteltigo-mobile-money" | "aktia" | "akulaku-paylater" | "akulaku" | "alandsbanken" | "alfamart" | "alfamidi" | "alipay-hk" | "alipay-paynl-version" | "alipay" | "alliance-bank" | "alma" | "aman" | "amazon" | "ambank" | "american-express" | "amex" | "ansa-stored-value" | "ansa" | "anyday" | "apecoin" | "aplazo" | "apple-pay" | "aqsat" | "arbitrum" | "arhaus" | "arvato" | "ashley-plcc" | "ask" | "astrapay" | "atm-bersama" | "atobaraidotcom" | "atome" | "atone" | "atrato" | "au-kantan-kessai" | "au-pay" | "authorize-net" | "avalanche" | "axs" | "bancnet" | "banco-azteca" | "bancomat" | "bancontact" | "bangkok-bank" | "bank-islam" | "bank-muamalat" | "bank-rakyat" | "barclays" | "base" | "bbva-cie" | "bc-card" | "bca-klikpay" | "bca" | "bdo" | "belfius" | "benefit" | "best-buy-card" | "biercheque-paynl-version" | "bigc" | "billease" | "biller-paynl-version" | "billie" | "billink-method" | "billink" | "bitcoin-cash" | "bitcoin" | "bizum" | "blik" | "bnbchain" | "bni" | "bnp" | "bogus-app-coin" | "bogus" | "boleto" | "boodil" | "boost" | "bpi" | "braintree" | "bread-pay" | "bread" | "bri-direct-debit" | "bri" | "brimo" | "bsi" | "bsn" | "bss" | "busd" | "careem-pay" | "cartes-bancaires" | "cash-app-pay" | "cash" | "cashew" | "cashinvoice-latin-america" | "catch-payments" | "cebuana" | "cembrapay" | "centi" | "cetelem" | "checkout-finance" | "chinabank" | "cimb-clicks" | "cimb" | "circle-k" | "citadele" | "citi-pay" | "clave-telered" | "clearpay" | "clerq" | "cleverpay" | "clip" | "cliq" | "codensa" | "coinsph" | "collector-bank" | "coop" | "coppel-pay" | "credit-agricole" | "credit-key" | "creditclick-paynl-version" | "credix" | "cuotas" | "d-barai" | "dai" | "daily-yamazaki" | "dan-dan" | "dana" | "danamon-online" | "dankort" | "danske-bank" | "dappmx" | "dash" | "daviplata" | "de-cadeaukaart" | "depay" | "deutsche-bank" | "dinacard" | "diners-club" | "direct-bank-transfer-latin-america" | "directa24" | "directpay" | "discover" | "divido" | "dnb" | "docomo-barai" | "dogecoin" | "dropp" | "duitnow" | "duologi" | "dwolla" | "easywallet" | "ebucks" | "echelon-financing" | "ecpay" | "edenred" | "efecty" | "eft-secure" | "eftpos-au" | "eghl" | "elo" | "elv" | "empty" | "enets" | "eos" | "epayments" | "epospay" | "eps" | "erste" | "escrowcom" | "esr-paymentslip-switzerland" | "ethereum" | "etihad-guest-pay" | "etika" | "ewallet-indonesia" | "ewallet-philippines" | "ewallet-southkorea" | "facebook-pay" | "fairstone-payments" | "fam" | "familymart" | "fantom" | "farmlands" | "fashion-giftcard-paynlversion" | "fashioncheque" | "favepay" | "fawry" | "finloup" | "fintecture" | "fintoc" | "flexiti" | "float-payments" | "flying-blue-plus" | "forbrugsforeningen" | "forsa" | "fortiva" | "fps" | "fpx" | "freecharge" | "freedompay" | "futurepay-mytab" | "gcash" | "generalfinancing" | "generic" | "genoapay" | "gezondheidsbon-paynl-version" | "giftcard" | "giropay" | "givacard" | "glbe-paypal" | "glbe-plus" | "gmo-atokara" | "gmo-bank-transfer" | "gmo-postpay" | "gmo-virtualaccount" | "gnosis" | "google-pay" | "google-wallet" | "gopay" | "grabpay" | "grailpay" | "gusd" | "hana-card" | "handelsbanken" | "happy-pay" | "hello-clever" | "heylight" | "hitrustpay-transfer" | "home-credit" | "hong-leong-bank" | "hong-leong-connect" | "hsbc" | "huis-tuin-cadeau" | "humm" | "hyper" | "hypercard" | "hypercash" | "hyundai-card" | "ibexpay" | "ideal" | "in3-via-ideal" | "in3" | "inbank" | "indomaret" | "ing-homepay" | "interac" | "ivy" | "iwocapay-pay-later" | "jcb" | "jenius" | "jko" | "jousto" | "kakao-pay" | "kakebaraidotcom" | "kasikornbank" | "kasssh" | "katapult" | "kb-card" | "kbc-cbc" | "kcp-credit-card" | "kfast" | "khqr" | "klarna-pay-later" | "klarna-pay-now" | "klarna-slice-it" | "klarna" | "knaken-settle" | "knet" | "koalafi" | "koin" | "krediidipank" | "kredivo" | "krungsri" | "krungthai-bank" | "kueski-pay" | "kunst-en-cultuur-cadeaukaart" | "kuwait-finance-house" | "land-bank" | "laser" | "latitude-creditline-au" | "latitude-gem-au" | "latitude-gem-nz" | "latitude-go-au" | "latitudepay" | "lawson" | "laybuy-heart" | "laybuy" | "lbc" | "lhv" | "line-pay" | "linkaja" | "linkpay" | "litecoin" | "lku" | "lloyds" | "lotte-card" | "lpb" | "luminor" | "lunch-check" | "lydia" | "mach" | "mada" | "maestro" | "mandiri" | "mash" | "master" | "mastercard" | "masterpass" | "maxima" | "maya-bank" | "maya" | "maybank-qrpay" | "maybank" | "maybankm2u" | "mb-way" | "mb" | "mcash" | "medicinos-bankas" | "meeza" | "mercado-credito" | "mercado-pago" | "merpay" | "meta-pay" | "metro-bank" | "military-starcard" | "minicuotas" | "ministop" | "mobicred" | "mobikwik" | "mobilepay" | "mode" | "mokka" | "momopay" | "mondido" | "monero" | "monzo" | "mpesa" | "mtn-mobile-money" | "multisafepay" | "mybank" | "myfatoorah" | "n26" | "naps" | "nationale-bioscoopbon" | "nationale-entertainmentcard" | "natwest" | "naver-pay" | "nelo" | "nequi" | "netbanking" | "neteller" | "nh-card" | "nordea" | "notyd" | "novuna" | "npatobarai" | "npkakebarai" | "oca" | "ocbc-bank" | "octo-clicks" | "octopus" | "offline-bank-transfer-latin-america" | "ola-money" | "omannet" | "omasp" | "oney" | "online-banking" | "online-banktransfer" | "op" | "opay" | "openpay" | "optimism" | "orange-mobile-money" | "overstock-citicobrand" | "overstock-citiplcc" | "ovo" | "oxxo" | "ozow" | "pagoefectivo" | "paid" | "paidy" | "palawa" | "palawan" | "pastpay" | "pay-after-delivery-instalments" | "pay-by-bank-us" | "pay-by-bank" | "pay-easy" | "pay-pay" | "paybylink" | "paycash" | "payco" | "payconiq" | "payd" | "payfast-instant-eft" | "payflex" | "payid" | "payitmonthly" | "payjustnow" | "paymark-online-eftpos" | "paymaya" | "payme" | "paynow-mbank" | "paynow" | "payoo-qr" | "payoo" | "paypal" | "payplan" | "paypo" | "payrexx-bank-transfer" | "payright" | "paysafecard-paynl-version" | "paysafecard" | "paysafecash" | "paysera" | "paysquad" | "paytm" | "payto" | "paytomorrow" | "payu" | "payzapp" | "pei" | "perlasfinance" | "permata" | "pf-pay" | "pivo" | "pix" | "podium-cadeaukaart" | "pointspay" | "poli" | "polygon" | "poppankki" | "postfinance-card" | "postfinance-efinance" | "postpay" | "powered-by-ansa-stored-value" | "powered-by-ansa" | "powerpay" | "pps" | "prepaysolutions" | "progressive-leasing" | "przelew24" | "przelewy24-paynl-version" | "przelewy24" | "pse" | "public-bank" | "publicbank-pbe" | "qasitli" | "qliro" | "qr-promptpay" | "qris" | "qrph" | "rabbit-line-pay" | "rabobank" | "rakuten-pay" | "rapid-transfer" | "ratepay" | "raty-pekao" | "rcbc" | "rcs" | "reka" | "resolve-pay" | "revolut" | "rhb-bank" | "rhb-now" | "rietumu" | "riverty-paynl-version" | "riverty" | "rupay" | "saastopankki" | "sadad" | "sam" | "samsung-card" | "samsung-pay" | "santander" | "satisfi" | "satispay" | "sbpl" | "scalapay" | "scream-truck-wallet" | "scream-truck" | "seb" | "seicomart" | "sepa-bank-transfer" | "sepa-direct-debit" | "sequra" | "seven-eleven" | "sezzle" | "shib" | "shinhan-card" | "shop-pay" | "shopeepay" | "shopify-pay" | "siam-commercial" | "siauliu-bankas" | "siirto" | "sika-fsa" | "sika-hsa" | "sika" | "simpl" | "simple-pay" | "sinpe-movil" | "sistecredito" | "skeps" | "skrill-digital-wallet" | "slice-fnbo" | "smartpay" | "snap-checkout" | "snapmint" | "societe-generale" | "sofort" | "softbank" | "solana-pay-helio" | "solana-pay" | "solana" | "souhoola" | "spankki" | "sparkasse" | "spei" | "splitit" | "spotii" | "spraypay" | "standard-chartered" | "stc-pay" | "stoov" | "store-credit" | "stripe" | "sunkus" | "super-payments" | "svea-b2b-faktura" | "svea-b2b-invoice" | "svea-checkout" | "svea-credit-account" | "svea-delbetalning" | "svea-faktura" | "svea-invoice" | "svea-lasku" | "svea-ostukonto" | "svea-part-payment" | "svea-yrityslasku" | "sveaeramaksu" | "swedbank" | "swiftpay" | "swish" | "swissbilling" | "sympl" | "synchrony-pay" | "synchrony" | "tabby" | "tabit" | "taly" | "tamara" | "tandympayment" | "tasa-cero" | "tbi-bank" | "tcf" | "tendopay" | "tensile" | "tesco-lotus" | "thanachart-bank" | "timepayment" | "tiptop" | "todopay" | "toss" | "touch-n-go" | "tpay" | "trevipay" | "truelayer" | "truemoney-pay" | "trustly" | "twig-pay" | "twint" | "twoinvoice" | "uae-visa" | "uangme" | "ubp" | "underpay" | "unionpay" | "unipay" | "uob-ez-pay" | "uob-thai" | "uob" | "upi" | "urbo" | "urpay" | "usdc" | "usdp" | "v-pay" | "valu" | "venmo" | "ventipay" | "venus-plcc" | "viabill" | "vipps" | "visa-electron" | "visa" | "volksbank" | "volt" | "vvv-cadeaukaart-paynl-version" | "vvv-giftcard" | "waave-pay-by-bank" | "wallet" | "walley" | "wbtc" | "webshop-giftcard" | "wechat-pay" | "wechat-paynl-version" | "wegetfinancing" | "whish-checkout" | "whish-pay" | "wise" | "wissel" | "world-chain" | "xrp" | "yape" | "yappy" | "ymobile" | "younited-pay" | "zalopay" | "zapper" | "zingala" | "zinia" | "zip" | "zoodpay" | "zulily-credit-card" | "zustaina";
2939
3001
  interface PopoverProps$1 extends GlobalProps, BaseOverlayProps, BaseOverlayMethods, ToggleEventProps, SizingProps {
2940
3002
  /**
2941
- * The content of the popover.
3003
+ * The content displayed within the popover, which appears in an overlay positioned relative to its trigger element.
2942
3004
  */
2943
3005
  children?: ComponentChildren;
2944
3006
  }
@@ -2958,178 +3020,150 @@ interface PressButtonProps$1 extends GlobalProps, Pick<ButtonProps$1, "accessibi
2958
3020
  */
2959
3021
  defaultPressed?: boolean;
2960
3022
  }
3023
+ /**
3024
+ * The shared properties for the product thumbnail component. A product thumbnail displays a small preview image representing a product. Properties include `src` for the image URL, `alt` for accessibility text, `size` for controlling the thumbnail dimensions, and `totalItems` for displaying a quantity badge.
3025
+ */
2961
3026
  interface ProductThumbnailProps$1 extends GlobalProps, BaseImageProps {
2962
3027
  /**
2963
- * Decorates the product thumbnail with the quantity of the product.
3028
+ * The total number of items that the product thumbnail represents. When this value exceeds 1, the component displays a badge showing the count, useful for representing bundled products or quantities.
2964
3029
  */
2965
3030
  totalItems?: number;
2966
3031
  /**
2967
- * Adjusts the size the product thumbnail image.
3032
+ * The size of the product thumbnail image.
3033
+ *
3034
+ * - `'base'`: Default size that works well in most contexts.
3035
+ * - `'small'`: Small thumbnail, good for secondary contexts or tight layouts.
3036
+ * - `'small-100'`: Extra small thumbnail for compact displays or dense lists.
2968
3037
  *
2969
3038
  * @default 'base'
2970
3039
  */
2971
3040
  size?: SizeKeyword;
2972
3041
  /**
2973
- * Invoked when load of provided image completes successfully.
2974
- *
2975
- * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
3042
+ * A callback fired when the product thumbnail image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload).
2976
3043
  */
2977
3044
  onLoad?: (event: Event) => void;
2978
3045
  /**
2979
- * Invoked on load error of provided image.
2980
- *
2981
- * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
3046
+ * A callback fired when the product thumbnail image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror).
2982
3047
  */
2983
3048
  onError?: (event: Event) => void;
2984
3049
  }
2985
3050
  interface ProgressProps$1 extends GlobalProps {
2986
3051
  /**
2987
- * A label that describes the purpose of the progress. When set,
2988
- * it will be announced to users using assistive technologies and will
2989
- * provide them with more context.
2990
- *
2991
- * Use it to provide context of what is progressing.
3052
+ * A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as "Loading order details" or "Uploading file".
2992
3053
  */
2993
3054
  accessibilityLabel?: string;
2994
3055
  /**
2995
- * Sets the tone of the progress, based on the intention of the information being conveyed.
3056
+ * The semantic meaning and color treatment of the progress indicator.
2996
3057
  *
2997
3058
  * @default 'auto'
2998
3059
  */
2999
3060
  tone?: ToneKeyword;
3000
3061
  /**
3001
- * Specifies how much of the task has been completed.
3002
- *
3003
- * It must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted.
3004
- * If there is no value attribute, the progress bar is indeterminate;
3005
- * this indicates that an activity is ongoing with no indication of how long it is expected to take.
3062
+ * How much of the task has been completed. Must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
3006
3063
  *
3007
- * @implementation Surfaces should apply styling to cover that indeterminate state.
3008
- * @implementation In a HTML host, you can customize the progress animation via the :indeterminate pseudo-class.
3009
- *
3010
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value
3011
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/:indeterminate#progress_bar
3064
+ * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
3012
3065
  */
3013
3066
  value?: number;
3014
3067
  /**
3015
- * This attribute describes how much work the task indicated by the progress element requires.
3068
+ * The total amount of work the task requires. Must be a value greater than 0 and a valid floating point number.
3016
3069
  *
3017
- * The `max` attribute, if present, must have a value greater than 0 and be a valid floating point number.
3070
+ * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).
3018
3071
  *
3019
3072
  * @default 1
3020
- *
3021
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max
3022
3073
  */
3023
3074
  max?: number;
3024
3075
  }
3076
+ /**
3077
+ * The shared properties for the QR code component. A QR code generates and displays a scannable matrix barcode from a given string. Properties include `content` for the data to encode, `size` for display dimensions, `border` for visual framing, and `logo` for branding.
3078
+ */
3025
3079
  interface QRCodeProps$1 extends GlobalProps {
3026
3080
  /**
3027
- * Set the border of the QR code.
3081
+ * Whether to display a border around the QR code.
3028
3082
  *
3029
- * `base`: applies border that is appropriate for the element.
3030
- * `none`: removes the border from the element.
3083
+ * - `'base'`: Applies a standard border to frame the QR code.
3084
+ * - `'none'`: Removes the border for seamless integration with the surrounding layout.
3031
3085
  *
3032
3086
  * @default 'base'
3033
3087
  */
3034
3088
  border?: "base" | "none";
3035
3089
  /**
3036
- * The content to be encoded in the QR code, which can be any string such as a URL, email address, plain text, etc.
3037
- * Specific string formatting can trigger actions on the user's device when scanned, like opening geolocation
3038
- * coordinates on a map, opening a preferred app or app store entry, preparing an email, text message, and more.
3090
+ * The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.
3039
3091
  */
3040
3092
  content?: string;
3041
3093
  /**
3042
3094
  * The displayed size of the QR code.
3043
3095
  *
3044
- * `fill`: the QR code will takes up 100% of the available inline-size and maintain a 1:1 aspect ratio.
3045
- * `base`: the QR code will be displayed at its default size.
3096
+ * - `'base'`: The QR code is displayed at its default fixed size.
3097
+ * - `'fill'`: The QR code takes up 100% of the available inline size, useful for responsive layouts.
3046
3098
  *
3047
3099
  * @default 'base'
3048
3100
  */
3049
3101
  size?: "base" | "fill";
3050
3102
  /**
3051
- * A label that describes the purpose or contents of the QR code. When set,
3052
- * it will be announced to users using assistive technologies and will
3053
- * provide more context about what the QR code may do when scanned.
3103
+ * A label that describes the purpose or contents of the QR code for accessibility. When set, it will be announced to users using assistive technologies such as screen readers.
3054
3104
  *
3055
3105
  * @default 'QR code' (translated to the user's locale)
3056
3106
  */
3057
3107
  accessibilityLabel?: string;
3058
3108
  /**
3059
- * Invoked when the conversion of `content` to a QR code fails.
3060
- * If an error occurs, the QR code and its child elements will not be displayed.
3109
+ * A callback fired when the conversion of `content` to a QR code fails. This can happen when the content is too long or contains unsupported characters.
3061
3110
  */
3062
3111
  onError?: (event: Event) => void;
3063
3112
  /**
3064
- * URL of an image to be displayed in the center of the QR code.
3065
- * This is useful for branding or to indicate to the user what scanning the QR code will do.
3066
- * By default, no image is displayed.
3113
+ * The URL of an image to display in the center of the QR code, typically used for branding. The image should be small enough not to interfere with the QR code's scannability.
3067
3114
  */
3068
3115
  logo?: string;
3069
3116
  }
3070
3117
  interface QueryContainerProps$1 extends GlobalProps {
3071
3118
  /**
3072
- * The content of the container.
3119
+ * The child elements to render inside the query container.
3073
3120
  */
3074
3121
  children?: ComponentChildren;
3075
3122
  /**
3076
- * The name of the container, which can be used in your container queries to target this container specifically.
3077
- *
3078
- * We place the container name of `s-default` on every container. Because of this, it is not required to add a `containerName` identifier in your queries. For example, a `@container (inline-size <= 300px) none, auto` query is equivalent to `@container s-default (inline-size <= 300px) none, auto`.
3079
- *
3080
- * Any value set in `containerName` will be set alongside alongside `s-default`. For example, `containerName="my-container-name"` will result in a value of `s-default my-container-name` set on the `container-name` CSS property of the rendered HTML.
3123
+ * A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.
3081
3124
  *
3082
3125
  * @default ''
3083
- *
3084
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/container-name
3085
- *
3086
- * @implementation You must always have a CSS `container-name` of `s-default` for this component.
3087
3126
  */
3088
3127
  containerName?: string;
3089
3128
  }
3129
+ /**
3130
+ * The overflow behavior for a scrollable container axis.
3131
+ *
3132
+ * - `auto`: Content that exceeds the container is clipped and becomes scrollable.
3133
+ * - `hidden`: Content that exceeds the container is clipped and not scrollable.
3134
+ */
3090
3135
  export type OverflowKeyword = "auto" | "hidden";
3091
3136
  interface ScrollBoxProps$1 extends GlobalProps, Omit<BaseBoxPropsWithRole, "overflow"> {
3092
3137
  /**
3093
- * Sets the overflow behavior of the element.
3094
- *
3095
- * - `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.
3096
- * - `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.
3138
+ * The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).
3097
3139
  *
3098
- * 1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:
3140
+ * - `hidden`: Content is clipped and the element is not scrollable in that axis.
3141
+ * - `auto`: Content is clipped and becomes scrollable in that axis.
3099
3142
  *
3100
- * - 2 values: `block inline`
3143
+ * Supports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).
3101
3144
  *
3102
3145
  * @default 'auto'
3103
- *
3104
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/overflow
3105
3146
  */
3106
3147
  overflow?: OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`;
3107
3148
  }
3108
3149
  interface SectionProps$1 extends GlobalProps, ActionSlots {
3109
3150
  /**
3110
- * The content of the Section.
3151
+ * The child elements to render inside the section, typically the main content area below the heading.
3111
3152
  */
3112
3153
  children?: ComponentChildren;
3113
3154
  /**
3114
- * A label used to describe the section that will be announced by assistive technologies.
3115
- *
3116
- * When no `heading` property is provided or included as a children of the Section, you **must** provide an
3117
- * `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide
3118
- * the right context to users.
3155
+ * A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.
3119
3156
  */
3120
3157
  accessibilityLabel?: string;
3121
3158
  /**
3122
- * A title that describes the content of the section.
3159
+ * The heading text displayed at the top of the section to summarize its content.
3123
3160
  */
3124
3161
  heading?: string;
3125
3162
  /**
3126
- * Adjust the padding of all edges.
3163
+ * The padding applied to all edges of the section.
3127
3164
  *
3128
- * - `base`: applies padding that is appropriate for the element. Note that it may result in no padding if
3129
- * this is the right design decision in a particular context.
3130
- * - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span
3131
- * to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base'
3132
- * to bring back the desired padding for the rest of the content.
3165
+ * - `base`: Applies context-appropriate padding. In some contexts this may result in no visible padding.
3166
+ * - `none`: Removes all padding, allowing child elements to span the full width of the section. Use a Box with `base` padding to restore spacing for individual content areas.
3133
3167
  *
3134
3168
  * @default 'base'
3135
3169
  */
@@ -3145,28 +3179,15 @@ interface SelectProps$1 extends GlobalProps, AutocompleteProps<AnyAutocompleteFi
3145
3179
  }
3146
3180
  interface SheetProps$1 extends BaseOverlayProps, BaseOverlayMethods, ToggleEventProps, GlobalProps, ActionSlots {
3147
3181
  /**
3148
- * A label that describes the purpose of the sheet. When set,
3149
- * it will be announced to users using assistive technologies and will
3150
- * provide them with more context.
3151
- *
3152
- * This overrides the `heading` prop for screen readers.
3182
+ * A label that describes the purpose of the sheet, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the sheet.
3153
3183
  */
3154
3184
  accessibilityLabel?: string;
3155
3185
  /**
3156
- * The content of the Sheet.
3186
+ * The content of the sheet.
3157
3187
  */
3158
3188
  children?: ComponentChildren;
3159
3189
  /**
3160
- * Indicates whether the Sheet should be open by default.
3161
- * This property is necessary in some cases, but its usage is generally discouraged due to potential negative impacts on user experience.
3162
- *
3163
- * Developers should:
3164
- * - Only set this property to true when there are vitally important behaviors of the application that depend on the user interacting with the sheet.
3165
- * - Make every effort to conditionally hide the sheet based on the state of checkout. An explicit example is custom privacy consent, where the sheet should only be displayed when consent is necessary and has not yet been explicitly given by the user.
3166
- *
3167
- * This property is useful for when the Sheet needs to be rendered on the page load and not triggered by a user action.
3168
- * The property should only take effect when the `Sheet` is rendered for the first time.
3169
- * To toggle the Sheet after it has been rendered, use the `ui.showOverlay()` method instead.
3190
+ * Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.
3170
3191
  *
3171
3192
  * @default false
3172
3193
  */
@@ -3178,12 +3199,8 @@ interface SheetProps$1 extends BaseOverlayProps, BaseOverlayMethods, ToggleEvent
3178
3199
  /**
3179
3200
  * Adjust the padding of all edges.
3180
3201
  *
3181
- * `base`: applies padding that is appropriate for the element. Note that it may result in no padding if Shopify
3182
- * believes this is the right design decision in a particular context.
3183
- *
3184
- * `none`: removes all padding from the element. This can be useful when elements inside the Sheet need to span
3185
- * to the edge of the Sheet. For example, a full-width image. In this case, rely on `Box` with a padding of 'base'
3186
- * to bring back the desired padding for the rest of the content.
3202
+ * - `base`: Applies padding that is appropriate for the element. Note that it may result in no padding if Shopify believes this is the right design decision in a particular context.
3203
+ * - `none`: Removes all padding from the element. This can be useful when elements inside the sheet need to span to the edge of the sheet. For example, a full-width image. In this case, rely on box with a padding of `base` to bring back the desired padding for the rest of the content.
3187
3204
  *
3188
3205
  * @default 'base'
3189
3206
  */
@@ -3205,51 +3222,45 @@ interface SkeletonParagraphProps$1 extends GlobalProps {
3205
3222
  }
3206
3223
  interface SpinnerProps$1 extends GlobalProps {
3207
3224
  /**
3208
- * Adjusts the size of the spinner icon.
3225
+ * The size of the spinner icon.
3209
3226
  *
3210
3227
  * @default 'base'
3211
3228
  */
3212
3229
  size?: SizeKeyword;
3213
3230
  /**
3214
- * A label that describes the purpose of the progress. When set,
3215
- * it will be announced to users using assistive technologies and will
3216
- * provide them with more context. Providing an `accessibilityLabel` is
3217
- * recommended if there is no accompanying text describing that something
3218
- * is loading.
3231
+ * A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.
3219
3232
  */
3220
3233
  accessibilityLabel?: string;
3221
3234
  }
3222
3235
  interface StackProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
3223
3236
  /**
3224
- * The content of the Stack.
3237
+ * The child elements to render inside the stack.
3225
3238
  */
3226
3239
  children?: ComponentChildren;
3227
3240
  /**
3228
- * Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
3241
+ * The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
3229
3242
  *
3230
- * @default 'block'
3243
+ * - `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.
3244
+ * - `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.
3231
3245
  *
3232
- * @implementation the content will wrap if the direction is 'inline', and not wrap if the direction is 'block'
3246
+ * @default 'block'
3233
3247
  */
3234
3248
  direction?: MaybeResponsive<"block" | "inline">;
3235
3249
  /**
3236
- * Aligns the Stack along the main axis.
3250
+ * Controls how child elements are distributed along the main axis. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
3237
3251
  *
3238
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
3239
3252
  * @default 'normal'
3240
3253
  */
3241
3254
  justifyContent?: MaybeResponsive<JustifyContentKeyword>;
3242
3255
  /**
3243
- * Aligns the Stack's children along the cross axis.
3256
+ * Controls how child elements are aligned along the cross axis. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
3244
3257
  *
3245
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
3246
3258
  * @default 'normal'
3247
3259
  */
3248
3260
  alignItems?: MaybeResponsive<AlignItemsKeyword>;
3249
3261
  /**
3250
- * Aligns the Stack along the cross axis.
3262
+ * Controls how lines of content are distributed along the cross axis when there is extra space. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
3251
3263
  *
3252
- * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
3253
3264
  * @default 'normal'
3254
3265
  */
3255
3266
  alignContent?: MaybeResponsive<AlignContentKeyword>;
@@ -3396,7 +3407,7 @@ interface TimeProps$1 extends GlobalProps {
3396
3407
  }
3397
3408
  interface TooltipProps$1 extends GlobalProps {
3398
3409
  /**
3399
- * The content of the Tooltip.
3410
+ * The text or elements displayed inside the tooltip popup.
3400
3411
  */
3401
3412
  children?: ComponentChildren;
3402
3413
  }