@shopify/ui-extensions 2026.7.4 → 2026.10.0-rc.10

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 (329) hide show
  1. package/build/cjs/surfaces/checkout/preact/market.js +8 -2
  2. package/build/cjs/surfaces/checkout/shared.js +0 -2
  3. package/build/cjs/surfaces/customer-account/preact/market.js +8 -2
  4. package/build/cjs/surfaces/point-of-sale/events.js +129 -1
  5. package/build/cjs/surfaces/point-of-sale/types/storage.js +11 -0
  6. package/build/cjs/surfaces/point-of-sale.js +1 -0
  7. package/build/esm/surfaces/checkout/preact/market.mjs +8 -2
  8. package/build/esm/surfaces/checkout/shared.mjs +0 -2
  9. package/build/esm/surfaces/customer-account/preact/market.mjs +8 -2
  10. package/build/esm/surfaces/point-of-sale/events.mjs +129 -2
  11. package/build/esm/surfaces/point-of-sale/types/storage.mjs +11 -0
  12. package/build/esm/surfaces/point-of-sale.mjs +1 -1
  13. package/build/esnext/surfaces/checkout/preact/market.esnext +8 -2
  14. package/build/esnext/surfaces/checkout/shared.esnext +0 -2
  15. package/build/esnext/surfaces/customer-account/preact/market.esnext +8 -2
  16. package/build/esnext/surfaces/point-of-sale/events.esnext +129 -2
  17. package/build/esnext/surfaces/point-of-sale/types/storage.esnext +11 -0
  18. package/build/esnext/surfaces/point-of-sale.esnext +1 -1
  19. package/build/ts/shared.d.ts +2 -2
  20. package/build/ts/shared.d.ts.map +1 -1
  21. package/build/ts/surfaces/admin/components/AdminAction.d.ts +61 -107
  22. package/build/ts/surfaces/admin/components/AdminBlock.d.ts +22 -107
  23. package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +20 -101
  24. package/build/ts/surfaces/admin/components/AppNav.d.ts +38 -1
  25. package/build/ts/surfaces/admin/components/Avatar.d.ts +100 -139
  26. package/build/ts/surfaces/admin/components/Badge.d.ts +107 -156
  27. package/build/ts/surfaces/admin/components/Banner.d.ts +102 -127
  28. package/build/ts/surfaces/admin/components/Box.d.ts +145 -234
  29. package/build/ts/surfaces/admin/components/Button.d.ts +156 -266
  30. package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +89 -117
  31. package/build/ts/surfaces/admin/components/Checkbox.d.ts +139 -174
  32. package/build/ts/surfaces/admin/components/Chip.d.ts +117 -15
  33. package/build/ts/surfaces/admin/components/Choice.d.ts +88 -113
  34. package/build/ts/surfaces/admin/components/ChoiceList.d.ts +120 -129
  35. package/build/ts/surfaces/admin/components/Clickable.d.ts +227 -209
  36. package/build/ts/surfaces/admin/components/ClickableChip.d.ts +117 -153
  37. package/build/ts/surfaces/admin/components/ColorField.d.ts +111 -215
  38. package/build/ts/surfaces/admin/components/ColorPicker.d.ts +82 -137
  39. package/build/ts/surfaces/admin/components/DateField.d.ts +140 -230
  40. package/build/ts/surfaces/admin/components/DatePicker.d.ts +178 -181
  41. package/build/ts/surfaces/admin/components/Divider.d.ts +50 -118
  42. package/build/ts/surfaces/admin/components/DropZone.d.ts +153 -12
  43. package/build/ts/surfaces/admin/components/EmailField.d.ts +100 -197
  44. package/build/ts/surfaces/admin/components/EmptyState.d.ts +144 -0
  45. package/build/ts/surfaces/admin/components/Form.d.ts +25 -118
  46. package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +26 -132
  47. package/build/ts/surfaces/admin/components/Grid.d.ts +165 -299
  48. package/build/ts/surfaces/admin/components/GridItem.d.ts +145 -261
  49. package/build/ts/surfaces/admin/components/Heading.d.ts +117 -117
  50. package/build/ts/surfaces/admin/components/Icon.d.ts +91 -129
  51. package/build/ts/surfaces/admin/components/Image.d.ts +216 -251
  52. package/build/ts/surfaces/admin/components/Link.d.ts +125 -126
  53. package/build/ts/surfaces/admin/components/ListItem.d.ts +63 -102
  54. package/build/ts/surfaces/admin/components/Menu.d.ts +82 -150
  55. package/build/ts/surfaces/admin/components/Modal.d.ts +232 -26
  56. package/build/ts/surfaces/admin/components/MoneyField.d.ts +103 -196
  57. package/build/ts/surfaces/admin/components/Number.d.ts +193 -0
  58. package/build/ts/surfaces/admin/components/NumberField.d.ts +114 -208
  59. package/build/ts/surfaces/admin/components/Option.d.ts +67 -108
  60. package/build/ts/surfaces/admin/components/OptionGroup.d.ts +69 -105
  61. package/build/ts/surfaces/admin/components/OrderedList.d.ts +56 -102
  62. package/build/ts/surfaces/admin/components/Page.d.ts +93 -13
  63. package/build/ts/surfaces/admin/components/Paragraph.d.ts +126 -138
  64. package/build/ts/surfaces/admin/components/PasswordField.d.ts +109 -203
  65. package/build/ts/surfaces/admin/components/Popover.d.ts +673 -0
  66. package/build/ts/surfaces/admin/components/Progress.d.ts +155 -0
  67. package/build/ts/surfaces/admin/components/QueryContainer.d.ts +77 -116
  68. package/build/ts/surfaces/admin/components/SearchField.d.ts +103 -191
  69. package/build/ts/surfaces/admin/components/Section.d.ts +132 -128
  70. package/build/ts/surfaces/admin/components/Select.d.ts +144 -193
  71. package/build/ts/surfaces/admin/components/Spinner.d.ts +60 -113
  72. package/build/ts/surfaces/admin/components/Stack.d.ts +156 -282
  73. package/build/ts/surfaces/admin/components/StandardComponents.d.ts +1 -1
  74. package/build/ts/surfaces/admin/components/StandardComponents.d.ts.map +1 -1
  75. package/build/ts/surfaces/admin/components/Switch.d.ts +75 -165
  76. package/build/ts/surfaces/admin/components/Table.d.ts +100 -210
  77. package/build/ts/surfaces/admin/components/TableBody.d.ts +70 -106
  78. package/build/ts/surfaces/admin/components/TableCell.d.ts +70 -107
  79. package/build/ts/surfaces/admin/components/TableHeader.d.ts +79 -119
  80. package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +71 -107
  81. package/build/ts/surfaces/admin/components/TableRow.d.ts +81 -109
  82. package/build/ts/surfaces/admin/components/Text.d.ts +123 -164
  83. package/build/ts/surfaces/admin/components/TextArea.d.ts +100 -195
  84. package/build/ts/surfaces/admin/components/TextField.d.ts +120 -204
  85. package/build/ts/surfaces/admin/components/Thumbnail.d.ts +83 -133
  86. package/build/ts/surfaces/admin/components/Tooltip.d.ts +78 -146
  87. package/build/ts/surfaces/admin/components/URLField.d.ts +107 -209
  88. package/build/ts/surfaces/admin/components/UnorderedList.d.ts +58 -110
  89. package/build/ts/surfaces/admin/components/shared.d.ts +4193 -1203
  90. package/build/ts/surfaces/admin/extension-targets.d.ts +8 -0
  91. package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
  92. package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.action.render.d.ts +2 -0
  93. package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.block.render.d.ts +2 -0
  94. package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-index.action.render.d.ts +2 -0
  95. package/build/ts/surfaces/admin/targets/admin.app.home.render.d.ts +2 -0
  96. package/build/ts/surfaces/admin/targets/admin.app.intent.render.d.ts +2 -0
  97. package/build/ts/surfaces/admin/targets/admin.catalog-details.action.render.d.ts +2 -0
  98. package/build/ts/surfaces/admin/targets/admin.catalog-details.block.render.d.ts +2 -0
  99. package/build/ts/surfaces/admin/targets/admin.collection-details.action.render.d.ts +2 -0
  100. package/build/ts/surfaces/admin/targets/admin.collection-details.block.render.d.ts +2 -0
  101. package/build/ts/surfaces/admin/targets/admin.collection-index.action.render.d.ts +2 -0
  102. package/build/ts/surfaces/admin/targets/admin.company-details.action.render.d.ts +2 -0
  103. package/build/ts/surfaces/admin/targets/admin.company-details.block.render.d.ts +2 -0
  104. package/build/ts/surfaces/admin/targets/admin.company-location-details.block.render.d.ts +2 -0
  105. package/build/ts/surfaces/admin/targets/admin.customer-details.action.render.d.ts +2 -0
  106. package/build/ts/surfaces/admin/targets/admin.customer-details.block.render.d.ts +2 -0
  107. package/build/ts/surfaces/admin/targets/admin.customer-index.action.render.d.ts +2 -0
  108. package/build/ts/surfaces/admin/targets/admin.customer-index.selection-action.render.d.ts +2 -0
  109. package/build/ts/surfaces/admin/targets/admin.customer-segment-details.action.render.d.ts +2 -0
  110. package/build/ts/surfaces/admin/targets/admin.discount-details.action.render.d.ts +2 -0
  111. package/build/ts/surfaces/admin/targets/admin.discount-details.function-settings.render.d.ts +2 -0
  112. package/build/ts/surfaces/admin/targets/admin.discount-index.action.render.d.ts +2 -0
  113. package/build/ts/surfaces/admin/targets/admin.discount-index.selection-action.render.d.ts +2 -0
  114. package/build/ts/surfaces/admin/targets/admin.draft-order-details.action.render.d.ts +2 -0
  115. package/build/ts/surfaces/admin/targets/admin.draft-order-details.block.render.d.ts +2 -0
  116. package/build/ts/surfaces/admin/targets/admin.draft-order-index.action.render.d.ts +2 -0
  117. package/build/ts/surfaces/admin/targets/admin.draft-order-index.selection-action.render.d.ts +2 -0
  118. package/build/ts/surfaces/admin/targets/admin.gift-card-details.action.render.d.ts +2 -0
  119. package/build/ts/surfaces/admin/targets/admin.gift-card-details.block.render.d.ts +2 -0
  120. package/build/ts/surfaces/admin/targets/admin.order-details.action.render.d.ts +2 -0
  121. package/build/ts/surfaces/admin/targets/admin.order-details.block.render.d.ts +2 -0
  122. package/build/ts/surfaces/admin/targets/admin.order-details.print-action.render.d.ts +2 -0
  123. package/build/ts/surfaces/admin/targets/admin.order-fulfilled-card.action.render.d.ts +2 -0
  124. package/build/ts/surfaces/admin/targets/admin.order-index.action.render.d.ts +2 -0
  125. package/build/ts/surfaces/admin/targets/admin.order-index.selection-action.render.d.ts +2 -0
  126. package/build/ts/surfaces/admin/targets/admin.order-index.selection-print-action.render.d.ts +2 -0
  127. package/build/ts/surfaces/admin/targets/admin.product-details.action.render.d.ts +2 -0
  128. package/build/ts/surfaces/admin/targets/admin.product-details.block.render.d.ts +2 -0
  129. package/build/ts/surfaces/admin/targets/admin.product-details.configuration.render.d.ts +2 -0
  130. package/build/ts/surfaces/admin/targets/admin.product-details.configuration.should-render.d.ts +6 -0
  131. package/build/ts/surfaces/admin/targets/admin.product-details.print-action.render.d.ts +2 -0
  132. package/build/ts/surfaces/admin/targets/admin.product-details.reorder.render.d.ts +2 -0
  133. package/build/ts/surfaces/admin/targets/admin.product-index.action.render.d.ts +2 -0
  134. package/build/ts/surfaces/admin/targets/admin.product-index.selection-action.render.d.ts +2 -0
  135. package/build/ts/surfaces/admin/targets/admin.product-index.selection-print-action.render.d.ts +2 -0
  136. package/build/ts/surfaces/admin/targets/admin.product-purchase-option.action.render.d.ts +2 -0
  137. package/build/ts/surfaces/admin/targets/admin.product-variant-details.action.render.d.ts +2 -0
  138. package/build/ts/surfaces/admin/targets/admin.product-variant-details.block.render.d.ts +2 -0
  139. package/build/ts/surfaces/admin/targets/admin.product-variant-details.configuration.render.d.ts +2 -0
  140. package/build/ts/surfaces/admin/targets/admin.product-variant-details.configuration.should-render.d.ts +6 -0
  141. package/build/ts/surfaces/admin/targets/admin.product-variant-purchase-option.action.render.d.ts +2 -0
  142. package/build/ts/surfaces/admin/targets/admin.settings.internal-order-routing-rule.render.d.ts +2 -0
  143. package/build/ts/surfaces/admin/targets/admin.settings.order-routing-rule.render.d.ts +2 -0
  144. package/build/ts/surfaces/admin/targets/admin.settings.validation.render.d.ts +2 -0
  145. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +8 -5
  146. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  147. package/build/ts/surfaces/checkout/components/Box.d.ts +56 -1
  148. package/build/ts/surfaces/checkout/components/components-shared.d.ts +1 -1
  149. package/build/ts/surfaces/checkout/preact/market.d.ts +8 -2
  150. package/build/ts/surfaces/checkout/preact/market.d.ts.map +1 -1
  151. package/build/ts/surfaces/checkout/shared.d.ts +1 -3
  152. package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
  153. package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +0 -1
  154. package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +0 -1
  155. package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +0 -1
  156. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +0 -1
  157. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +0 -1
  158. package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +0 -1
  159. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +0 -1
  160. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +0 -1
  161. package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +0 -1
  162. package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +0 -1
  163. package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +0 -1
  164. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +0 -1
  165. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +0 -1
  166. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +0 -1
  167. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +0 -1
  168. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +0 -1
  169. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +0 -1
  170. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +0 -1
  171. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +0 -1
  172. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +0 -1
  173. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +0 -1
  174. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +0 -1
  175. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +0 -1
  176. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +0 -1
  177. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +0 -1
  178. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +0 -1
  179. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +0 -1
  180. package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +0 -1
  181. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +0 -1
  182. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +0 -1
  183. package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +0 -1
  184. package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +0 -1
  185. package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +0 -1
  186. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +6 -1
  187. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
  188. package/build/ts/surfaces/customer-account/components/Box.d.ts +56 -1
  189. package/build/ts/surfaces/customer-account/components/components-shared.d.ts +1 -1
  190. package/build/ts/surfaces/customer-account/preact/market.d.ts +8 -2
  191. package/build/ts/surfaces/customer-account/preact/market.d.ts.map +1 -1
  192. package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +0 -1
  193. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +0 -1
  194. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +0 -1
  195. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +0 -1
  196. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +0 -1
  197. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +0 -1
  198. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +0 -1
  199. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +0 -1
  200. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +0 -1
  201. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +0 -1
  202. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +0 -1
  203. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +0 -1
  204. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +0 -1
  205. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +0 -1
  206. package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +0 -1
  207. package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +0 -1
  208. package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +0 -1
  209. package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +0 -1
  210. package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +0 -1
  211. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +0 -1
  212. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +0 -1
  213. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +0 -1
  214. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +0 -1
  215. package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +0 -1
  216. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +13 -0
  217. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
  218. package/build/ts/surfaces/point-of-sale/api/resolution-api/resolution-api.d.ts +23 -0
  219. package/build/ts/surfaces/point-of-sale/api/resolution-api/resolution-api.d.ts.map +1 -0
  220. package/build/ts/surfaces/point-of-sale/api.d.ts +3 -2
  221. package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
  222. package/build/ts/surfaces/point-of-sale/components/targets/ResolutionComponents.d.ts +10 -0
  223. package/build/ts/surfaces/point-of-sale/components/targets/ResolutionComponents.d.ts.map +1 -0
  224. package/build/ts/surfaces/point-of-sale/events/scan-event.d.ts +34 -0
  225. package/build/ts/surfaces/point-of-sale/events/scan-event.d.ts.map +1 -0
  226. package/build/ts/surfaces/point-of-sale/events.d.ts +183 -1
  227. package/build/ts/surfaces/point-of-sale/events.d.ts.map +1 -1
  228. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +17 -3
  229. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
  230. package/build/ts/surfaces/point-of-sale/globals.d.ts +8 -1
  231. package/build/ts/surfaces/point-of-sale/globals.d.ts.map +1 -1
  232. package/build/ts/surfaces/point-of-sale/targets/pos.cart.validations.resolution.render.d.ts +44 -0
  233. package/build/ts/surfaces/point-of-sale/targets/pos.payment.validations.resolution.render.d.ts +44 -0
  234. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +4 -0
  235. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
  236. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +40 -0
  237. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
  238. package/build/tsconfig.tsbuildinfo +1 -1
  239. package/package.json +1 -1
  240. package/src/shared.ts +4 -2
  241. package/src/surfaces/admin/components/AdminAction.d.ts +61 -107
  242. package/src/surfaces/admin/components/AdminBlock.d.ts +22 -107
  243. package/src/surfaces/admin/components/AdminPrintAction.d.ts +20 -101
  244. package/src/surfaces/admin/components/AppNav.d.ts +38 -1
  245. package/src/surfaces/admin/components/Avatar.d.ts +100 -139
  246. package/src/surfaces/admin/components/Badge.d.ts +107 -156
  247. package/src/surfaces/admin/components/Banner.d.ts +102 -127
  248. package/src/surfaces/admin/components/Box.d.ts +145 -234
  249. package/src/surfaces/admin/components/Button.d.ts +156 -266
  250. package/src/surfaces/admin/components/ButtonGroup.d.ts +89 -117
  251. package/src/surfaces/admin/components/Checkbox.d.ts +139 -174
  252. package/src/surfaces/admin/components/Chip.d.ts +117 -15
  253. package/src/surfaces/admin/components/Choice.d.ts +88 -113
  254. package/src/surfaces/admin/components/ChoiceList.d.ts +120 -129
  255. package/src/surfaces/admin/components/Clickable.d.ts +227 -209
  256. package/src/surfaces/admin/components/ClickableChip.d.ts +117 -153
  257. package/src/surfaces/admin/components/ColorField.d.ts +111 -215
  258. package/src/surfaces/admin/components/ColorPicker.d.ts +82 -137
  259. package/src/surfaces/admin/components/DateField.d.ts +140 -230
  260. package/src/surfaces/admin/components/DatePicker.d.ts +178 -181
  261. package/src/surfaces/admin/components/Divider.d.ts +50 -118
  262. package/src/surfaces/admin/components/DropZone.d.ts +153 -12
  263. package/src/surfaces/admin/components/EmailField.d.ts +100 -197
  264. package/src/surfaces/admin/components/EmptyState.d.ts +144 -0
  265. package/src/surfaces/admin/components/Form.d.ts +25 -118
  266. package/src/surfaces/admin/components/FunctionSettings.d.ts +26 -132
  267. package/src/surfaces/admin/components/Grid.d.ts +165 -299
  268. package/src/surfaces/admin/components/GridItem.d.ts +145 -261
  269. package/src/surfaces/admin/components/Heading.d.ts +117 -117
  270. package/src/surfaces/admin/components/Icon.d.ts +91 -129
  271. package/src/surfaces/admin/components/Image.d.ts +216 -251
  272. package/src/surfaces/admin/components/Link.d.ts +125 -126
  273. package/src/surfaces/admin/components/ListItem.d.ts +63 -102
  274. package/src/surfaces/admin/components/Menu.d.ts +82 -150
  275. package/src/surfaces/admin/components/Modal.d.ts +232 -26
  276. package/src/surfaces/admin/components/MoneyField.d.ts +103 -196
  277. package/src/surfaces/admin/components/Number.d.ts +193 -0
  278. package/src/surfaces/admin/components/NumberField.d.ts +114 -208
  279. package/src/surfaces/admin/components/Option.d.ts +67 -108
  280. package/src/surfaces/admin/components/OptionGroup.d.ts +69 -105
  281. package/src/surfaces/admin/components/OrderedList.d.ts +56 -102
  282. package/src/surfaces/admin/components/Page.d.ts +93 -13
  283. package/src/surfaces/admin/components/Paragraph.d.ts +126 -138
  284. package/src/surfaces/admin/components/PasswordField.d.ts +109 -203
  285. package/src/surfaces/admin/components/Popover.d.ts +673 -0
  286. package/src/surfaces/admin/components/Progress.d.ts +155 -0
  287. package/src/surfaces/admin/components/QueryContainer.d.ts +77 -116
  288. package/src/surfaces/admin/components/SearchField.d.ts +103 -191
  289. package/src/surfaces/admin/components/Section.d.ts +132 -128
  290. package/src/surfaces/admin/components/Select.d.ts +144 -193
  291. package/src/surfaces/admin/components/Spinner.d.ts +60 -113
  292. package/src/surfaces/admin/components/Stack.d.ts +156 -282
  293. package/src/surfaces/admin/components/StandardComponents.ts +2 -0
  294. package/src/surfaces/admin/components/Switch.d.ts +75 -165
  295. package/src/surfaces/admin/components/Table.d.ts +100 -210
  296. package/src/surfaces/admin/components/TableBody.d.ts +70 -106
  297. package/src/surfaces/admin/components/TableCell.d.ts +70 -107
  298. package/src/surfaces/admin/components/TableHeader.d.ts +79 -119
  299. package/src/surfaces/admin/components/TableHeaderRow.d.ts +71 -107
  300. package/src/surfaces/admin/components/TableRow.d.ts +81 -109
  301. package/src/surfaces/admin/components/Text.d.ts +123 -164
  302. package/src/surfaces/admin/components/TextArea.d.ts +100 -195
  303. package/src/surfaces/admin/components/TextField.d.ts +120 -204
  304. package/src/surfaces/admin/components/Thumbnail.d.ts +83 -133
  305. package/src/surfaces/admin/components/Tooltip.d.ts +78 -146
  306. package/src/surfaces/admin/components/URLField.d.ts +107 -209
  307. package/src/surfaces/admin/components/UnorderedList.d.ts +58 -110
  308. package/src/surfaces/admin/components/shared.d.ts +4193 -1203
  309. package/src/surfaces/admin/extension-targets.ts +18 -0
  310. package/src/surfaces/checkout/api/standard/standard.ts +8 -5
  311. package/src/surfaces/checkout/components/Box.d.ts +56 -1
  312. package/src/surfaces/checkout/components/components-shared.d.ts +1 -1
  313. package/src/surfaces/checkout/preact/market.ts +8 -2
  314. package/src/surfaces/checkout/shared.ts +1 -6
  315. package/src/surfaces/customer-account/api/order-status/order-status.ts +6 -1
  316. package/src/surfaces/customer-account/preact/market.ts +8 -2
  317. package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +14 -0
  318. package/src/surfaces/point-of-sale/api/resolution-api/resolution-api.ts +24 -0
  319. package/src/surfaces/point-of-sale/api.ts +7 -1
  320. package/src/surfaces/point-of-sale/components/targets/ResolutionComponents.ts +13 -0
  321. package/src/surfaces/point-of-sale/events/scan-event.ts +34 -0
  322. package/src/surfaces/point-of-sale/events.ts +215 -0
  323. package/src/surfaces/point-of-sale/extension-targets.ts +33 -2
  324. package/src/surfaces/point-of-sale/globals.ts +16 -1
  325. package/src/surfaces/point-of-sale/types/cart.ts +4 -0
  326. package/src/surfaces/point-of-sale/types/storage.ts +47 -0
  327. package/build/ts/surfaces/checkout/components/LoginWithShop.d.ts +0 -164
  328. package/build/ts/surfaces/customer-account/components/LoginWithShop.d.ts +0 -164
  329. package/src/surfaces/checkout/components/LoginWithShop.d.ts +0 -164
