@shopify/ui-extensions 2025.10.0-rc.46 → 2025.10.0-rc.48

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 (261) hide show
  1. package/build/cjs/surfaces/checkout/preact/api.js +1 -1
  2. package/build/cjs/surfaces/checkout/shared.js +1 -1
  3. package/build/esm/surfaces/checkout/preact/api.mjs +1 -1
  4. package/build/esm/surfaces/checkout/shared.mjs +1 -1
  5. package/build/esnext/surfaces/checkout/preact/api.esnext +1 -1
  6. package/build/esnext/surfaces/checkout/shared.esnext +1 -1
  7. package/build/ts/docs/shared/components/ConsentCheckbox.d.ts +4 -0
  8. package/build/ts/docs/shared/components/ConsentCheckbox.d.ts.map +1 -0
  9. package/build/ts/docs/shared/components/ConsentPhoneField.d.ts +4 -0
  10. package/build/ts/docs/shared/components/ConsentPhoneField.d.ts.map +1 -0
  11. package/build/ts/docs/shared/components/index.d.ts +2 -0
  12. package/build/ts/docs/shared/components/index.d.ts.map +1 -1
  13. package/build/ts/surfaces/admin/components/Chip.d.ts +1 -5
  14. package/build/ts/surfaces/admin/components/ClickableChip.d.ts +1 -5
  15. package/build/ts/surfaces/admin/components/ColorPicker.d.ts +1 -5
  16. package/build/ts/surfaces/admin/components/DateField.d.ts +1 -5
  17. package/build/ts/surfaces/admin/components/Menu.d.ts +1 -5
  18. package/build/ts/surfaces/admin/components/Modal.d.ts +1 -5
  19. package/build/ts/surfaces/admin/components/QueryContainer.d.ts +1 -5
  20. package/build/ts/surfaces/admin/components/shared.d.ts +30 -6
  21. package/build/ts/surfaces/checkout/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts +4 -0
  22. package/build/ts/surfaces/checkout/components/ConsentCheckbox/ConsentCheckbox.doc.d.ts.map +1 -0
  23. package/build/ts/surfaces/checkout/components/ConsentCheckbox.d.ts +84 -0
  24. package/build/ts/surfaces/checkout/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts +4 -0
  25. package/build/ts/surfaces/checkout/components/ConsentPhoneField/ConsentPhoneField.doc.d.ts.map +1 -0
  26. package/build/ts/surfaces/checkout/components/ConsentPhoneField.d.ts +129 -0
  27. package/build/ts/surfaces/checkout/components/NumberField/NumberField.doc.d.ts +4 -0
  28. package/build/ts/surfaces/checkout/components/NumberField/NumberField.doc.d.ts.map +1 -0
  29. package/build/ts/surfaces/checkout/components/NumberField.d.ts +98 -0
  30. package/build/ts/surfaces/checkout/components/PasswordField.d.ts +1 -1
  31. package/build/ts/surfaces/checkout/components/components-shared.d.ts +17 -0
  32. package/build/ts/surfaces/checkout/components/components.d.ts +216 -144
  33. package/build/ts/surfaces/checkout/shared.d.ts +1 -1
  34. package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
  35. package/build/ts/surfaces/checkout/targets/Checkout::Actions::RenderBefore.d.ts +3 -0
  36. package/build/ts/surfaces/checkout/targets/Checkout::CartLineDetails::RenderAfter.d.ts +3 -0
  37. package/build/ts/surfaces/checkout/targets/Checkout::CartLineDetails::RenderLineComponents.d.ts +3 -0
  38. package/build/ts/surfaces/checkout/targets/Checkout::CartLines::RenderAfter.d.ts +3 -0
  39. package/build/ts/surfaces/checkout/targets/Checkout::Contact::RenderAfter.d.ts +3 -0
  40. package/build/ts/surfaces/checkout/targets/Checkout::CustomerInformation::RenderAfter.d.ts +3 -0
  41. package/build/ts/surfaces/checkout/targets/Checkout::DeliveryAddress::RenderBefore.d.ts +3 -0
  42. package/build/ts/surfaces/checkout/targets/Checkout::Dynamic::Render.d.ts +3 -0
  43. package/build/ts/surfaces/checkout/targets/Checkout::GiftCard::Render.d.ts +3 -0
  44. package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::HostedFields::RenderAfter.d.ts +3 -0
  45. package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::Render.d.ts +3 -0
  46. package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::RenderRequiredAction.d.ts +3 -0
  47. package/build/ts/surfaces/checkout/targets/Checkout::PickupLocations::RenderAfter.d.ts +3 -0
  48. package/build/ts/surfaces/checkout/targets/Checkout::PickupLocations::RenderBefore.d.ts +3 -0
  49. package/build/ts/surfaces/checkout/targets/Checkout::PickupPoints::RenderAfter.d.ts +3 -0
  50. package/build/ts/surfaces/checkout/targets/Checkout::PickupPoints::RenderBefore.d.ts +3 -0
  51. package/build/ts/surfaces/checkout/targets/Checkout::Reductions::RenderAfter.d.ts +3 -0
  52. package/build/ts/surfaces/checkout/targets/Checkout::Reductions::RenderBefore.d.ts +3 -0
  53. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethodDetails::RenderAfter.d.ts +3 -0
  54. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethodDetails::RenderExpanded.d.ts +3 -0
  55. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethods::RenderAfter.d.ts +3 -0
  56. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethods::RenderBefore.d.ts +3 -0
  57. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CartLineDetails::RenderAfter.d.ts +3 -0
  58. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CartLines::RenderAfter.d.ts +3 -0
  59. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CustomerInformation::RenderAfter.d.ts +3 -0
  60. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::Dynamic::Render.d.ts +3 -0
  61. package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +3 -0
  62. package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +3 -0
  63. package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +3 -0
  64. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +3 -0
  65. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +3 -0
  66. package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +3 -0
  67. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +3 -0
  68. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +3 -0
  69. package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +3 -0
  70. package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +3 -0
  71. package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +3 -0
  72. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +3 -0
  73. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +3 -0
  74. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +3 -0
  75. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +3 -0
  76. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +3 -0
  77. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +3 -0
  78. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +3 -0
  79. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +3 -0
  80. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +3 -0
  81. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +3 -0
  82. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +3 -0
  83. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +3 -0
  84. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +3 -0
  85. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +3 -0
  86. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +3 -0
  87. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +3 -0
  88. package/build/ts/surfaces/checkout/targets/purchase.thank-you.announcement.render.d.ts +3 -0
  89. package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +3 -0
  90. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +3 -0
  91. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +3 -0
  92. package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +3 -0
  93. package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +3 -0
  94. package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +3 -0
  95. package/build/ts/surfaces/customer-account/components/ConsentCheckbox.d.ts +84 -0
  96. package/build/ts/surfaces/customer-account/components/ConsentPhoneField.d.ts +129 -0
  97. package/build/ts/surfaces/customer-account/components/NumberField.d.ts +98 -0
  98. package/build/ts/surfaces/customer-account/components/PasswordField.d.ts +1 -1
  99. package/build/ts/surfaces/customer-account/components/components-shared.d.ts +17 -0
  100. package/build/ts/surfaces/customer-account/components/components.d.ts +216 -144
  101. package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +3 -0
  102. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +3 -0
  103. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +3 -0
  104. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +3 -0
  105. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +3 -0
  106. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +3 -0
  107. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +3 -0
  108. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +3 -0
  109. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +3 -0
  110. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +3 -0
  111. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +3 -0
  112. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +3 -0
  113. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +3 -0
  114. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +3 -0
  115. package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +3 -0
  116. package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +3 -0
  117. package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +3 -0
  118. package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +3 -0
  119. package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +3 -0
  120. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +3 -0
  121. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +3 -0
  122. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +3 -0
  123. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +3 -0
  124. package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +3 -0
  125. package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +10 -1
  126. package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +12 -4
  127. package/build/ts/surfaces/point-of-sale/components/Box.d.ts +51 -14
  128. package/build/ts/surfaces/point-of-sale/components/Button.d.ts +12 -2
  129. package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +3 -2
  130. package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +12 -5
  131. package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +11 -4
  132. package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +17 -8
  133. package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +14 -6
  134. package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +10 -6
  135. package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +4 -3
  136. package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +17 -7
  137. package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +7 -4
  138. package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +13 -3
  139. package/build/ts/surfaces/point-of-sale/components/Image.d.ts +12 -5
  140. package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +28 -7
  141. package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +17 -7
  142. package/build/ts/surfaces/point-of-sale/components/Page.d.ts +25 -11
  143. package/build/ts/surfaces/point-of-sale/components/PosBlock/PosBlock.doc.d.ts.map +1 -1
  144. package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +12 -13
  145. package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +12 -8
  146. package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +47 -15
  147. package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +15 -7
  148. package/build/ts/surfaces/point-of-sale/components/Section.d.ts +15 -9
  149. package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +67 -7
  150. package/build/ts/surfaces/point-of-sale/components/Text.d.ts +25 -4
  151. package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +17 -7
  152. package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +9 -7
  153. package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +12 -2
  154. package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +14 -6
  155. package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +14 -6
  156. package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +102 -1
  157. package/build/tsconfig.tsbuildinfo +1 -1
  158. package/package.json +2 -1
  159. package/src/docs/shared/components/ConsentCheckbox.ts +12 -0
  160. package/src/docs/shared/components/ConsentPhoneField.ts +12 -0
  161. package/src/docs/shared/components/index.ts +2 -0
  162. package/src/surfaces/admin/components/Chip.d.ts +1 -5
  163. package/src/surfaces/admin/components/ClickableChip.d.ts +1 -5
  164. package/src/surfaces/admin/components/ColorPicker.d.ts +1 -5
  165. package/src/surfaces/admin/components/DateField.d.ts +1 -5
  166. package/src/surfaces/admin/components/Menu.d.ts +1 -5
  167. package/src/surfaces/admin/components/Modal.d.ts +1 -5
  168. package/src/surfaces/admin/components/QueryContainer.d.ts +1 -5
  169. package/src/surfaces/admin/components/shared.d.ts +30 -6
  170. package/src/surfaces/admin/components.d.ts +64 -152
  171. package/src/surfaces/checkout/components/ConsentCheckbox/examples/basic-consent-checkbox.example.html +5 -0
  172. package/src/surfaces/checkout/components/ConsentCheckbox.d.ts +84 -0
  173. package/src/surfaces/checkout/components/ConsentPhoneField/examples/basic-consent-phone-field.example.html +5 -0
  174. package/src/surfaces/checkout/components/ConsentPhoneField.d.ts +129 -0
  175. package/src/surfaces/checkout/components/NumberField/examples/basic-number-field.example.html +8 -0
  176. package/src/surfaces/checkout/components/NumberField.d.ts +98 -0
  177. package/src/surfaces/checkout/components/PasswordField.d.ts +1 -1
  178. package/src/surfaces/checkout/components/PhoneField/examples/basic-phone-field.example.html +2 -1
  179. package/src/surfaces/checkout/components/ProductThumbnail/examples/basic-product-thumbnail.example.html +4 -1
  180. package/src/surfaces/checkout/components/Stack/examples/basic-stack.example.html +20 -4
  181. package/src/surfaces/checkout/components/TextArea/examples/basic-text-area.example.html +5 -1
  182. package/src/surfaces/checkout/components/TextField/examples/basic-text-field.example.html +4 -1
  183. package/src/surfaces/checkout/components/components-shared.d.ts +17 -0
  184. package/src/surfaces/checkout/components/components.d.ts +216 -144
  185. package/src/surfaces/checkout/preact/api.ts +1 -1
  186. package/src/surfaces/checkout/preact/tests/api.test.tsx +22 -13
  187. package/src/surfaces/checkout/preact/tests/app-metafields.test.ts +52 -56
  188. package/src/surfaces/checkout/preact/tests/attributes.test.ts +34 -24
  189. package/src/surfaces/checkout/preact/tests/billing-address.test.ts +17 -7
  190. package/src/surfaces/checkout/preact/tests/buyer-identity-businessCustomer.test.ts +16 -9
  191. package/src/surfaces/checkout/preact/tests/buyer-identity.test.tsx +57 -26
  192. package/src/surfaces/checkout/preact/tests/buyer-journey.test.ts +71 -74
  193. package/src/surfaces/checkout/preact/tests/capabilities.test.ts +32 -28
  194. package/src/surfaces/checkout/preact/tests/cart-line-target.test.ts +31 -24
  195. package/src/surfaces/checkout/preact/tests/checkout-settings.test.ts +17 -9
  196. package/src/surfaces/checkout/preact/tests/checkout-token.test.ts +16 -6
  197. package/src/surfaces/checkout/preact/tests/configuration.test.ts +16 -6
  198. package/src/surfaces/checkout/preact/tests/country.test.tsx +18 -8
  199. package/src/surfaces/checkout/preact/tests/currency.test.tsx +18 -8
  200. package/src/surfaces/checkout/preact/tests/customer-privacy.test.ts +17 -8
  201. package/src/surfaces/checkout/preact/tests/delivery-group-list-target.test.ts +24 -18
  202. package/src/surfaces/checkout/preact/tests/delivery-group-target.test.ts +25 -19
  203. package/src/surfaces/checkout/preact/tests/delivery-group.test.ts +22 -16
  204. package/src/surfaces/checkout/preact/tests/delivery-groups.test.ts +17 -11
  205. package/src/surfaces/checkout/preact/tests/delivery-selection-groups.test.ts +31 -24
  206. package/src/surfaces/checkout/preact/tests/discounts.test.tsx +21 -14
  207. package/src/surfaces/checkout/preact/tests/extension-language.test.tsx +17 -8
  208. package/src/surfaces/checkout/preact/tests/gift-cards.test.tsx +17 -8
  209. package/src/surfaces/checkout/preact/tests/localized-fields.test.ts +58 -59
  210. package/src/surfaces/checkout/preact/tests/market.test.tsx +17 -7
  211. package/src/surfaces/checkout/preact/tests/metafield.test.tsx +33 -36
  212. package/src/surfaces/checkout/preact/tests/metafields.test.tsx +36 -53
  213. package/src/surfaces/checkout/preact/tests/mount.tsx +60 -17
  214. package/src/surfaces/checkout/preact/tests/notes.test.tsx +16 -6
  215. package/src/surfaces/checkout/preact/tests/payment-method.test.ts +87 -60
  216. package/src/surfaces/checkout/preact/tests/payment-options.test.tsx +26 -24
  217. package/src/surfaces/checkout/preact/tests/pickup-location-option-target.test.tsx +55 -46
  218. package/src/surfaces/checkout/preact/tests/redeemable.test.ts +30 -23
  219. package/src/surfaces/checkout/preact/tests/session-token.test.tsx +12 -6
  220. package/src/surfaces/checkout/preact/tests/shipping-address.test.ts +17 -7
  221. package/src/surfaces/checkout/preact/tests/shipping-option-target.test.ts +54 -50
  222. package/src/surfaces/checkout/preact/tests/shopping-address.test.tsx +18 -10
  223. package/src/surfaces/checkout/preact/tests/timezone.test.tsx +17 -7
  224. package/src/surfaces/checkout/preact/tests/translate.test.tsx +18 -13
  225. package/src/surfaces/checkout/preact/tests/tsconfig.json +1 -1
  226. package/src/surfaces/checkout/shared.ts +2 -0
  227. package/src/surfaces/point-of-sale/components/Badge.d.ts +10 -1
  228. package/src/surfaces/point-of-sale/components/Banner.d.ts +12 -4
  229. package/src/surfaces/point-of-sale/components/Box.d.ts +51 -14
  230. package/src/surfaces/point-of-sale/components/Button.d.ts +12 -2
  231. package/src/surfaces/point-of-sale/components/Choice.d.ts +3 -2
  232. package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +12 -5
  233. package/src/surfaces/point-of-sale/components/Clickable.d.ts +11 -4
  234. package/src/surfaces/point-of-sale/components/DateField.d.ts +17 -8
  235. package/src/surfaces/point-of-sale/components/DatePicker.d.ts +14 -6
  236. package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +10 -6
  237. package/src/surfaces/point-of-sale/components/Divider.d.ts +4 -3
  238. package/src/surfaces/point-of-sale/components/EmailField.d.ts +17 -7
  239. package/src/surfaces/point-of-sale/components/Heading.d.ts +7 -4
  240. package/src/surfaces/point-of-sale/components/Icon.d.ts +13 -3
  241. package/src/surfaces/point-of-sale/components/Image.d.ts +12 -5
  242. package/src/surfaces/point-of-sale/components/Modal.d.ts +28 -7
  243. package/src/surfaces/point-of-sale/components/NumberField.d.ts +17 -7
  244. package/src/surfaces/point-of-sale/components/Page.d.ts +25 -11
  245. package/src/surfaces/point-of-sale/components/PosBlock.d.ts +12 -13
  246. package/src/surfaces/point-of-sale/components/QrCode.d.ts +12 -8
  247. package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +47 -15
  248. package/src/surfaces/point-of-sale/components/SearchField.d.ts +15 -7
  249. package/src/surfaces/point-of-sale/components/Section.d.ts +15 -9
  250. package/src/surfaces/point-of-sale/components/Stack.d.ts +67 -7
  251. package/src/surfaces/point-of-sale/components/Text.d.ts +25 -4
  252. package/src/surfaces/point-of-sale/components/TextArea.d.ts +17 -7
  253. package/src/surfaces/point-of-sale/components/TextField.d.ts +9 -7
  254. package/src/surfaces/point-of-sale/components/Tile.d.ts +12 -2
  255. package/src/surfaces/point-of-sale/components/TimeField.d.ts +14 -6
  256. package/src/surfaces/point-of-sale/components/TimePicker.d.ts +14 -6
  257. package/src/surfaces/point-of-sale/components/components-shared.d.ts +102 -1
  258. package/src/surfaces/point-of-sale/components.d.ts +869 -481
  259. package/build/ts/surfaces/checkout/errors.d.ts +0 -10
  260. package/build/ts/surfaces/checkout/errors.d.ts.map +0 -1
  261. package/src/surfaces/checkout/errors.ts +0 -13
