@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,151 +1,129 @@
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 */
5
5
 
6
6
  // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
7
7
  /// <reference lib="DOM" />
8
- import type {ComponentChildren, TableRowProps$1} from './shared.d.ts';
8
+ import type {
9
+ ComponentChildren,
10
+ TableRowProps$1,
11
+ PreactCustomElement,
12
+ RenderImpl,
13
+ } from './shared.d.ts';
14
+ import * as preact$1 from 'preact';
15
+ import {ReactNode, RefAttributes} from 'react';
9
16
 
10
- /**
11
- * The properties you can set on a table row component.
12
- * @publicDocs
13
- */
14
- export interface TableRowProps
15
- extends Pick<TableRowProps$1, 'children' | 'clickDelegate'> {}
16
-
17
- /**
18
- * A string that contains CSS styles to apply to the component.
19
- * @publicDocs
20
- */
21
- export type Styles = string;
22
- /**
23
- * The implementation details for rendering a Preact custom element with a shadow root.
24
- * @publicDocs
25
- */
26
- export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
27
- /**
28
- * The function that renders the component's shadow root content.
29
- */
30
- ShadowRoot: (element: any) => ComponentChildren;
31
- /**
32
- * The CSS styles to apply to the component.
33
- */
34
- styles?: Styles;
17
+ export type ReactIntrinsicElementChildren<PreactProps extends object> =
18
+ 'children' extends keyof PreactProps
19
+ ? {
20
+ children?: ReactNode;
21
+ }
22
+ : Record<never, never>;
23
+ export type ReactIntrinsicElementProps<
24
+ PreactProps extends object,
25
+ ElementType,
26
+ > = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
27
+ ReactIntrinsicElementChildren<PreactProps> &
28
+ RefAttributes<ElementType> & {
29
+ slot?: Lowercase<string>;
30
+ };
31
+ export type ReactIntrinsicElements = {
32
+ [Tag in Exclude<
33
+ Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
34
+ `s-test-${string}`
35
+ >]: ReactIntrinsicElementProps<
36
+ preact$1.createElement.JSX.IntrinsicElements[Tag],
37
+ Tag extends keyof HTMLElementTagNameMap
38
+ ? HTMLElementTagNameMap[Tag]
39
+ : HTMLElement
40
+ >;
35
41
  };
42
+ declare module 'react' {
43
+ namespace JSX {
44
+ interface IntrinsicElements extends ReactIntrinsicElements {}
45
+ }
46
+ }
47
+
36
48
  /**
37
- * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
38
- * @publicDocs
49
+ * The table row component represents a single row of data within a table body. Use table row as a child of table body to structure individual records or entries in the table.
50
+ *
51
+ * Table row must contain table cell components, with each cell representing a data value for the corresponding column. The number of cells should match the number of headers in the table.
39
52
  */