@@ -1,4 +1,4 @@
1
- /** VERSION: 1.25.0 **/
1
+ /** VERSION: 2.23.0 **/
2
2
  /* eslint-disable import/extensions */
3
3
 
4
4
  /* eslint-disable @typescript-eslint/no-namespace */
@@ -16,10 +16,45 @@ import type {
16
16
  JustifyContentKeyword,
17
17
  AlignItemsKeyword,
18
18
  AlignContentKeyword,
19
+ PreactCustomElement,
20
+ RenderImpl,
19
21
  } from './shared.d.ts';
22
+ import * as preact$1 from 'preact';
23
+ import {ReactNode, RefAttributes} from 'react';
24
+
25
+ export type ReactIntrinsicElementChildren<PreactProps extends object> =
26
+ 'children' extends keyof PreactProps
27
+ ? {
28
+ children?: ReactNode;
29
+ }
30
+ : Record<never, never>;
31
+ export type ReactIntrinsicElementProps<
32
+ PreactProps extends object,
33
+ ElementType,
34
+ > = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
35
+ ReactIntrinsicElementChildren<PreactProps> &
36
+ RefAttributes<ElementType> & {
37
+ slot?: Lowercase<string>;
38
+ };
39
+ export type ReactIntrinsicElements = {
40
+ [Tag in Exclude<
41
+ Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
42
+ `s-test-${string}`
43
+ >]: ReactIntrinsicElementProps<
44
+ preact$1.createElement.JSX.IntrinsicElements[Tag],
45
+ Tag extends keyof HTMLElementTagNameMap
46
+ ? HTMLElementTagNameMap[Tag]
47
+ : HTMLElement
48
+ >;
49
+ };
50
+ declare module 'react' {
51
+ namespace JSX {
52
+ interface IntrinsicElements extends ReactIntrinsicElements {}
53
+ }
54
+ }
20
55
 
