@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 */
@@ -12,10 +12,45 @@ import type {
12
12
  SizeUnitsOrAuto,
13
13
  SizeUnits,
14
14
  SizeUnitsOrNone,
15
+ PreactCustomElement,
16
+ RenderImpl,
15
17
  } from './shared.d.ts';
18
+ import * as preact$1 from 'preact';
19
+ import {ReactNode, RefAttributes} from 'react';
20
+
21
+ export type ReactIntrinsicElementChildren<PreactProps extends object> =
22
+ 'children' extends keyof PreactProps
23
+ ? {
24
+ children?: ReactNode;
25
+ }
26
+ : Record<never, never>;
27
+ export type ReactIntrinsicElementProps<
28
+ PreactProps extends object,
29
+ ElementType,
30
+ > = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
31
+ ReactIntrinsicElementChildren<PreactProps> &
32
+ RefAttributes<ElementType> & {
33
+ slot?: Lowercase<string>;
34
+ };
35
+ export type ReactIntrinsicElements = {
36
+ [Tag in Exclude<
37
+ Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
38
+ `s-test-${string}`
39
+ >]: ReactIntrinsicElementProps<
40
+ preact$1.createElement.JSX.IntrinsicElements[Tag],
41
+ Tag extends keyof HTMLElementTagNameMap
42
+ ? HTMLElementTagNameMap[Tag]
43
+ : HTMLElement
44
+ >;
45
+ };
46
+ declare module 'react' {
47
+ namespace JSX {
48
+ interface IntrinsicElements extends ReactIntrinsicElements {}
49
+ }
50
+ }
16
51
 
17
52
  /**
18
- * A type that allows a value to be responsive using container query syntax.
53
+ * 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.
19
54
  * @publicDocs
20
55
  */
21
56
  export type MakeResponsive<T> = T | `@container${string}`;
@@ -41,12 +76,21 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
41
76
  };
42
77
 
43
78
  /**
44
- * A version of the box properties with all fields required.
79
+ * Represents the box component props with all properties marked as required.
45
80
  * @publicDocs
46
81
  */
47
82
  export type RequiredBoxProps = Required<BoxProps$1>;
48
83
  /**
49
- * The allowed border radius values for a box component.
84
+ * Represents the subset of border radius values supported by the component.
85
+ *
86
+ * - `small-200`: Extra small radius for subtle rounding.
87
+ * - `small-100`: Small radius for minimal corner rounding.
88
+ * - `small`: Standard small radius.
89
+ * - `base`: Medium radius for moderate corner rounding.
90
+ * - `large`: Standard large radius for pronounced rounding.
91
+ * - `large-100`: Large radius for more prominent corner rounding.
92
+ * - `large-200`: Extra large radius for maximum rounding.
93
+ * - `none`: No border radius (sharp corners).
50
94
  * @publicDocs
51
95
  */
52
96
  export type BoxBorderRadii = Extract<
@@ -61,7 +105,12 @@ export type BoxBorderRadii = Extract<
61
105
  | 'large-200'
62
106
  >;
63
107
  /**
64
- * The allowed border style values for a box component.
108
+ * Represents the subset of border style values supported by the box component.
109
+ *
110
+ * - `auto`: Default border style determined by the system.
111
+ * - `none`: No border style (removes the border).
112
+ * - `solid`: Continuous line border.
113
+ * - `dashed`: Border made up of dashes.
65
114
  * @publicDocs
66
115
  */
67
116
  export type BoxBorderStyles = Extract<
@@ -69,7 +118,9 @@ export type BoxBorderStyles = Extract<
69
118
  'none' | 'solid' | 'dashed' | 'auto'
70
119
  >;
71
120
  /**
72
- * The box properties that support responsive values through container queries.
121
+ * Represents box props with responsive capabilities for layout properties.
122
+ *
123
+ * This enables conditional styling based on container queries.
73
124
  * @publicDocs
74
125
  */
75
126
  export type ResponsiveBoxProps = MakeResponsivePick<
@@ -83,10 +134,6 @@ export type ResponsiveBoxProps = MakeResponsivePick<
83
134
  | 'paddingInlineEnd'