@@ -26,13 +26,22 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
 
30
31
  declare const tagName = 's-badge';
31
32
  export interface BadgeJSXProps extends Pick<BadgeProps, 'id'> {
33
+ /**
34
+ * Sets the tone of the Badge, based on the intention of the information being conveyed.
35
+ *
36
+ * @default 'auto'
37
+ */
32
38
  tone?: Extract<
33
39
  BadgeProps['tone'],
34
40
  'auto' | 'neutral' | 'info' | 'success' | 'warning' | 'critical' | 'caution'
35
41
  >;
42
+ /**
43
+ * The content of the Badge.
44
+ */
36
45
  children?: ComponentChildren;
37
46
  }
38
47
  declare global {
@@ -43,7 +52,7 @@ declare global {
43
52
  declare module 'preact' {
44
53
  namespace createElement.JSX {
45
54
  interface IntrinsicElements {
46
- [tagName]: BadgeJSXProps & BaseElementPropsWithChildren<BadgeJSXProps>;
55
+ [tagName]: IntrinsicElementProps<BadgeJSXProps>;
47
56
  }
48
57
  }
49
58
  }
@@ -31,36 +31,44 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
31
31
  extends BaseElementProps<TClass> {
32
32
  children?: ComponentChildren;
33
33
  }
34
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
34
35
 
35
36
  declare const tagName = 's-banner';
36
37
  export interface BannerJSXProps extends Pick<BannerProps, 'heading' | 'id'> {
37
38
  /**
38
39
  * Determines whether the banner is hidden.
40
+ *
41
+ * @default false
39
42
  */
40
43
  hidden?: BannerProps['hidden'];
41
44
  /**
42
45
  * Sets the tone of the Banner, based on the intention of the information being conveyed.
46
+ *
47
+ * @default 'auto'
43
48
  */
44
49
  tone?: Extract<
45
50
  BannerProps['tone'],
46
- 'success' | 'info' | 'warning' | 'critical'
51
+ 'auto' | 'success' | 'info' | 'warning' | 'critical'
47
52
  >;
48
53
  /**
49
54
  * The action taken when the Banner is pressed.
50
55
  */
51
56
  primaryAction?: ComponentChild;
57
+ /**
58
+ * The content of the Banner.
59
+ */
52
60
  children?: ComponentChildren;
53
61
  }
62
+ export type ElementProps = Omit<BannerJSXProps, 'primaryAction'>;
54
63
  declare global {
55
64
  interface HTMLElementTagNameMap {
56
- [tagName]: BannerJSXProps;
65
+ [tagName]: ElementProps;
57
66
  }
58
67
  }
59
68
  declare module 'preact' {
60
69
  namespace createElement.JSX {
61
70
  interface IntrinsicElements {
62
- [tagName]: Omit<BannerJSXProps, 'primaryAction'> &
63
- BaseElementPropsWithChildren<Omit<BannerJSXProps, 'primaryAction'>>;
71
+ [tagName]: IntrinsicElementProps<ElementProps>;
64
72
  }
65
73
  }
66
74
  }
@@ -9,7 +9,9 @@
9
9
  // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
10
10
  /// <reference lib="DOM" />
11
11
  import type {
12
- BoxProps,
12
+ SizeUnitsOrAuto,
13
+ SizeUnitsOrNone,
14
+ SizeUnits,
13
15
  SizeKeyword,
14
16
  MaybeAllValuesShorthandProperty,
15
17
  MaybeTwoValuesShorthandProperty,
@@ -33,19 +35,51 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
33
35
  extends BaseElementProps<TClass> {
34
36
  children?: ComponentChildren;
35
37
  }
38
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
36
39
 
37
40
  declare const tagName = 's-box';
38
41
  export type PaddingKeyword = SizeKeyword | 'none';
39
- export interface BoxJSXProps
40
- extends Pick<
41
- BoxProps,
42
- | 'blockSize'
43
- | 'minBlockSize'
44
- | 'maxBlockSize'
45
- | 'inlineSize'
46
- | 'minInlineSize'
47
- | 'maxInlineSize'
48
- > {
42
+ export interface BoxJSXProps {
43
+ /**
44
+ * A unique identifier for the element.
45
+ */
46
+ id?: string;
47
+ /**
48
+ * Adjust the block size.
49
+ *
50
+ * @default 'auto'
51
+ */
52
+ blockSize?: SizeUnitsOrAuto;
53
+ /**
54
+ * Adjust the inline size.
55
+ *
56
+ * @default 'auto'
57
+ */
58
+ inlineSize?: SizeUnitsOrAuto;
59
+ /**
60
+ * Adjust the maximum block size.
61
+ *
62
+ * @default 'none'
63
+ */
64
+ maxBlockSize?: SizeUnitsOrNone;
65
+ /**
66
+ * Adjust the maximum inline size.
67
+ *
68
+ * @default 'none'
69
+ */
70
+ maxInlineSize?: SizeUnitsOrNone;
71
+ /**
72
+ * Adjust the minimum block size.
73
+ *
74
+ * @default '0'
75
+ */
76
+ minBlockSize?: SizeUnits;
77
+ /**
78
+ * Adjust the minimum inline size.
79
+ *
80
+ * @default '0'
81
+ */
82
+ minInlineSize?: SizeUnits;
49
83
  /**
50
84
  * Adjust the padding of all edges.
51
85
  *
@@ -76,7 +110,7 @@ export interface BoxJSXProps
76
110
  *
77
111
  * @default '' - meaning no override
78
112
  */
79
- paddingBlock?: MaybeTwoValuesShorthandProperty<PaddingKeyword | ''>;
113
+ paddingBlock?: MaybeTwoValuesShorthandProperty<PaddingKeyword> | '';
80
114
  /**
81
115
  * Adjust the block-start padding.
82
116
  *
@@ -102,7 +136,7 @@ export interface BoxJSXProps
102
136
  *
103
137
  * @default '' - meaning no override
104
138
  */
105
- paddingInline?: MaybeTwoValuesShorthandProperty<PaddingKeyword | ''>;
139
+ paddingInline?: MaybeTwoValuesShorthandProperty<PaddingKeyword> | '';
106
140
  /**
107
141
  * Adjust the inline-start padding.
108
142
  *
@@ -119,6 +153,9 @@ export interface BoxJSXProps
119
153
  * @default '' - meaning no override
120
154
  */
121
155
  paddingInlineEnd?: PaddingKeyword | '';
156
+ /**
157
+ * The content of the Box.
158
+ */
122
159
  children?: ComponentChildren;
123
160
  }
124
161
  declare global {
@@ -129,7 +166,7 @@ declare global {
129
166
  declare module 'preact' {
130
167
  namespace createElement.JSX {
131
168
  interface IntrinsicElements {
132
- [tagName]: BoxJSXProps & BaseElementPropsWithChildren<BoxJSXProps>;
169
+ [tagName]: IntrinsicElementProps<BoxJSXProps>;
133
170
  }
134
171
  }
135
172
  }
@@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
30
31
  currentTarget: HTMLElementTagNameMap[T];
31
32
  bubbles?: boolean;
@@ -38,7 +39,10 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
38
39
 
39
40
  declare const tagName = 's-button';
40
41
  export interface ButtonJSXProps
41
- extends Pick<ButtonProps, 'disabled' | 'command' | 'commandFor' | 'loading'> {
42
+ extends Pick<
43
+ ButtonProps,
44
+ 'id' | 'disabled' | 'command' | 'commandFor' | 'loading'
45
+ > {
42
46
  /**
43
47
  * Sets the action the `commandFor` should take when this clickable is activated.
44
48
  *
@@ -72,7 +76,13 @@ export interface ButtonJSXProps
72
76
  * @default 'auto' - the variant is automatically determined by the Button's context
73
77
  */
74
78
  variant?: Extract<ButtonProps['variant'], 'primary' | 'secondary'>;
79
+ /**
80
+ * Called when the button is activated.
81
+ */
75
82
  onClick?: (event: CallbackEvent<typeof tagName>) => void;
83
+ /**
84
+ * The content of the Button.
85
+ */
76
86
  children?: ComponentChildren;
77
87
  }
78
88
  declare global {
@@ -83,7 +93,7 @@ declare global {
83
93
  declare module 'preact' {
84
94
  namespace createElement.JSX {
85
95
  interface IntrinsicElements {
86
- [tagName]: ButtonJSXProps & BaseElementPropsWithChildren<ButtonJSXProps>;
96
+ [tagName]: IntrinsicElementProps<ButtonJSXProps>;
87
97
  }
88
98
  }
89
99
  }
@@ -26,10 +26,11 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
 
30
31
  declare const tagName = 's-choice';
31
32
  export interface ChoiceJSXProps
32
- extends Pick<ChoiceProps, 'value' | 'disabled' | 'selected'> {
33
+ extends Pick<ChoiceProps, 'id' | 'value' | 'disabled' | 'selected'> {
33
34
  children?: ComponentChildren;
34
35
  }
35
36
  declare global {
@@ -40,7 +41,7 @@ declare global {
40
41
  declare module 'preact' {
41
42
  namespace createElement.JSX {
42
43
  interface IntrinsicElements {
43
- [tagName]: ChoiceJSXProps & BaseElementPropsWithChildren<ChoiceJSXProps>;
44
+ [tagName]: IntrinsicElementProps<ChoiceJSXProps>;
44
45
  }
45
46
  }
46
47
  }
@@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
30
31
  currentTarget: HTMLElementTagNameMap[T];
31
32
  bubbles?: boolean;
@@ -38,11 +39,18 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
38
39
 
39
40
  declare const tagName = 's-choice-list';
40
41
  export interface ChoiceListJSXProps
41
- extends Pick<ChoiceListProps, 'values' | 'multiple'> {
42
- /** Function called when the user changes a choice. Fires simultaneously with onChange. */
42
+ extends Pick<ChoiceListProps, 'id' | 'values' | 'multiple'> {
43
+ /**
44
+ * Callback when the user changes a choice. Fires simultaneously with onChange.
45
+ */
43
46
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
44
- /** Function called when the user changes a choice. Fires simultaneously with onInput. */
47
+ /**
48
+ * Callback when the user changes a choice. Fires simultaneously with onInput.
49
+ */
45
50
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
51
+ /**
52
+ * The content of the ChoiceList. Should be one or more Choice elements.
53
+ */
46
54
  children?: ComponentChildren;
47
55
  }
48
56
  declare global {
@@ -53,8 +61,7 @@ declare global {
53
61
  declare module 'preact' {
54
62
  namespace createElement.JSX {
55
63
  interface IntrinsicElements {
56
- [tagName]: ChoiceListJSXProps &
57
- BaseElementPropsWithChildren<ChoiceListJSXProps>;
64
+ [tagName]: IntrinsicElementProps<ChoiceListJSXProps>;
58
65
  }
59
66
  }
60
67
  }
@@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
30
31
  currentTarget: HTMLElementTagNameMap[T];
31
32
  bubbles?: boolean;
@@ -37,9 +38,16 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
37
38
  }
38
39
 
39
40
  declare const tagName = 's-clickable';
40
- export interface ClickableJSXProps extends Pick<ClickableProps, 'disabled'> {
41
- children?: ComponentChildren;
41
+ export interface ClickableJSXProps
42
+ extends Pick<ClickableProps, 'id' | 'disabled'> {
43
+ /**
44
+ * Callback when the element is activated.
45
+ */
42
46
  onClick?: (event: CallbackEvent<typeof tagName>) => void;
47
+ /**
48
+ * The content of the Clickable.
49
+ */
50
+ children?: ComponentChildren;
43
51
  }
44
52
  declare global {
45
53
  interface HTMLElementTagNameMap {
@@ -49,8 +57,7 @@ declare global {
49
57
  declare module 'preact' {
50
58
  namespace createElement.JSX {
51
59
  interface IntrinsicElements {
52
- [tagName]: ClickableJSXProps &
53
- BaseElementPropsWithChildren<ClickableJSXProps>;
60
+ [tagName]: IntrinsicElementProps<ClickableJSXProps>;
54
61
  }
55
62
  }
56
63
  }
@@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
30
31
  currentTarget: HTMLElementTagNameMap[T];
31
32
  bubbles?: boolean;
@@ -40,27 +41,35 @@ declare const tagName = 's-date-field';
40
41
  export interface DateFieldJSXProps
41
42
  extends Pick<
42
43
  DateFieldProps,
43
- 'label' | 'details' | 'value' | 'disabled' | 'error'
44
+ 'id' | 'label' | 'details' | 'value' | 'disabled' | 'error'
44
45
  > {
45
- /** Function called when the user makes any changes in the field. */
46
+ /**
47
+ * Callback when the user makes any changes in the field.
48
+ */
46
49
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
47
- /** Function called after editing completes (typically on blur). */
50
+ /**
51
+ * Callback after editing completes (typically on blur).
52
+ */
48
53
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
49
- /** Function called when the element loses focus. */
54
+ /**
55
+ * Callback when the element loses focus.
56
+ */
50
57
  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
51
- /** Function called when the element receives focus. */
58
+ /**
59
+ * Callback when the element receives focus.
60
+ */
52
61
  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
53
62
  }
63
+ export type ElementProps = Omit<DateFieldJSXProps, 'accessory'>;
54
64
  declare global {
55
65
  interface HTMLElementTagNameMap {
56
- [tagName]: DateFieldJSXProps;
66
+ [tagName]: ElementProps;
57
67
  }
58
68
  }
59
69
  declare module 'preact' {
60
70
  namespace createElement.JSX {
61
71
  interface IntrinsicElements {
62
- [tagName]: Omit<DateFieldJSXProps, 'accessory'> &
63
- BaseElementPropsWithChildren<Omit<DateFieldJSXProps, 'accessory'>>;
72
+ [tagName]: IntrinsicElementProps<ElementProps>;
64
73
  }
65
74
  }
66
75
  }
@@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
30
31
  currentTarget: HTMLElementTagNameMap[T];
31
32
  bubbles?: boolean;
@@ -39,13 +40,21 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
39
40
  declare const tagName = 's-date-picker';
40
41
  export interface DatePickerJSXProps
41
42
  extends Pick<DatePickerProps, 'id' | 'value'> {
42
- /** Function called when the user selects a date from the picker. */
43
+ /**
44
+ * Callback when the user selects a date from the picker.
45
+ */
43
46
  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
44
- /** Function called when the user selects a date from the picker that is different to the current value. */
47
+ /**
48
+ * Callback when the user selects a date from the picker that is different to the current value.
49
+ */
45
50
  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
46
- /** Function called when the date picker is dismissed. */
51
+ /**
52
+ * Callback when the date picker is dismissed.
53
+ */
47
54
  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
48
- /** Function called when the date picker is revealed. */
55
+ /**
56
+ * Callback when the date picker is revealed.
57
+ */
49
58
  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
50
59
  }
51
60
  declare global {
@@ -56,8 +65,7 @@ declare global {
56
65
  declare module 'preact' {
57
66
  namespace createElement.JSX {
58
67
  interface IntrinsicElements {
59
- [tagName]: DatePickerJSXProps &
60
- BaseElementPropsWithChildren<DatePickerJSXProps>;
68
+ [tagName]: IntrinsicElementProps<DatePickerJSXProps>;
61
69
  }
62
70
  }
63
71
  }
@@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
30
31
  currentTarget: HTMLElementTagNameMap[T];
31
32
  bubbles?: boolean;
@@ -40,16 +41,20 @@ declare const tagName = 's-date-spinner';
40
41
  export interface DateSpinnerJSXProps
41
42
  extends Pick<DateSpinnerProps, 'id' | 'value'> {
42
43
  /**
43
- * Function called when the user makes a selection.
44
+ * Callback when the user makes a selection.
44
45
  */
45
46
  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
46
47
  /**
47
- * Function called when the value changes. Only called when a different value is selected.
48
+ * Callback when the value changes. Only called when a different value is selected.
48
49
  */
49
50
  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
50
- /** Function called when the date picker is dismissed. */
51
+ /**
52
+ * Callback when the date spinner is dismissed.
53
+ */
51
54
  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
52
- /** Function called when the date picker is revealed. */
55
+ /**
56
+ * Callback when the date spinner is revealed.
57
+ */
53
58
  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
54
59
  }
55
60
  declare global {
@@ -60,8 +65,7 @@ declare global {
60
65
  declare module 'preact' {
61
66
  namespace createElement.JSX {
62
67
  interface IntrinsicElements {
63
- [tagName]: DateSpinnerJSXProps &
64
- BaseElementPropsWithChildren<DateSpinnerJSXProps>;
68
+ [tagName]: IntrinsicElementProps<DateSpinnerJSXProps>;
65
69
  }
66
70
  }
67
71
  }
@@ -26,9 +26,11 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
 
30
31
  declare const tagName = 's-divider';
31
- export interface DividerJSXProps extends Pick<DividerProps, 'direction'> {}
32
+ export interface DividerJSXProps
33
+ extends Pick<DividerProps, 'id' | 'direction'> {}
32
34
  declare global {
33
35
  interface HTMLElementTagNameMap {
34
36
  [tagName]: DividerJSXProps;
@@ -37,8 +39,7 @@ declare global {
37
39
  declare module 'preact' {
38
40
  namespace createElement.JSX {
39
41
  interface IntrinsicElements {
40
- [tagName]: DividerJSXProps &
41
- BaseElementPropsWithChildren<DividerJSXProps>;
42
+ [tagName]: IntrinsicElementProps<DividerJSXProps>;
42
43
  }
43
44
  }
44
45
  }
@@ -31,6 +31,7 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
31
31
  extends BaseElementProps<TClass> {
32
32
  children?: ComponentChildren;
33
33
  }
34
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
34
35
  export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
35
36
  currentTarget: HTMLElementTagNameMap[T];
36
37
  bubbles?: boolean;
@@ -45,6 +46,7 @@ declare const tagName = 's-email-field';
45
46
  export interface EmailFieldJSXProps
46
47
  extends Pick<
47
48
  EmailFieldProps,
49
+ | 'id'
48
50
  | 'label'
49
51
  | 'value'
50
52
  | 'placeholder'
@@ -54,29 +56,37 @@ export interface EmailFieldJSXProps
54
56
  | 'maxLength'
55
57
  | 'details'
56
58
  > {
57
- /** Function called when the user makes any changes in the field. */
59
+ /**
60
+ * Callback when the user makes any changes in the field.
61
+ */
58
62
  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
59
- /** Function called after editing completes (typically on blur). */
63
+ /**
64
+ * Callback after editing completes (typically on blur).
65
+ */
60
66
  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
61
- /** Function called when the element loses focus. */
67
+ /**
68
+ * Callback when the element loses focus.
69
+ */
62
70
  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
63
- /** Function called when the element receives focus. */
71
+ /**
72
+ * Callback when the element receives focus.
73
+ */
64
74
  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
65
75
  /**
66
76
  * Additional content to be displayed in the field. Commonly used to display clickable text.
67
77
  */
68
78
  accessory?: ComponentChild;
69
79
  }
80
+ export type ElementProps = Omit<EmailFieldJSXProps, 'accessory'>;
70
81
  declare global {
71
82
  interface HTMLElementTagNameMap {
72
- [tagName]: EmailFieldJSXProps;
83
+ [tagName]: ElementProps;
73
84
  }
74
85
  }
75
86
  declare module 'preact' {
76
87
  namespace createElement.JSX {
77
88
  interface IntrinsicElements {
78
- [tagName]: Omit<EmailFieldJSXProps, 'accessory'> &
79
- BaseElementPropsWithChildren<Omit<EmailFieldJSXProps, 'accessory'>>;
89
+ [tagName]: IntrinsicElementProps<ElementProps>;
80
90
  }
81
91
  }
82
92
  }
@@ -8,7 +8,7 @@
8
8
  /* eslint-disable import-x/namespace */
9
9
  // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
10
10
  /// <reference lib="DOM" />
11
- import type {Key, Ref} from './components-shared.d.ts';
11
+ import type {HeadingProps, Key, Ref} from './components-shared.d.ts';
12
12
 
13
13
  export type ComponentChildren = any;
14
14
  /**
@@ -26,9 +26,13 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
 
30
31
  declare const tagName = 's-heading';
31
- export interface HeadingJSXProps {
32
+ export interface HeadingJSXProps extends Pick<HeadingProps, 'id'> {
33
+ /**
34
+ * The content of the Heading.
35
+ */
32
36
  children?: ComponentChildren;
33
37
  }
34
38
  declare global {
@@ -39,8 +43,7 @@ declare global {
39
43
  declare module 'preact' {
40
44
  namespace createElement.JSX {
41
45
  interface IntrinsicElements {
42
- [tagName]: HeadingJSXProps &
43
- BaseElementPropsWithChildren<HeadingJSXProps>;
46
+ [tagName]: IntrinsicElementProps<HeadingJSXProps>;
44
47
  }
45
48
  }
46
49
  }
@@ -10,6 +10,7 @@
10
10
  /// <reference lib="DOM" />
11
11
  import type {IconProps, Key, Ref} from './components-shared.d.ts';
12
12
 
13
+ export type ComponentChildren = any;
13
14
  /**
14
15
  * Used when an element does not have children.
15
16
  */
@@ -18,6 +19,14 @@ export interface BaseElementProps<TClass = HTMLElement> {
18
19
  ref?: Ref<TClass>;
19
20
  slot?: Lowercase<string>;
20
21
  }
22
+ /**
23
+ * Used when an element has children.
24
+ */
25
+ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
+ extends BaseElementProps<TClass> {
27
+ children?: ComponentChildren;
28
+ }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
21
30
 
22
31
  declare const tagName = 's-icon';
23
32
  export type SupportedIconNames = Extract<
@@ -149,9 +158,10 @@ export type SupportedIconNames = Extract<
149
158
  | 'x-circle'
150
159
  >;
151
160
  export interface IconJSXProps
152
- extends Pick<IconProps, 'tone' | 'color' | 'size'> {
161
+ extends Pick<IconProps, 'id' | 'tone' | 'color' | 'size'> {
153
162
  /**
154
- * The type of icon to display. Maps to PDS icon names.
163
+ * The type of icon to display.
164
+ *
155
165
  * @default ''
156
166
  */
157
167
  type?: SupportedIconNames;
@@ -164,7 +174,7 @@ declare global {
164
174
  declare module 'preact' {
165
175
  namespace createElement.JSX {
166
176
  interface IntrinsicElements {
167
- [tagName]: IconJSXProps & BaseElementProps<IconJSXProps>;
177
+ [tagName]: IntrinsicElementProps<IconJSXProps>;
168
178
  }
169
179
  }
170
180
  }
@@ -26,11 +26,10 @@ export interface BaseElementPropsWithChildren<TClass = HTMLElement>
26
26
  extends BaseElementProps<TClass> {
27
27
  children?: ComponentChildren;
28
28
  }
29
+ export type IntrinsicElementProps<T> = T & BaseElementPropsWithChildren<T>;
29
30
 
30
31
  declare const tagName = 's-image';
31
- export type PickedProps = Pick<ImageProps, 'src' | 'inlineSize' | 'objectFit'>;
32
- export interface ImageJSXProps extends PickedProps {
33
- children?: ComponentChildren;
32
+ export interface ImageJSXProps extends Pick<ImageProps, 'id' | 'objectFit'> {
34
33
  /**
35
34
  * The displayed inline width of the image.
36
35
  *
@@ -45,7 +44,15 @@ export interface ImageJSXProps extends PickedProps {
45
44
  *
46
45
  * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width
47
46
  */
48
- inlineSize?: PickedProps['inlineSize'];
47
+ inlineSize?: ImageProps['inlineSize'];
48
+ /**
49
+ * The image source, which should be a remote URL.
50
+ *
51
+ * When the image is loading or no `src` is provided, a placeholder will be rendered.
52
+ *
53
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
54
+ */
55
+ src?: ImageProps['src'];
49
56
  }
50
57
  declare global {
51
58
  interface HTMLElementTagNameMap {
@@ -55,7 +62,7 @@ declare global {
55
62
  declare module 'preact' {
56
63
  namespace createElement.JSX {
57
64
  interface IntrinsicElements {
58
- [tagName]: ImageJSXProps & BaseElementPropsWithChildren<ImageJSXProps>;
65
+ [tagName]: IntrinsicElementProps<ImageJSXProps>;
59
66
  }
60
67
  }
61
68
  }