21
56
  /**
22
- * A type that allows a value to be responsive using container query syntax.
57
+ * Makes a type responsive by allowing it to be either the base value or a container query string. This enables conditional styling based on container dimensions.
23
58
  * @publicDocs
24
59
  */
25
60
  export type MakeResponsive<T> = T | `@container${string}`;
@@ -45,12 +80,21 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
45
80
  };
46
81
 
47
82
  /**
48
- * A version of the box properties with all fields required.
83
+ * Represents the box component props with all properties marked as required.
49
84
  * @publicDocs
50
85
  */
51
86
  export type RequiredBoxProps = Required<BoxProps$1>;
52
87
  /**
53
- * The allowed border radius values for a box component.
88
+ * Represents the subset of border radius values supported by the component.
89
+ *
90
+ * - `small-200`: Extra small radius for subtle rounding.
91
+ * - `small-100`: Small radius for minimal corner rounding.
92
+ * - `small`: Standard small radius.
93
+ * - `base`: Medium radius for moderate corner rounding.
94
+ * - `large`: Standard large radius for pronounced rounding.
95
+ * - `large-100`: Large radius for more prominent corner rounding.
96
+ * - `large-200`: Extra large radius for maximum rounding.
97
+ * - `none`: No border radius (sharp corners).
54
98
  * @publicDocs
55
99
  */
