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