84
135
  | 'display'
85
136
  >;
86
- /**
87
- * The properties for the box component. A box provides control over layout, spacing, sizing, borders, and background styling for its content.
88
- * @publicDocs
89
- */
90
137
  export interface BoxProps
91
138
  extends Pick<
92
139
  RequiredBoxProps,
@@ -108,7 +155,7 @@ export interface BoxProps
108
155
  | 'overflow'
109
156
  > {
110
157
  /**
111
- * The background color of the box. You can choose from `'transparent'`, `'base'`, `'subdued'`, or `'strong'` to control the visual emphasis of the background.
158
+ * The background color of the component.
112
159
  *
113
160
  * @default 'transparent'
114
161
  */
@@ -117,16 +164,13 @@ export interface BoxProps
117
164
  'transparent' | 'base' | 'subdued' | 'strong'
118
165
  >;
119
166
  /**
120
- * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
167
+ * A border applied using shorthand syntax to specify width, color, and style in a single property.
121
168
  *
122
- * - `small`: Thin border for subtle definition.
123
- * - `small-100`: Extra thin border for minimal emphasis.
124
- * - `base`: Standard border width.
125
- * - `large`: Thick border for strong emphasis.
126
- * - `large-100`: Extra thick border for maximum prominence.
127
- * - `none`: No border.
128
- *
129
- * 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.
169
+ * @default 'none'
170
+ */
171
+ border: RequiredBoxProps['border'];
172
+ /**
173
+ * The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
130
174
  *
131
175
  * @default '' - meaning no override
132
176
  */
@@ -139,11 +183,7 @@ export interface BoxProps
139
183
  >
140
184
  | Extract<RequiredBoxProps['borderWidth'], ''>;
141
185
  /**
142
- * Controls the visual style of the border on all sides (solid, dashed, auto, or none).
143
- *
144
- * When set, this overrides the style value specified in the `border` property.
145
- * 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: one value applies to all sides,
146
- * two values apply to block and inline sides, and so on.
186
+ * 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.
147
187
  *
148
188
  * @default '' - meaning no override
149
189
  */
@@ -151,10 +191,7 @@ export interface BoxProps
151
191
  | MaybeAllValuesShorthandProperty<BoxBorderStyles>
152
192
  | Extract<RequiredBoxProps['borderStyle'], ''>;
153
193
  /**
154
- * Controls the color of the border using the design system's color scale.
155
- *
156
- * When set, this overrides the color value specified in the `border` property.
157
- * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.
194
+ * The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.
158
195
  *
159
196
  * @default '' - meaning no override
160
197
  */
@@ -163,64 +200,94 @@ export interface BoxProps
163
200
  'subdued' | 'base' | 'strong' | ''
164
201
  >;
165
202
  /**
166
- * Controls the roundedness of the element's corners using the design system's radius scale.
167
- *
168
- * 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.
169
- * One value applies to all corners, two values apply to opposite corners, and so on.
203
+ * The roundedness of the element's corners using the design system's radius scale.
170
204
  *
171
205
  * @default 'none'
172
206
  */
173
207
  borderRadius: MaybeAllValuesShorthandProperty<BoxBorderRadii>;
174
208
  /**
175
- * The padding on all sides of the box. The [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported, using flow-relative values in the order `block-start inline-end block-end inline-start`. For example, `'large'` applies large padding to all sides, while `'large none'` applies large padding to the block axis and no padding to the inline axis. A value of `'auto'` will use the default padding from the closest container that has had its padding removed. This property also accepts responsive values using container query syntax.
209
+ * The padding applied to all edges of the component.
210
+ *
211
+ * 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:
212
+ * - 1 value applies to all sides
213
+ * - 2 values apply to block (top/bottom) and inline (left/right)
214
+ * - 3 values apply to block-start (top), inline (left/right), and block-end (bottom)
215
+ * - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)
216
+ *
217
+ * **Examples:** `base`, `large none`, `base large-100 base small`
218
+ *
219
+ * 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.
176
220
  *
177
221
  * @default 'none'
178
222
  */
179
223
  padding: ResponsiveBoxProps['padding'];
180
224
  /**
181
- * The padding on the block axis (top and bottom in horizontal writing modes). This property overrides the block-axis value set by the `padding` property. For example, `'large none'` applies large padding to the block-start and no padding to the block-end. This property also accepts responsive values using container query syntax.
225
+ * The block-direction padding (top and bottom in horizontal writing modes).
226
+ *
227
+ * Accepts a single value for both sides or two space-separated values for block-start and block-end.
228
+ *
229
+ * **Example:** `large none` applies `large` to the top and `none` to the bottom.
230
+ *
231
+ * 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.
182
232
  *
183
233
  * @default '' - meaning no override
184
234
  */
185
235
  paddingBlock: ResponsiveBoxProps['paddingBlock'];
186
236
  /**
187
- * The padding at the start of the block axis (top in horizontal writing modes). This property overrides the block-start value set by the `paddingBlock` property. It also accepts responsive values using container query syntax.
237
+ * The block-start padding (top in horizontal writing modes).
238
+ *
239
+ * 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.
188
240
  *
189
241
  * @default '' - meaning no override
190
242
  */
191
243
  paddingBlockStart: ResponsiveBoxProps['paddingBlockStart'];
192
244
  /**
193
- * The padding at the end of the block axis (bottom in horizontal writing modes). This property overrides the block-end value set by the `paddingBlock` property. It also accepts responsive values using container query syntax.
245
+ * The block-end padding (bottom in horizontal writing modes).
246
+ *
247
+ * 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.
194
248
  *
195
249
  * @default '' - meaning no override
196
250
  */
197
251
  paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd'];
198
252
  /**
199
- * The padding on the inline axis (left and right in horizontal writing modes). This property overrides the inline-axis value set by the `padding` property. For example, `'large none'` applies large padding to the inline-start and no padding to the inline-end. This property also accepts responsive values using container query syntax.
253
+ * The inline-direction padding (left and right in horizontal writing modes).
254
+ *
255
+ * Accepts a single value for both sides or two space-separated values for inline-start and inline-end.
256
+ *
257
+ * **Example:** `large none` applies `large` to the left and `none` to the right.
258
+ *
259
+ * 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.
200
260
  *
201
261
  * @default '' - meaning no override
202
262
  */
203
263
  paddingInline: ResponsiveBoxProps['paddingInline'];
204
264
  /**
205
- * The padding at the start of the inline axis (left in left-to-right writing modes). This property overrides the inline-start value set by the `paddingInline` property. It also accepts responsive values using container query syntax.
265
+ * The inline-start padding (left in LTR writing modes, right in RTL).
266
+ *
267
+ * 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.
206
268
  *
207
269
  * @default '' - meaning no override
208
270
  */
209
271
  paddingInlineStart: ResponsiveBoxProps['paddingInlineStart'];
210
272
  /**
211
- * The padding at the end of the inline axis (right in left-to-right writing modes). This property overrides the inline-end value set by the `paddingInline` property. It also accepts responsive values using container query syntax.
273
+ * The inline-end padding (right in LTR writing modes, left in RTL).
274
+ *
275
+ * 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.
212
276
  *
213
277
  * @default '' - meaning no override
214
278
  */
215
279
  paddingInlineEnd: ResponsiveBoxProps['paddingInlineEnd'];
216
280
  /**
217
- * The outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component, which controls how it participates in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). Use `'auto'` for the component's default behavior, or `'none'` to hide the component completely and remove it from the accessibility tree.
281
+ * 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).
282
+ *
283
+ * - `auto` the component's initial value. The actual value depends on the component and context.
284
+ * - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
218
285
  *
219
286
  * @default 'auto'
220
287
  */
221
288
  display: ResponsiveBoxProps['display'];
222
289
  /**
223
- * The vertical size of the box in standard layouts (height in left-to-right or right-to-left writing modes).
290
+ * The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).
224
291
  *
225
292
  * Block size adjusts based on the writing direction: in horizontal layouts, it controls the height;
226
293
  * in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.
@@ -231,275 +298,123 @@ export interface BoxProps
231
298
  */
232
299
  blockSize: SizeUnitsOrAuto;
233
300
  /**
234
- * The [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) of the box (minimum height in horizontal writing modes).
301
+ * The minimum height in horizontal writing modes, or minimum width in vertical writing modes.
302
+ * Prevents the element from shrinking below this size.
303
+ *
304
+ * Learn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
235
305
  *
236
306
  * @default '0'
237
307
  */
238
308
  minBlockSize: SizeUnits;
239
309
  /**
240
- * The [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) of the box (maximum height in horizontal writing modes).
310
+ * The maximum height in horizontal writing modes, or maximum width in vertical writing modes.
311
+ * Prevents the element from growing beyond this size.
312
+ *
313
+ * Learn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
241
314
  *
242
315
  * @default 'none'
243
316
  */
244
317
  maxBlockSize: SizeUnitsOrNone;
245
318
  /**
246
- * The [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size) of the box (width in horizontal writing modes).
319
+ * The width in horizontal writing modes, or height in vertical writing modes.
320
+ * 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).
247
321
  *
248
322
  * @default 'auto'
249
323
  */
250
324
  inlineSize: SizeUnitsOrAuto;
251
325
  /**
252
- * The [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) of the box (minimum width in horizontal writing modes).
326
+ * The minimum width in horizontal writing modes, or minimum height in vertical writing modes.
327
+ * Prevents the element from shrinking below this size.
328
+ *
329
+ * Learn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
253
330
  *
254
331
  * @default '0'
255
332
  */
256
333
  minInlineSize: SizeUnits;
257
334
  /**
258
- * The [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) of the box (maximum width in horizontal writing modes).
335
+ * The maximum width in horizontal writing modes, or maximum height in vertical writing modes.
336
+ * Prevents the element from growing beyond this size.
337
+ *
338
+ * Learn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
259
339
  *
260
340
  * @default 'none'
261
341
  */
262
342
  maxInlineSize: SizeUnitsOrNone;
263
343
  }