56
100
  export type BoxBorderRadii = Extract<
@@ -65,7 +109,12 @@ export type BoxBorderRadii = Extract<
65
109
  | 'large-200'
66
110
  >;
67
111
  /**
68
- * The allowed border style values for a box component.
112
+ * Represents the subset of border style values supported by the box component.
113
+ *
114
+ * - `auto`: Default border style determined by the system.
115
+ * - `none`: No border style (removes the border).
116
+ * - `solid`: Continuous line border.
117
+ * - `dashed`: Border made up of dashes.
69
118
  * @publicDocs
70
119
  */
71
120
  export type BoxBorderStyles = Extract<
@@ -73,7 +122,9 @@ export type BoxBorderStyles = Extract<
73
122
  'none' | 'solid' | 'dashed' | 'auto'
74
123
  >;
75
124
  /**
76
- * The box properties that support responsive values through container queries.
125
+ * Represents box props with responsive capabilities for layout properties.
126
+ *
127
+ * This enables conditional styling based on container queries.
77
128
  * @publicDocs
78
129
  */
79
130
  export type ResponsiveBoxProps = MakeResponsivePick<
@@ -108,7 +159,7 @@ export interface BoxProps
108
159
  | 'overflow'
109
160
  > {
110
161
  /**
111
- * The background color of the stack container.
162
+ * The background color of the component.
112
163
  *
113
164
  * @default 'transparent'
114
165
  */
@@ -117,10 +168,13 @@ export interface BoxProps
117
168
  'transparent' | 'base' | 'subdued' | 'strong'
118
169
  >;
119
170
  /**
120
- * Controls the thickness of the border on all sides.
171
+ * A border applied using shorthand syntax to specify width, color, and style in a single property.
121
172
  *
122
- * When set, this overrides the width value specified in the `border` property.
123
- * 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.
173
+ * @default 'none'
174
+ */
175
+ border: RequiredBoxProps['border'];
176
+ /**
177
+ * The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
124
178
  *
125
179
  * @default '' - meaning no override
126
180
  */
@@ -133,10 +187,7 @@ export interface BoxProps
133
187
  >
134
188
  | Extract<RequiredBoxProps['borderWidth'], ''>;
135
189
  /**
136
- * Controls the visual style of the border on all sides (solid, dashed, auto, or none).
137
- *
138
- * When set, this overrides the style value specified in the `border` property.
139
- * 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.
190
+ * The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.
140
191
  *
141
192
  * @default '' - meaning no override
142
193
  */
@@ -144,10 +195,7 @@ export interface BoxProps
144
195
  | MaybeAllValuesShorthandProperty<BoxBorderStyles>
145
196
  | Extract<RequiredBoxProps['borderStyle'], ''>;
146
197
  /**
147
- * Controls the color of the border using the design system's color scale.
148
- *
149
- * When set, this overrides the color value specified in the `border` property.
150
- * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.
198
+ * The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.
151
199
  *
152
200
  * @default '' - meaning no override
153
201
  */
@@ -156,101 +204,85 @@ export interface BoxProps
156
204
  'subdued' | 'base' | 'strong' | ''
157
205
  >;
158
206
  /**
159
- * Controls the roundedness of the element's corners using the design system's radius scale.
160
- *
161
- * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different radii per corner. Use this to create rounded corners or fully rounded elements.
207
+ * The roundedness of the element's corners using the design system's radius scale.
162
208
  *
163
209
  * @default 'none'
164
210
  */
165
211
  borderRadius: MaybeAllValuesShorthandProperty<BoxBorderRadii>;
166
212
  /**
167
- * The padding applied to all edges of the stack container.
168
- *
169
- * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
213
+ * The padding applied to all edges of the component.
170
214
  *
171
- * - 4 values: `block-start inline-end block-end inline-start`
172
- * - 3 values: `block-start inline block-end`
173
- * - 2 values: `block inline`
215
+ * 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:
216
+ * - 1 value applies to all sides
217
+ * - 2 values apply to block (top/bottom) and inline (left/right)
218
+ * - 3 values apply to block-start (top), inline (left/right), and block-end (bottom)
219
+ * - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)
174
220
  *
175
- * For example:
176
- * - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
177
- * - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
178
- * - `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`.
179
- * - `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`.
221
+ * **Examples:** `base`, `large none`, `base large-100 base small`
180
222
  *
181
- * A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
182
- *
183
- * `padding` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
223
+ * Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
184
224
  *
185
225
  * @default 'none'
186
226
  */
187
227
  padding: ResponsiveBoxProps['padding'];
188
228
  /**
189
- * The padding applied to the block axis (top and bottom in horizontal writing modes).
229
+ * The block-direction padding (top and bottom in horizontal writing modes).
190
230
  *
191
- * - `large none` means block-start padding is `large`, block-end padding is `none`.
231
+ * Accepts a single value for both sides or two space-separated values for block-start and block-end.
192
232
  *
193
- * This overrides the block value of `padding`.
233
+ * **Example:** `large none` applies `large` to the top and `none` to the bottom.
194
234
  *
195
- * `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
235
+ * Overrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
196
236
  *
197
237
  * @default '' - meaning no override
198
238
  */
199
239
  paddingBlock: ResponsiveBoxProps['paddingBlock'];
200
240
  /**
201
- * The padding applied to the block-start edge (top in horizontal writing modes).
202
- *
203
- * This overrides the block-start value of `paddingBlock`.
241
+ * The block-start padding (top in horizontal writing modes).
204
242
  *
205
- * `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
243
+ * Overrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
206
244
  *
207
245
  * @default '' - meaning no override
208
246
  */
209
247
  paddingBlockStart: ResponsiveBoxProps['paddingBlockStart'];
210
248
  /**
211
- * The padding applied to the block-end edge (bottom in horizontal writing modes).
249
+ * The block-end padding (bottom in horizontal writing modes).
212
250
  *
213
- * This overrides the block-end value of `paddingBlock`.
214
- *
215
- * `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
251
+ * Overrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
216
252
  *
217
253
  * @default '' - meaning no override
218
254
  */
219
255
  paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd'];
220
256
  /**
221
- * The padding applied to the inline axis (left and right in horizontal writing modes).
257
+ * The inline-direction padding (left and right in horizontal writing modes).
222
258
  *
223
- * - `large none` means inline-start padding is `large`, inline-end padding is `none`.
259
+ * Accepts a single value for both sides or two space-separated values for inline-start and inline-end.
224
260
  *
225
- * This overrides the inline value of `padding`.
261
+ * **Example:** `large none` applies `large` to the left and `none` to the right.
226
262
  *
227
- * `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
263
+ * Overrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
228
264
  *
229
265
  * @default '' - meaning no override
230
266
  */
231
267
  paddingInline: ResponsiveBoxProps['paddingInline'];
232
268
  /**
233
- * The padding applied to the inline-start edge (left in left-to-right languages).
234
- *
235
- * This overrides the inline-start value of `paddingInline`.
269
+ * The inline-start padding (left in LTR writing modes, right in RTL).
236
270
  *
237
- * `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
271
+ * Overrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
238
272
  *
239
273
  * @default '' - meaning no override
240
274
  */
241
275
  paddingInlineStart: ResponsiveBoxProps['paddingInlineStart'];
242
276
  /**
243
- * The padding applied to the inline-end edge (right in left-to-right languages).
277
+ * The inline-end padding (right in LTR writing modes, left in RTL).
244
278
  *
245
- * This overrides the inline-end value of `paddingInline`.
246
- *
247
- * `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
279
+ * Overrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
248
280
  *
249
281
  * @default '' - meaning no override
250
282
  */
251
283
  paddingInlineEnd: ResponsiveBoxProps['paddingInlineEnd'];
252
284
  /**
253
- * Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
285
+ * The outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
254
286
  *
255
287
  * - `auto` the component's initial value. The actual value depends on the component and context.
256
288
  * - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
@@ -259,7 +291,7 @@ export interface BoxProps
259
291
  */
260
292
  display: ResponsiveBoxProps['display'];
261
293
  /**
262
- * The vertical size of the stack in standard layouts (height in left-to-right or right-to-left writing modes).
294
+ * The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).
263
295
  *
264
296
  * Block size adjusts based on the writing direction: in horizontal layouts, it controls the height;
265
297
  * in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.
@@ -270,31 +302,44 @@ export interface BoxProps
270
302
  */
271
303
  blockSize: SizeUnitsOrAuto;
272
304
  /**
273
- * The [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) (minimum height in horizontal writing modes) of the stack container.
305
+ * The minimum height in horizontal writing modes, or minimum width in vertical writing modes.
306
+ * Prevents the element from shrinking below this size.
307
+ *
308
+ * Learn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
274
309
  *
275
310
  * @default '0'
276
311
  */
277
312
  minBlockSize: SizeUnits;
278
313
  /**
279
- * The [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) (maximum height in horizontal writing modes) of the stack container.
314
+ * The maximum height in horizontal writing modes, or maximum width in vertical writing modes.
315
+ * Prevents the element from growing beyond this size.
316
+ *
317
+ * Learn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
280
318
  *
281
319
  * @default 'none'
282
320
  */
283
321
  maxBlockSize: SizeUnitsOrNone;
284
322
  /**
285
- * The [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size) (width in horizontal writing modes) of the stack container.
323
+ * The width in horizontal writing modes, or height in vertical writing modes.
324
+ * Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).
286
325
  *
287
326
  * @default 'auto'
288
327
  */
289
328
  inlineSize: SizeUnitsOrAuto;
290
329
  /**
291
- * The [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) (minimum width in horizontal writing modes) of the stack container.
330
+ * The minimum width in horizontal writing modes, or minimum height in vertical writing modes.
331
+ * Prevents the element from shrinking below this size.
332
+ *
333
+ * Learn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
292
334
  *
293
335
  * @default '0'
294
336
  */
295
337
  minInlineSize: SizeUnits;
296
338
  /**
297
- * The [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) (maximum width in horizontal writing modes) of the stack container.
339
+ * The maximum width in horizontal writing modes, or maximum height in vertical writing modes.
340
+ * Prevents the element from growing beyond this size.
341
+ *
342
+ * Learn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
298
343
  *
299
344
  * @default 'none'
300
345
  */
@@ -302,12 +347,14 @@ export interface BoxProps
302
347
  }
