@shopify/ui-extensions 2026.10.0-rc.8 → 2026.10.0

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