264
344
 
265
- /**
266
- * A string containing CSS styles for a custom element.
267
- * @publicDocs
268
- */
269
- export type Styles = string;
270
- /**
271
- * The configuration for rendering a custom element with Preact.
272
- * @publicDocs
273
- */
274
- export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
275
- /**
276
- * The function that renders the shadow root content.
277
- */
278
- ShadowRoot: (element: any) => ComponentChildren;
279
- /**
280
- * The optional CSS styles to apply to the shadow root.
281
- */
282
- styles?: Styles;
283
- };
284
- /**
285
- * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event.
286
- * @publicDocs
287
- */
288
- export interface ActivationEventEsque {
289
- /**
290
- * Whether the shift key was pressed during the event.
291
- */
292
- shiftKey: boolean;
293
- /**
294
- * Whether the meta key (Command on Mac, Windows key on Windows) was pressed during the event.
295
- */
296
- metaKey: boolean;
297
- /**
298
- * Whether the control key was pressed during the event.
299
- */
300
- ctrlKey: boolean;
301
- /**
302
- * The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
303
- */
304
- button: number;
305
- }
306
- /**
307
- * The options for triggering a synthetic click event.
308
- * @publicDocs
309
- */
310
- export interface ClickOptions {
311
- /**
312
- * 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.
313
- */
314
- sourceEvent?: ActivationEventEsque;
315
- }
316
- /**
317
- * The base class for creating custom elements with Preact.
318
- * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
319
- * So we give it a type of `HTMLElement` to avoid typing issues later where it's used, which will only happen in the browser.
320
- */
321
- declare const BaseClass: typeof globalThis.HTMLElement;
322
- /**
323
- * An abstract base class for creating custom elements that render with Preact.
324
- */
325
- declare abstract class PreactCustomElement extends BaseClass {
326
- /** @private */
327
- static get observedAttributes(): string[];
328
- constructor({
329
- styles,
330
- ShadowRoot: renderFunction,
331
- delegatesFocus,
332
- ...options
333
- }: RenderImpl);
334
-
335
- /** @private */
336
- setAttribute(name: string, value: string): void;
337
- /** @private */
338
- attributeChangedCallback(name: string): void;
345
+ declare class PolarisCustomElement extends PreactCustomElement {
346
+ constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
339
347
  /** @private */
340
348
  connectedCallback(): void;
341
349
  /** @private */
342
- disconnectedCallback(): void;
343
- /** @private */
344
350
  adoptedCallback(): void;
345
- /**
346
- * Queue a run of the render function.
347
- * You shouldn't need to call this manually - it should be handled by changes to @property values.
348
- * @private
349
- */
350
- queueRender(): void;
351
- /**
352
- * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
353
- *
354
- * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
355
- * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
356
- * @private
357
- * @param options
358
- */
359
- click({sourceEvent}?: ClickOptions): void;
360
351
  }
361
352
 
362
- /**
363
- * The base element class for Box components with all Box properties as accessors.
364
- */
365
- declare class BoxElement extends PreactCustomElement implements BoxProps {
353
+ declare class BoxElement extends PolarisCustomElement implements BoxProps {
366
354
  constructor(renderImpl: RenderImpl);
367
- /**
368
- * The ARIA role that defines the semantic meaning of the box for assistive technologies.
369
- */
370
355
  accessor accessibilityRole: BoxProps['accessibilityRole'];
371
- /**
372
- * The background color of the box using the design system's color scale. Choose from `transparent`, `subdued`, `base`, or `strong`.
373
- */
374
356
  accessor background: BoxProps['background'];
375
- /**
376
- * The height of the box in horizontal writing modes, or width in vertical writing modes.
377
- * Use this for flow-relative sizing that adapts to text direction.
378
- */
379
357
  accessor blockSize: BoxProps['blockSize'];
380
- /**
381
- * The minimum height of the box in horizontal writing modes, or minimum width in vertical writing modes.
382
- * Prevents the box from shrinking below this size.
383
- */
384
358
  accessor minBlockSize: BoxProps['minBlockSize'];
385
- /**
386
- * The maximum height of the box in horizontal writing modes, or maximum width in vertical writing modes.
387
- * Prevents the box from growing beyond this size.
388
- */
389
359
  accessor maxBlockSize: BoxProps['maxBlockSize'];
390
- /**
391
- * The width of the box in horizontal writing modes, or height in vertical writing modes.
392
- * Use this for flow-relative sizing that adapts to text direction.
393
- */
394
360
  accessor inlineSize: BoxProps['inlineSize'];
395
- /**
396
- * The minimum width of the box in horizontal writing modes, or minimum height in vertical writing modes.
397
- * Prevents the box from shrinking below this size.
398
- */
399
361
  accessor minInlineSize: BoxProps['minInlineSize'];
400
- /**
401
- * The maximum width of the box in horizontal writing modes, or maximum height in vertical writing modes.
402
- * Prevents the box from growing beyond this size.
403
- */
404
362
  accessor maxInlineSize: BoxProps['maxInlineSize'];
405
- /**
406
- * Controls how content that exceeds the box's boundaries is displayed. Use `hidden` to clip overflow or `visible` to allow content to extend beyond boundaries.
407
- */
408
363
  accessor overflow: BoxProps['overflow'];
409
- /**
410
- * The padding on all sides of the box.
411
- */
412
364
  accessor padding: BoxProps['padding'];
413
- /**
414
- * The vertical padding (top and bottom) in horizontal writing modes.
415
- * Use this for flow-relative padding that adapts to text direction.
416
- */
417
365
  accessor paddingBlock: BoxProps['paddingBlock'];
418
- /**
419
- * The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes.
420
- */
421
366
  accessor paddingBlockStart: BoxProps['paddingBlockStart'];
422
- /**
423
- * The padding at the bottom in horizontal writing modes, or at the end edge in vertical writing modes.
424
- */
425
367
  accessor paddingBlockEnd: BoxProps['paddingBlockEnd'];
426
- /**
427
- * The horizontal padding (left and right) in horizontal writing modes.
428
- * Use this for flow-relative padding that adapts to text direction.
429
- */
430
368
  accessor paddingInline: BoxProps['paddingInline'];
431
- /**
432
- * The padding at the left in left-to-right languages, or at the right in right-to-left languages.
433
- */
434
369
  accessor paddingInlineStart: BoxProps['paddingInlineStart'];
435
- /**
436
- * The padding at the right in left-to-right languages, or at the left in right-to-left languages.
437
- */
438
370
  accessor paddingInlineEnd: BoxProps['paddingInlineEnd'];
439
- /**
440
- * Applies a border using shorthand syntax to specify width, color, and style in a single property.
441
- */
442
371
  accessor border: BoxProps['border'];
443
- /**
444
- * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
445
- */
446
372
  accessor borderWidth: BoxProps['borderWidth'];
447
- /**
448
- * 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.
449
- */
450
373
  accessor borderStyle: BoxProps['borderStyle'];
451
- /**
452
- * 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.
453
- */
454
374
  accessor borderColor: BoxProps['borderColor'];
455
- /**
456
- * Controls the roundedness of the element's corners using the design system's radius scale.
457
- */
458
375
  accessor borderRadius: BoxProps['borderRadius'];
459
- /**
460
- * The accessibility label for screen readers.
461
- */
462
376
  accessor accessibilityLabel: BoxProps['accessibilityLabel'];
463
- /**
464
- * Controls the visibility of the box for both visual and assistive technology users. Use `hidden` to hide from screen readers or `exclusive` to hide visually but announce to screen readers.
465
- */
466
377
  accessor accessibilityVisibility: BoxProps['accessibilityVisibility'];
467
- /**
468
- * Controls how the box is displayed in the layout, such as block, inline, or none.
469
- */
470
378
  accessor display: BoxProps['display'];
471
379
  }
472
380
 
473
381
  /**
474
- * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
382
+ * 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.
475
383
  * @publicDocs
476
384
  */
477
385
  export interface PreactBaseElementProps<TClass extends HTMLElement> {
478
386
  /**
479
- * 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.
387
+ * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
388
+ * Essential for maintaining component state and optimizing re-renders when lists change.
480
389
  */
481
390
  key?: preact.Key;
482
391
  /**
483
- * 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.
392
+ * A reference to access the underlying DOM element directly.
393
+ * Typically created using `useRef()` to interact with the element imperatively or measure its properties.
484
394
  */
485
395
  ref?: preact.Ref<TClass>;
486
396
  /**
487
- * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
397
+ * The named slot to which this element is assigned in the parent component's shadow DOM.
398
+ *
399
+ * Used for advanced component composition with web components.
488
400
  */
489
401
  slot?: Lowercase<string>;
490
402
  }
491
403
  /**
492
- * The base properties for Preact elements that have children, extending the base element properties to include child content.
404
+ * Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.
493
405
  * @publicDocs
494
406
  */
495
407
  export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
496
408
  extends PreactBaseElementProps<TClass> {
497
- /** The child elements to render inside this element. */
409
+ /**
410
+ * The child elements to be rendered within this component.
411
+ */
498
412
  children?: preact.ComponentChildren;
499
413
  }
500
414
 
501
415
  /**
502
- * A box is a container component that provides control over layout, spacing, and styling.
416
+ * Configure the following properties on the box component.
417
+ * @publicDocs
503
418
  */
504
419
  declare class Box extends BoxElement implements BoxProps {
505
420
  constructor();
@@ -518,15 +433,11 @@ declare module 'preact' {
518
433
  }
519
434
 
520
435
  declare const tagName = 's-box';
521
- /**
522
- * The properties for the box component when it's used in JSX.
523
- * @publicDocs
524
- */
525
436
  export interface BoxJSXProps
526
437
  extends Partial<BoxProps>,
527
438
  Pick<BoxProps$1, 'id' | 'children'> {
528
439
  /**
529
- * The child elements to render inside the box.
440
+ * The content displayed within the box component, which serves as a flexible container for organizing and styling other components.
530
441
  */
531
442
  children?: ComponentChildren;
532
443
  }