303
348
 
304
349
  /**
305
- * A version of the stack properties with all fields required.
350
+ * Represents the stack component props with all properties marked as required.
306
351
  * @publicDocs
307
352
  */
308
353
  export type AlignedStackProps = Required<StackProps$1>;
309
354
  /**
310
- * The stack properties that support responsive values through container queries.
355
+ * Represents stack props with responsive capabilities for layout properties.
356
+ *
357
+ * This enables conditional styling based on container queries.
311
358
  * @publicDocs
312
359
  */
313
360
  export type ResponsiveStackProps = MakeResponsivePick<
@@ -315,8 +362,7 @@ export type ResponsiveStackProps = MakeResponsivePick<
315
362
  'gap' | 'rowGap' | 'columnGap' | 'direction'
316
363
  >;
317
364
  /**
318
- * The properties for the stack component. A stack arranges its children in a single direction with controlled spacing and alignment along both axes.
319
- * @publicDocs
365
+ * Configure the following properties on the stack component.
320
366
  */
321
367
  export interface StackProps
322
368
  extends BoxProps,
@@ -349,300 +395,132 @@ export interface StackProps
349
395
  */
350
396
  alignContent: AlignContentKeyword;
351
397
  /**
352
- * The spacing between children in the stack. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for the block and inline axes. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
398
+ * Adjusts spacing between elements.
399
+ *
400
+ * Accepts:
401
+ * - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`
402
+ * - A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively
403
+ * - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
353
404
  *
354
405
  * @default 'none'
355
406
  */