40
- export interface ActivationEventEsque {
41
- /**
42
- * Whether the Shift key was pressed during the event.
43
- */
44
- shiftKey: boolean;
45
- /**
46
- * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event.
47
- */
48
- metaKey: boolean;
49
- /**
50
- * Whether the Control key was pressed during the event.
51
- */
52
- ctrlKey: boolean;
53
+ export interface TableRowProps
54
+ extends Pick<TableRowProps$1, 'children' | 'clickDelegate'> {
53
55
  /**
54
- * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right).
56
+ * The data cells displayed within this table row, with each cell containing content for its corresponding column.
57
+ * Only accepts table cell components as children.
55
58
  */
56
- button: number;
57
- }
58
- /**
59
- * The options for customizing how a synthetic click is performed.
60
- * @publicDocs
61
- */
62
- export interface ClickOptions {
59
+ children?: TableRowProps$1['children'];
63
60
  /**
64
- * 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.
61
+ * The ID of an interactive element, such as `s-link`, in the row that will be the target of the click when the row is clicked.
62
+ * This is the primary action for the row; it should not be used for secondary actions.
63
+ *
64
+ * This is a click-only affordance, and does not introduce any keyboard or screen reader affordances.
65
+ * Which is why the target element must be in the table; so that keyboard and screen reader users can interact with it normally.
66
+ *
67
+ * @implementation no focus or keyboard affordances are introduced by this property. No aria attributes need to be added to the table row.
68
+ * @implementation the row and/or delegate should have some affordance that indicates it is clickable. This may be a background color, a border, or a hover effect
65
69
  */
66
- sourceEvent?: ActivationEventEsque;
70
+ clickDelegate?: TableRowProps$1['clickDelegate'];
67
71
  }
68
- /**
69
- * Base class for creating custom elements with Preact.
70
- * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
71
- * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
72
- */
73
- declare const BaseClass: typeof globalThis.HTMLElement;
74
- declare abstract class PreactCustomElement extends BaseClass {
75
- /** @private */
76
- static get observedAttributes(): string[];
77
- constructor({
78
- styles,
79
- ShadowRoot: renderFunction,
80
- delegatesFocus,
81
- ...options
82
- }: RenderImpl);
83
72
 
84
- /** @private */
85
- setAttribute(name: string, value: string): void;
86
- /** @private */
87
- attributeChangedCallback(name: string): void;
73
+ declare class PolarisCustomElement extends PreactCustomElement {
74
+ constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
88
75
  /** @private */
89
76
  connectedCallback(): void;
90
77
  /** @private */
91
- disconnectedCallback(): void;
92
- /** @private */
93
78
  adoptedCallback(): void;
94
- /**
95
- * Queue a run of the render function.
96
- * You shouldn't need to call this manually - it should be handled by changes to @property values.
97
- * @private
98
- */
99
- queueRender(): void;
100
- /**
101
- * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
102
- *
103
- * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
104
- * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
105
- * @private
106
- * @param options
107
- */
108
- click({sourceEvent}?: ClickOptions): void;
109
79
  }
110
80
 
111
81
  /**
112
- * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
82
+ * 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.
113
83
  * @publicDocs
114
84
  */
115
85
  export interface PreactBaseElementProps<TClass extends HTMLElement> {
116
86
  /**
117
- * 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.
87
+ * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
88
+ * Essential for maintaining component state and optimizing re-renders when lists change.
118
89
  */
119
90
  key?: preact.Key;
120
91
  /**
121
- * 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.
92
+ * A reference to access the underlying DOM element directly.
93
+ * Typically created using `useRef()` to interact with the element imperatively or measure its properties.
122
94
  */
123
95
  ref?: preact.Ref<TClass>;
124
96
  /**
125
- * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
97
+ * The named slot to which this element is assigned in the parent component's shadow DOM.
98
+ *
99
+ * Used for advanced component composition with web components.
126
100
  */
127
101
  slot?: Lowercase<string>;
128
102
  }
129
103
  /**
130
- * The base properties for Preact elements that have children, extending the base element properties to include child content.
104
+ * Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.
131
105
  * @publicDocs
132
106
  */
133
107
  export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
134
108
  extends PreactBaseElementProps<TClass> {
109
+ /**
110
+ * The child elements to be rendered within this component.
111
+ */
135
112
  children?: preact.ComponentChildren;
136
113
  }
137
114
 
115
+ declare const elementInternals: unique symbol;
116
+
138
117
  /**
139
- * A component that represents a single row in a table, which contains the data cells.
118
+ * The table row component represents a single row of data within a table body. Use table row as a child of table body to structure individual records or entries in the table.
119
+ *
120
+ * Table row must contain table cell components, with each cell representing a data value for the corresponding column. The number of cells should match the number of headers in the table.
121
+ * @publicDocs
140
122
  */
141
- declare class TableRow extends PreactCustomElement implements TableRowProps {
142
- /**
143
- * Creates a new TableRow instance.
144
- */
123
+ declare class TableRow extends PolarisCustomElement implements TableRowProps {
124
+ /** @private */
125
+ [elementInternals]: ElementInternals;
145
126
  constructor();
146
- /**
147
- * A CSS selector for a child element that should handle clicks on the entire row. When you set this property, clicking anywhere on the row will trigger a click on the element that matches the selector.
148
- */
149
127
  accessor clickDelegate: string;
150
128
  }
151
129
  declare global {
@@ -162,19 +140,13 @@ declare module 'preact' {
162
140
  }
163
141
  }
164
142
 
165
- /**
166
- * The custom element tag name for the table row component.
167
- */
168
143
  declare const tagName = 's-table-row';
169
- /**
170
- * The JSX properties you can set on a table row component.
171
- * @publicDocs
172
- */
173
144
  export interface TableRowJSXProps
174
145
  extends Partial<TableRowProps>,
175
146
  Pick<TableRowProps$1, 'id' | 'children'> {
176
147
  /**
177
- * The content to display inside the row, which should include table cell components.
148
+ * The data cells displayed within this table row, with each cell containing content for its corresponding column.
149
+ * Only accepts table cell components as children.
178
150
  */
179
151
  children?: ComponentChildren;
180
152
  }
@@ -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 */
@@ -6,15 +6,69 @@
6
6
 
7
7
  // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
8
8
  /// <reference lib="DOM" />
9
- import type {ComponentChildren, TextProps$1} from './shared.d.ts';
9
+ import type {
10
+ ComponentChildren,
11
+ TextProps$1,
12
+ PreactCustomElement,
13
+ RenderImpl,
14
+ } from './shared.d.ts';
15
+ import * as preact$1 from 'preact';
16
+ import {ReactNode, RefAttributes} from 'react';
10
17
 
18
+ export type ReactIntrinsicElementChildren<PreactProps extends object> =
19
+ 'children' extends keyof PreactProps
20
+ ? {
21
+ children?: ReactNode;
22
+ }
23
+ : Record<never, never>;
24
+ export type ReactIntrinsicElementProps<
25
+ PreactProps extends object,
26
+ ElementType,
27
+ > = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
28
+ ReactIntrinsicElementChildren<PreactProps> &
29
+ RefAttributes<ElementType> & {
30
+ slot?: Lowercase<string>;
31
+ };
32
+ export type ReactIntrinsicElements = {
33
+ [Tag in Exclude<
34
+ Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
35
+ `s-test-${string}`
36
+ >]: ReactIntrinsicElementProps<
37
+ preact$1.createElement.JSX.IntrinsicElements[Tag],
38
+ Tag extends keyof HTMLElementTagNameMap
39
+ ? HTMLElementTagNameMap[Tag]
40
+ : HTMLElement
41
+ >;
42
+ };
43
+ declare module 'react' {
44
+ namespace JSX {
45
+ interface IntrinsicElements extends ReactIntrinsicElements {}
46
+ }
47
+ }
48
+
49
+ declare const typographyFontWeights: readonly [
50
+ 'auto',
51
+ 'base',
52
+ 'medium',
53
+ 'semibold',
54
+ 'bold',
55
+ ];
56
+ export type TypographyFontWeight = (typeof typographyFontWeights)[number];
57
+ declare const bodyFontSizes: readonly [
58
+ 'auto',
59
+ 'small-200',
60
+ 'small-100',
61
+ 'small',
62
+ 'base',
63
+ 'large',
64
+ 'large-100',
65
+ ];
66
+ export type BodyFontSize = (typeof bodyFontSizes)[number];
67
+
68
+ export type TextFontSize = BodyFontSize;
69
+ export type TextFontWeight = TypographyFontWeight;
11
70
  /**
12
- * The properties for the text component. These properties define inline or small blocks of text content with various visual styles and semantic meanings.
13
- * @publicDocs
14
- */
15
- /**
16
- * @publicDocs
17
- * @publicDocs
71
+ * Configure the following properties on the text component.
18
72
  */
19
73
  export interface TextProps
20
74
  extends Required<
@@ -29,16 +83,11 @@ export interface TextProps
29
83
  | 'interestFor'
30
84
  >
31
85
  > {
32
- /**
33
- * The color of the text. Available options:
34
- * - `'base'` - The default text color.
35
- * - `'subdued'` - A lighter text color for secondary information.
36
- */
37
86
  color: Extract<TextProps$1['color'], 'base' | 'subdued'>;
38
87
  /**
39
88
  * The semantic type and styling treatment for the text content.
40
89
  *
41
- * Other presentation properties on Text override the default styling.
90
+ * Other presentation properties on text override the default styling.
42
91
  *
43
92
  * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.
44
93
  * - `generic`: Standard text with no special semantic meaning or styling.
@@ -49,7 +98,7 @@ export interface TextProps
49
98
  */
50
99
  type: Extract<
51
100
  TextProps$1['type'],
52
- 'strong' | 'generic' | 'address' | 'redundant'
101
+ 'address' | 'redundant' | 'strong' | 'generic'
53
102
  >;
54
103
  /**
55
104
  * The semantic tone that's applied to the text, which changes its color to convey meaning.
@@ -66,193 +115,108 @@ export interface TextProps
66
115
  */
67
116
  tone: Extract<
68
117
  TextProps$1['tone'],
69
- 'info' | 'success' | 'warning' | 'critical' | 'auto' | 'neutral' | 'caution'
118
+ 'auto' | 'neutral' | 'info' | 'success' | 'warning' | 'caution' | 'critical'
70
119
  >;
71
120
  /**
72
- * The numeric font variant for the text. Available options:
73
- * - `'auto'` - The font variant is automatically determined.
74
- * - `'normal'` - Standard numeric rendering.
75
- * - `'tabular-nums'` - Monospaced numbers for better alignment in tables.
121
+ * @deprecated Use `Number` for inline numeric values instead.
76
122
  */
77
123
  fontVariantNumeric: Extract<
78
124
  TextProps$1['fontVariantNumeric'],
79
125
  'auto' | 'normal' | 'tabular-nums'
80
126
  >;
81
- }
82
-
83
- /**
84
- * A string containing CSS styles.
85
- * @publicDocs
86
- * @publicDocs
87
- */
88
- export type Styles = string;
89
- /**
90
- * The configuration for rendering a custom element with a shadow DOM.
91
- * @publicDocs
92
- * @publicDocs
93
- */
94
- export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
95
127
  /**
96
- * The function that renders the component's shadow DOM content.
97
- */
98
- ShadowRoot: (element: any) => ComponentChildren;
99
- /**
100
- * Optional CSS styles to apply to the shadow DOM.
101
- */
102
- styles?: Styles;
103
- };
104
- /**
105
- * An object that represents the state of modifier keys and mouse button
106
- * during an activation event like a click.
107
- * @publicDocs
108
- * @publicDocs
109
- */
110
- export interface ActivationEventEsque {
111
- /**
112
- * Whether the shift key was pressed during the event.
113
- */
114
- shiftKey: boolean;
115
- /**
116
- * Whether the meta (Command on Mac, Windows key on PC) key was pressed.
117
- */
118
- metaKey: boolean;
119
- /**
120
- * Whether the control key was pressed during the event.
121
- */
122
- ctrlKey: boolean;
123
- /**
124
- * The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
125
- */
126
- button: number;
127
- }
128
- /**
129
- * Options for customizing click behavior on an element.
130
- * @publicDocs
131
- * @publicDocs
132
- */
133
- export interface ClickOptions {
134
- /**
135
- * 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.
136
- */
137
- sourceEvent?: ActivationEventEsque;
138
- }
139
- /**
140
- * Base class for creating custom elements with Preact.
141
- * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
142
- * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
143
- */
144
- declare const BaseClass: typeof globalThis.HTMLElement;
145
- declare abstract class PreactCustomElement extends BaseClass {
146
- /** @private */
147
- static get observedAttributes(): string[];
148
- constructor({
149
- styles,
150
- ShadowRoot: renderFunction,
151
- delegatesFocus,
152
- ...options
153
- }: RenderImpl);
154
-
155
- /** @private */
156
- setAttribute(name: string, value: string): void;
157
- /** @private */
158
- attributeChangedCallback(name: string): void;
159
- /** @private */
160
- connectedCallback(): void;
161
- /** @private */
162
- disconnectedCallback(): void;
163
- /** @private */
164
- adoptedCallback(): void;
165
- /**
166
- * Queue a run of the render function.
167
- * You shouldn't need to call this manually - it should be handled by changes to @property values.
168
- * @private
128
+ * Font size of the text. The named values also apply their matching
129
+ * line-height and letter-spacing.
130
+ *
131
+ * @default 'auto'
169
132
  */
170
- queueRender(): void;
133
+ fontSize: TextFontSize;
171
134
  /**
172
- * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
135
+ * Font weight of the text.
173
136
  *
174
- * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
175
- * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
176
- * @private
177
- * @param options
137
+ * @default 'auto'
178
138
  */
179
- click({sourceEvent}?: ClickOptions): void;
139
+ fontWeight: TextFontWeight;
180
140
  }
181
141
 
182
142
  /**
183
- * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
184
- * @publicDocs
143
+ * 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.
185
144
  * @publicDocs
186
145
  */
187
146
  export interface PreactBaseElementProps<TClass extends HTMLElement> {
188
147
  /**
189
- * 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.
148
+ * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
149
+ * Essential for maintaining component state and optimizing re-renders when lists change.
190
150
  */
191
151
  key?: preact.Key;
192
152
  /**
193
- * 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.
153
+ * A reference to access the underlying DOM element directly.
154
+ * Typically created using `useRef()` to interact with the element imperatively or measure its properties.
194
155
  */
195
156
  ref?: preact.Ref<TClass>;
196
157
  /**
197
- * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
158
+ * The named slot to which this element is assigned in the parent component's shadow DOM.
159
+ *
160
+ * Used for advanced component composition with web components.
198
161
  */
199
162
  slot?: Lowercase<string>;
200
163
  }
201
164
  /**
202
- * The base properties for Preact elements that have children, extending the base element properties to include child content.
203
- * @publicDocs
165
+ * Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.
204
166
  * @publicDocs
205
167
  */
206
168
  export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
207
169
  extends PreactBaseElementProps<TClass> {
170
+ /**
171
+ * The child elements to be rendered within this component.
172
+ */
208
173
  children?: preact.ComponentChildren;
209
174
  }
210
175
 
211
- /**
212
- * A custom element for displaying inline or small blocks of text with various visual styles and semantic meanings. Use Text to render short pieces of content with appropriate styling, emphasis, and color treatment.
213
- */
214
- declare class Text extends PreactCustomElement implements TextProps {
176
+ declare class PolarisCustomElement extends PreactCustomElement {
177
+ constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
178
+ /** @private */
179
+ connectedCallback(): void;
180
+ /** @private */
181
+ adoptedCallback(): void;
182
+ }
183
+
184
+ declare abstract class TextBase
185
+ extends PolarisCustomElement
186
+ implements
187
+ Pick<
188
+ TextProps,
189
+ | 'fontVariantNumeric'
190
+ | 'fontSize'
191
+ | 'fontWeight'
192
+ | 'color'
193
+ | 'type'
194
+ | 'dir'
195
+ | 'accessibilityVisibility'
196
+ | 'interestFor'
197
+ >
198
+ {
199
+ accessor fontSize: TextProps['fontSize'];
200
+ accessor fontWeight: TextProps['fontWeight'];
215
201
  /**
216
- * The numeric font variant for the text.
202
+ * @deprecated Use `Number` for inline numeric values instead.
217
203
  */
218
204
  accessor fontVariantNumeric: TextProps['fontVariantNumeric'];
219
- /**
220
- * The color of the text.
221
- */
222
205
  accessor color: TextProps['color'];
223
- /**
224
- * The semantic tone that's applied to the text, which changes its color to convey meaning.
225
- *
226
- * - `info`: Informational content or helpful tips (blue).
227
- * - `success`: Positive outcomes or successful states (green).
228
- * - `warning`: Important warnings about potential issues (orange).
229
- * - `critical`: Urgent problems or destructive actions (red).
230
- * - `auto`: Automatically determined based on context.
231
- * - `neutral`: General information without specific intent (gray).
232
- * - `caution`: Advisory notices that need attention (yellow).
233
- */
234
- accessor tone: TextProps['tone'];
235
- /**
236
- * The semantic type and styling treatment for the text content.
237
- *
238
- * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.
239
- * - `generic`: Standard text with no special semantic meaning or styling.
240
- * - `address`: Marks the text as contact information, such as a physical or email address.
241
- * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.
242
- */
243
206
  accessor type: TextProps['type'];
244
- /**
245
- * The text direction (left-to-right or right-to-left).
246
- */
247
207
  accessor dir: TextProps['dir'];
248
- /**
249
- * The visibility of the element to assistive technologies.
250
- */
251
208
  accessor accessibilityVisibility: TextProps['accessibilityVisibility'];
252
- /**
253
- * The ID of an element this text provides contextual information for.
254
- */
255
209
  accessor interestFor: string;
210
+ abstract tone: string;
211
+ constructor(renderImpl: RenderImpl);
212
+ }
213
+
214
+ /**
215
+ * Configure the following properties on the text component.
216
+ * @publicDocs
217
+ */
218
+ declare class Text extends TextBase implements TextProps {
219
+ accessor tone: TextProps['tone'];
256
220
  constructor();
257
221
  }
258
222
  declare global {
@@ -269,16 +233,11 @@ declare module 'preact' {
269
233
  }
270
234
 
271
235
  declare const tagName = 's-text';
272
- /**
273
- * The JSX properties for the text component. These properties define how text is rendered in Preact or JSX.
274
- * @publicDocs
275
- * @publicDocs
276
- */
277
236
  export interface TextJSXProps
278
237
  extends Partial<TextProps>,
279
238
  Pick<TextProps$1, 'id' | 'children'> {
280
239
  /**
281
- * The content of the text.
240
+ * The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.
282
241
  */
283
242
  children?: ComponentChildren;
284
243
  }