356
407
  gap: ResponsiveStackProps['gap'];
357
408
  /**
358
- * The spacing between children in the block axis (vertical in horizontal writing modes). This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
409
+ * Adjusts spacing between elements in the block axis. This overrides the row value of `gap`.
410
+ *
411
+ * Accepts:
412
+ * - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`
413
+ * - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
359
414
  *
360
415
  * @default '' - meaning no override
361
416
  */
362
417
  rowGap: ResponsiveStackProps['rowGap'];
363
418
  /**
364
- * The spacing between children in the inline axis (horizontal in left-to-right languages). This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
419
+ * Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.
420
+ *
421
+ * Accepts:
422
+ * - A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`
423
+ * - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value
365
424
  *
366
425
  * @default '' - meaning no override
367
426
  */
368
427
  columnGap: ResponsiveStackProps['columnGap'];
369
428
  /**
370
- * The direction in which the stack's children are laid out. Use `'inline'` to arrange children horizontally (with wrapping enabled), or `'block'` to arrange them vertically (without wrapping). This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
429
+ * The direction in which the stack's children are placed within the stack.
430
+ *
431
+ * Accepts:
432
+ * - A single value, either `inline` or `block`
433
+ * - A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported direction values as a query value
371
434
  *
372
435
  * @default 'block'
373
436
  *
374
- * @implementation The content will wrap if the direction is `'inline'`, and won't wrap if the direction is `'block'`.
437
+ * @implementation the content will wrap if the direction is 'inline', and not wrap if the direction is 'block'
375
438
  */
376
439
  direction: ResponsiveStackProps['direction'];
377
440
  }
378
441
 
379
- /**
380
- * A string containing CSS styles for a custom element.
381
- * @publicDocs
382
- */
383
- export type Styles = string;
384
- /**
385
- * The configuration for rendering a custom element with Preact.
386
- * @publicDocs
387
- */
388
- export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
389
- /**
390
- * The function that renders the shadow root content.
391
- */
392
- ShadowRoot: (element: any) => ComponentChildren;
393
- /**
394
- * The optional CSS styles to apply to the shadow root.
395
- */
396
- styles?: Styles;
397
- };
398
- /**
399
- * An interface representing the properties of an activation event, such as a click or keypress.
400
- * @publicDocs
401
- */
402
- export interface ActivationEventEsque {
403
- /**
404
- * Whether the shift key was pressed during the event.
405
- */
406
- shiftKey: boolean;
407
- /**
408
- * Whether the meta key (Command on Mac, Windows key on PC) was pressed during the event.
409
- */
410
- metaKey: boolean;
411
- /**
412
- * Whether the control key was pressed during the event.
413
- */
414
- ctrlKey: boolean;
415
- /**
416
- * The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
417
- */
418
- button: number;
419
- }
420
- /**
421
- * The options for triggering a synthetic click event.
422
- * @publicDocs
423
- */
424
- export interface ClickOptions {
425
- /**
426
- * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked.
427
- */
428
- sourceEvent?: ActivationEventEsque;
429
- }
430
- /**
431
- * The base class for creating custom elements with Preact.
432
- * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
433
- * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
434
- */
435
- declare const BaseClass: typeof globalThis.HTMLElement;
436
- /**
437
- * An abstract base class for creating custom elements that render with Preact.
438
- */
439
- declare abstract class PreactCustomElement extends BaseClass {
440
- /** @private */
441
- static get observedAttributes(): string[];
442
- constructor({
443
- styles,
444
- ShadowRoot: renderFunction,
445
- delegatesFocus,
446
- ...options
447
- }: RenderImpl);
448
-
449
- /** @private */
450
- setAttribute(name: string, value: string): void;
451
- /** @private */
452
- attributeChangedCallback(name: string): void;
442
+ declare class PolarisCustomElement extends PreactCustomElement {
443
+ constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
453
444
  /** @private */
454
445
  connectedCallback(): void;
455
446
  /** @private */
456
- disconnectedCallback(): void;
457
- /** @private */
458
447
  adoptedCallback(): void;
459
- /**
460
- * Queue a run of the render function.
461
- * You shouldn't need to call this manually - it should be handled by changes to @property values.
462
- * @private
463
- */
464
- queueRender(): void;
465
- /**
466
- * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
467
- *
468
- * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
469
- * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
470
- * @private
471
- * @param options
472
- */
473
- click({sourceEvent}?: ClickOptions): void;
474
448
  }
475
449
 
476
- /**
477
- * The base element class for Box components with all Box properties as accessors.
478
- */
479
- declare class BoxElement extends PreactCustomElement implements BoxProps {
450
+ declare class BoxElement extends PolarisCustomElement implements BoxProps {
480
451
  constructor(renderImpl: RenderImpl);
481
- /**
482
- * The ARIA role that defines the semantic meaning of the stack for assistive technologies.
483
- */
484
452
  accessor accessibilityRole: BoxProps['accessibilityRole'];
485
- /**
486
- * The background color of the stack using the design system's color scale. Choose from `transparent`, `subdued`, `base`, or `strong`.
487
- */
488
453
  accessor background: BoxProps['background'];
489
- /**
490
- * The height of the stack in horizontal writing modes, or width in vertical writing modes.
491
- * Use this for flow-relative sizing that adapts to text direction.
492
- */
493
454
  accessor blockSize: BoxProps['blockSize'];
494
- /**
495
- * The minimum height of the stack in horizontal writing modes, or minimum width in vertical writing modes.
496
- * Prevents the stack from shrinking below this size.
497
- */
498
455
  accessor minBlockSize: BoxProps['minBlockSize'];
499
- /**
500
- * The maximum height of the stack in horizontal writing modes, or maximum width in vertical writing modes.
501
- * Prevents the stack from growing beyond this size.
502
- */
503
456
  accessor maxBlockSize: BoxProps['maxBlockSize'];
504
- /**
505
- * The width of the stack in horizontal writing modes, or height in vertical writing modes.
506
- * Use this for flow-relative sizing that adapts to text direction.
507
- */
508
457
  accessor inlineSize: BoxProps['inlineSize'];
509
- /**
510
- * The minimum width of the stack in horizontal writing modes, or minimum height in vertical writing modes.
511
- * Prevents the stack from shrinking below this size.
512
- */
513
458
  accessor minInlineSize: BoxProps['minInlineSize'];
514
- /**
515
- * The maximum width of the stack in horizontal writing modes, or maximum height in vertical writing modes.
516
- * Prevents the stack from growing beyond this size.
517
- */
518
459
  accessor maxInlineSize: BoxProps['maxInlineSize'];
519
- /**
520
- * Controls how content that exceeds the stack's boundaries is displayed. Use `hidden` to clip overflow or `visible` to allow content to extend beyond boundaries.
521
- */
522
460
  accessor overflow: BoxProps['overflow'];
523
- /**
524
- * The spacing applied inside the stack on all sides, creating distance between the stack's edges and its content.
525
- */
526
461
  accessor padding: BoxProps['padding'];
527
- /**
528
- * The vertical padding (top and bottom) in horizontal writing modes.
529
- * Use this for flow-relative padding that adapts to text direction.
530
- */
531
462
  accessor paddingBlock: BoxProps['paddingBlock'];
532
- /**
533
- * The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes.
534
- */
535
463
  accessor paddingBlockStart: BoxProps['paddingBlockStart'];
536
- /**
537
- * The padding at the bottom in horizontal writing modes, or at the end edge in vertical writing modes.
538
- */
539
464
  accessor paddingBlockEnd: BoxProps['paddingBlockEnd'];
540
- /**
541
- * The horizontal padding (left and right) in horizontal writing modes.
542
- * Use this for flow-relative padding that adapts to text direction.
543
- */
544
465
  accessor paddingInline: BoxProps['paddingInline'];
545
- /**
546
- * The padding at the left in left-to-right languages, or at the right in right-to-left languages.
547
- */
548
466
  accessor paddingInlineStart: BoxProps['paddingInlineStart'];
549
- /**
550
- * The padding at the right in left-to-right languages, or at the left in right-to-left languages.
551
- */
552
467
  accessor paddingInlineEnd: BoxProps['paddingInlineEnd'];
553
- /**
554
- * Applies a border using shorthand syntax to specify width, color, and style in a single property.
555
- */
556
468
  accessor border: BoxProps['border'];
557
- /**
558
- * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
559
- */
560
469
  accessor borderWidth: BoxProps['borderWidth'];
561
- /**
562
- * Controls the visual style of the border on all sides (solid, dashed, auto, or none). When set, this overrides the style value specified in the `border` property.
563
- */
564
470
  accessor borderStyle: BoxProps['borderStyle'];
565
- /**
566
- * Controls the color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.
567
- */
568
471
  accessor borderColor: BoxProps['borderColor'];
569
- /**
570
- * Controls the roundedness of the element's corners using the design system's radius scale.
571
- */
572
472
  accessor borderRadius: BoxProps['borderRadius'];
573
- /**
574
- * A text description of the stack for screen readers, used when the visual context isn't sufficient for understanding.
575
- */
576
473
  accessor accessibilityLabel: BoxProps['accessibilityLabel'];
577
- /**
578
- * Controls the visibility of the stack for both visual and assistive technology users. Use `hidden` to hide from screen readers or `exclusive` to hide visually but announce to screen readers.
579
- */
580
474
  accessor accessibilityVisibility: BoxProps['accessibilityVisibility'];
581
- /**
582
- * Controls how the stack is displayed in the layout, such as block, inline, or none.
583
- */
584
475
  accessor display: BoxProps['display'];
585
476
  }
586
477
 
587
478
  /**
588
- * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
479
+ * Base props for Preact custom elements without children support. Includes common properties like key, ref, and slot for elements that don't accept child content.
589
480
  * @publicDocs
590
481
  */
591
482
  export interface PreactBaseElementProps<TClass extends HTMLElement> {
592
483
  /**
593
- * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered.
484
+ * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
485
+ * Essential for maintaining component state and optimizing re-renders when lists change.
594
486
  */
595
487
  key?: preact.Key;
596
488
  /**
597
- * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic.
489
+ * A reference to access the underlying DOM element directly.
490
+ * Typically created using `useRef()` to interact with the element imperatively or measure its properties.
598
491
  */
599
492
  ref?: preact.Ref<TClass>;
600
493
  /**
601
- * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
494
+ * The named slot to which this element is assigned in the parent component's shadow DOM.
495
+ *
496
+ * Used for advanced component composition with web components.
602
497
  */
603
498
  slot?: Lowercase<string>;
604
499
  }
605
500
  /**
606
- * The base properties for Preact elements that have children, extending the base element properties to include child content.
501
+ * Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.
607
502
  * @publicDocs
608
503
  */
609
504
  export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
610
505
  extends PreactBaseElementProps<TClass> {
506
+ /**
507
+ * The child elements to be rendered within this component.
508
+ */
611
509
  children?: preact.ComponentChildren;
612
510
  }
613
511
 
614
512
  /**
615
- * A stack is a layout component that arranges its children in a single direction with controlled spacing and alignment.
513
+ * Configure the following properties on the stack component.
514
+ * @publicDocs
616
515
  */
617
516
  declare class Stack extends BoxElement implements StackProps {
618
517
  constructor();
619
- /**
620
- * The direction in which the stack's children are arranged.
621
- */
622
518
  accessor direction: StackProps['direction'];
623
- /**
624
- * Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).
625
- */
626
519
  accessor justifyContent: StackProps['justifyContent'];
627
- /**
628
- * Controls the alignment of children along the block axis (vertically in horizontal writing modes).
629
- */
630
520
  accessor alignItems: StackProps['alignItems'];
631
- /**
632
- * Controls the distribution of lines along the block axis when content wraps into multiple lines.
633
- */
634
521
  accessor alignContent: StackProps['alignContent'];
635
- /**
636
- * The spacing between the stack's children.
637
- */
638
522
  accessor gap: StackProps['gap'];
639
- /**
640
- * The spacing between rows in the stack.
641
- */
642
523
  accessor rowGap: StackProps['rowGap'];
643
- /**
644
- * The spacing between columns in the stack.
645
- */
646
524
  accessor columnGap: StackProps['columnGap'];
647
525
  }
648
526
  declare global {
@@ -659,15 +537,11 @@ declare module 'preact' {
659
537
  }
660
538
 
661
539
  declare const tagName = 's-stack';
662
- /**
663
- * The properties for the stack component when it's used in JSX.
664
- * @publicDocs
665
- */
666
540
  export interface StackJSXProps
667
541
  extends Partial<StackProps>,
668
542
  Pick<StackProps$1, 'id' | 'children'> {
669
543
  /**
670
- * The child elements to render inside the stack.
544
+ * The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.
671
545
  */
672
546
  children?: ComponentChildren;
673
547
  }