@shopify/ui-extensions 2025.10.0-rc.3 → 2025.10.0-rc.31

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 (1189) hide show
  1. package/build/cjs/surfaces/checkout/preact/attributes.js +1 -1
  2. package/build/cjs/surfaces/checkout/shared.js +22 -0
  3. package/build/cjs/surfaces/checkout.js +2 -0
  4. package/build/cjs/surfaces/customer-account/preact/live-navigation.js +0 -2
  5. package/build/cjs/surfaces/customer-account/preact/navigation.js +1 -3
  6. package/build/cjs/surfaces/customer-account/preact/subscription.js +3 -3
  7. package/build/cjs/surfaces/point-of-sale/types/storage.js +13 -0
  8. package/build/cjs/surfaces/point-of-sale.js +9 -0
  9. package/build/esm/surfaces/checkout/preact/attributes.mjs +1 -1
  10. package/build/esm/surfaces/checkout/shared.mjs +18 -0
  11. package/build/esm/surfaces/checkout.mjs +1 -0
  12. package/build/esm/surfaces/customer-account/preact/live-navigation.mjs +0 -2
  13. package/build/esm/surfaces/customer-account/preact/navigation.mjs +1 -3
  14. package/build/esm/surfaces/customer-account/preact/subscription.mjs +3 -3
  15. package/build/esm/surfaces/point-of-sale/types/storage.mjs +9 -0
  16. package/build/esm/surfaces/point-of-sale.mjs +1 -0
  17. package/build/esnext/surfaces/checkout/preact/attributes.esnext +1 -1
  18. package/build/esnext/surfaces/checkout/shared.esnext +18 -0
  19. package/build/esnext/surfaces/checkout.esnext +1 -0
  20. package/build/esnext/surfaces/customer-account/preact/live-navigation.esnext +0 -2
  21. package/build/esnext/surfaces/customer-account/preact/navigation.esnext +1 -3
  22. package/build/esnext/surfaces/customer-account/preact/subscription.esnext +3 -3
  23. package/build/esnext/surfaces/point-of-sale/types/storage.esnext +9 -0
  24. package/build/esnext/surfaces/point-of-sale.esnext +1 -0
  25. package/build/ts/docs/shared/components/Avatar.d.ts +4 -0
  26. package/build/ts/docs/shared/components/Avatar.d.ts.map +1 -0
  27. package/build/ts/docs/shared/components/Badge.d.ts +1 -1
  28. package/build/ts/docs/shared/components/Badge.d.ts.map +1 -1
  29. package/build/ts/docs/shared/components/Banner.d.ts +1 -1
  30. package/build/ts/docs/shared/components/Banner.d.ts.map +1 -1
  31. package/build/ts/docs/shared/components/ButtonGroup.d.ts +4 -0
  32. package/build/ts/docs/shared/components/ButtonGroup.d.ts.map +1 -0
  33. package/build/ts/docs/shared/components/Checkbox.d.ts +1 -1
  34. package/build/ts/docs/shared/components/Checkbox.d.ts.map +1 -1
  35. package/build/ts/docs/shared/components/Chip.d.ts +4 -0
  36. package/build/ts/docs/shared/components/Chip.d.ts.map +1 -0
  37. package/build/ts/docs/shared/components/Choice.d.ts +1 -1
  38. package/build/ts/docs/shared/components/Choice.d.ts.map +1 -1
  39. package/build/ts/docs/shared/components/ChoiceList.d.ts +1 -1
  40. package/build/ts/docs/shared/components/ChoiceList.d.ts.map +1 -1
  41. package/build/ts/docs/shared/components/Clickable.d.ts +1 -1
  42. package/build/ts/docs/shared/components/Clickable.d.ts.map +1 -1
  43. package/build/ts/docs/shared/components/ClickableChip.d.ts +4 -0
  44. package/build/ts/docs/shared/components/ClickableChip.d.ts.map +1 -0
  45. package/build/ts/docs/shared/components/ColorField.d.ts +4 -0
  46. package/build/ts/docs/shared/components/ColorField.d.ts.map +1 -0
  47. package/build/ts/docs/shared/components/ColorPicker.d.ts +4 -0
  48. package/build/ts/docs/shared/components/ColorPicker.d.ts.map +1 -0
  49. package/build/ts/docs/shared/components/DatePicker.d.ts +1 -1
  50. package/build/ts/docs/shared/components/DatePicker.d.ts.map +1 -1
  51. package/build/ts/docs/shared/components/Divider.d.ts +1 -1
  52. package/build/ts/docs/shared/components/Divider.d.ts.map +1 -1
  53. package/build/ts/docs/shared/components/EmailField.d.ts +1 -1
  54. package/build/ts/docs/shared/components/EmailField.d.ts.map +1 -1
  55. package/build/ts/docs/shared/components/Grid.d.ts +1 -1
  56. package/build/ts/docs/shared/components/Grid.d.ts.map +1 -1
  57. package/build/ts/docs/shared/components/GridItem.d.ts +1 -1
  58. package/build/ts/docs/shared/components/GridItem.d.ts.map +1 -1
  59. package/build/ts/docs/shared/components/Map.d.ts +4 -0
  60. package/build/ts/docs/shared/components/Map.d.ts.map +1 -0
  61. package/build/ts/docs/shared/components/MapMarker.d.ts +4 -0
  62. package/build/ts/docs/shared/components/MapMarker.d.ts.map +1 -0
  63. package/build/ts/docs/shared/components/Menu.d.ts +4 -0
  64. package/build/ts/docs/shared/components/Menu.d.ts.map +1 -0
  65. package/build/ts/docs/shared/components/Modal.d.ts +4 -0
  66. package/build/ts/docs/shared/components/Modal.d.ts.map +1 -0
  67. package/build/ts/docs/shared/components/MoneyField.d.ts +1 -1
  68. package/build/ts/docs/shared/components/MoneyField.d.ts.map +1 -1
  69. package/build/ts/docs/shared/components/NumberField.d.ts +1 -1
  70. package/build/ts/docs/shared/components/NumberField.d.ts.map +1 -1
  71. package/build/ts/docs/shared/components/Option.d.ts +4 -0
  72. package/build/ts/docs/shared/components/Option.d.ts.map +1 -0
  73. package/build/ts/docs/shared/components/OptionGroup.d.ts +4 -0
  74. package/build/ts/docs/shared/components/OptionGroup.d.ts.map +1 -0
  75. package/build/ts/docs/shared/components/PasswordField.d.ts +1 -1
  76. package/build/ts/docs/shared/components/PasswordField.d.ts.map +1 -1
  77. package/build/ts/docs/shared/components/PhoneField.d.ts +4 -0
  78. package/build/ts/docs/shared/components/PhoneField.d.ts.map +1 -0
  79. package/build/ts/docs/shared/components/Popover.d.ts +4 -0
  80. package/build/ts/docs/shared/components/Popover.d.ts.map +1 -0
  81. package/build/ts/docs/shared/components/ProductThumbnail.d.ts +4 -0
  82. package/build/ts/docs/shared/components/ProductThumbnail.d.ts.map +1 -0
  83. package/build/ts/docs/shared/components/QueryContainer.d.ts +4 -0
  84. package/build/ts/docs/shared/components/QueryContainer.d.ts.map +1 -0
  85. package/build/ts/docs/shared/components/SearchField.d.ts +1 -1
  86. package/build/ts/docs/shared/components/SearchField.d.ts.map +1 -1
  87. package/build/ts/docs/shared/components/Section.d.ts +1 -1
  88. package/build/ts/docs/shared/components/Section.d.ts.map +1 -1
  89. package/build/ts/docs/shared/components/Select.d.ts +1 -1
  90. package/build/ts/docs/shared/components/Select.d.ts.map +1 -1
  91. package/build/ts/docs/shared/components/Switch.d.ts +1 -1
  92. package/build/ts/docs/shared/components/Switch.d.ts.map +1 -1
  93. package/build/ts/docs/shared/components/Table.d.ts +1 -1
  94. package/build/ts/docs/shared/components/Table.d.ts.map +1 -1
  95. package/build/ts/docs/shared/components/TableBody.d.ts +1 -1
  96. package/build/ts/docs/shared/components/TableBody.d.ts.map +1 -1
  97. package/build/ts/docs/shared/components/TableCell.d.ts +1 -1
  98. package/build/ts/docs/shared/components/TableCell.d.ts.map +1 -1
  99. package/build/ts/docs/shared/components/TableHeader.d.ts +1 -1
  100. package/build/ts/docs/shared/components/TableHeader.d.ts.map +1 -1
  101. package/build/ts/docs/shared/components/TableHeaderRow.d.ts +1 -1
  102. package/build/ts/docs/shared/components/TableHeaderRow.d.ts.map +1 -1
  103. package/build/ts/docs/shared/components/TableRow.d.ts +1 -1
  104. package/build/ts/docs/shared/components/TableRow.d.ts.map +1 -1
  105. package/build/ts/docs/shared/components/TextArea.d.ts +1 -1
  106. package/build/ts/docs/shared/components/TextArea.d.ts.map +1 -1
  107. package/build/ts/docs/shared/components/Thumbnail.d.ts +4 -0
  108. package/build/ts/docs/shared/components/Thumbnail.d.ts.map +1 -0
  109. package/build/ts/docs/shared/components/Tooltip.d.ts +4 -0
  110. package/build/ts/docs/shared/components/Tooltip.d.ts.map +1 -0
  111. package/build/ts/docs/shared/components/URLField.d.ts +1 -1
  112. package/build/ts/docs/shared/components/URLField.d.ts.map +1 -1
  113. package/build/ts/docs/shared/docs-type.d.ts +3 -2
  114. package/build/ts/docs/shared/docs-type.d.ts.map +1 -1
  115. package/build/ts/shared.d.ts +23 -0
  116. package/build/ts/shared.d.ts.map +1 -1
  117. package/build/ts/surfaces/admin/api/should-render/should-render.doc.d.ts.map +1 -1
  118. package/build/ts/surfaces/admin/api/standard/standard.d.ts +6 -1
  119. package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
  120. package/build/ts/surfaces/admin/api/standard/storage.d.ts +70 -0
  121. package/build/ts/surfaces/admin/api/standard/storage.d.ts.map +1 -0
  122. package/build/ts/surfaces/admin/components/AdminAction.d.ts +1 -1
  123. package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.d.ts.map +1 -1
  124. package/build/ts/surfaces/admin/components/AdminBlock.d.ts +1 -1
  125. package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +1 -1
  126. package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts +4 -0
  127. package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts.map +1 -0
  128. package/build/ts/surfaces/admin/components/Avatar.d.ts +133 -0
  129. package/build/ts/surfaces/admin/components/Badge.d.ts +21 -7
  130. package/build/ts/surfaces/admin/components/Banner.d.ts +21 -16
  131. package/build/ts/surfaces/admin/components/Box.d.ts +35 -26
  132. package/build/ts/surfaces/admin/components/Button.d.ts +34 -20
  133. package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts +4 -0
  134. package/build/ts/surfaces/admin/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -0
  135. package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +117 -0
  136. package/build/ts/surfaces/admin/components/Checkbox.d.ts +22 -12
  137. package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts +4 -0
  138. package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts.map +1 -0
  139. package/build/ts/surfaces/admin/components/Chip.d.ts +120 -0
  140. package/build/ts/surfaces/admin/components/Choice.d.ts +39 -9
  141. package/build/ts/surfaces/admin/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -1
  142. package/build/ts/surfaces/admin/components/ChoiceList.d.ts +21 -16
  143. package/build/ts/surfaces/admin/components/Clickable.d.ts +49 -39
  144. package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts +4 -0
  145. package/build/ts/surfaces/admin/components/ClickableChip/ClickableChip.doc.d.ts.map +1 -0
  146. package/build/ts/surfaces/admin/components/ClickableChip.d.ts +151 -0
  147. package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts +4 -0
  148. package/build/ts/surfaces/admin/components/ColorField/ColorField.doc.d.ts.map +1 -0
  149. package/build/ts/surfaces/admin/components/ColorField.d.ts +238 -0
  150. package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts +4 -0
  151. package/build/ts/surfaces/admin/components/ColorPicker/ColorPicker.doc.d.ts.map +1 -0
  152. package/build/ts/surfaces/admin/components/ColorPicker.d.ts +132 -0
  153. package/build/ts/surfaces/admin/components/DatePicker.d.ts +18 -35
  154. package/build/ts/surfaces/admin/components/Divider.d.ts +12 -5
  155. package/build/ts/surfaces/admin/components/DropZone/DropZone.ab.doc.d.ts +4 -0
  156. package/build/ts/surfaces/admin/components/DropZone/DropZone.ab.doc.d.ts.map +1 -0
  157. package/build/ts/surfaces/admin/components/DropZone.d.ts +160 -0
  158. package/build/ts/surfaces/admin/components/EmailField.d.ts +15 -15
  159. package/build/ts/surfaces/admin/components/Form/Form.ext.doc.d.ts.map +1 -1
  160. package/build/ts/surfaces/admin/components/Form.d.ts +43 -35
  161. package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +183 -0
  162. package/build/ts/surfaces/admin/components/Grid.d.ts +42 -33
  163. package/build/ts/surfaces/admin/components/GridItem.d.ts +36 -26
  164. package/build/ts/surfaces/admin/components/Heading.d.ts +17 -6
  165. package/build/ts/surfaces/admin/components/Icon.d.ts +17 -6
  166. package/build/ts/surfaces/admin/components/Image.d.ts +34 -42
  167. package/build/ts/surfaces/admin/components/Link.d.ts +35 -29
  168. package/build/ts/surfaces/admin/components/ListItem.d.ts +18 -6
  169. package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts +4 -0
  170. package/build/ts/surfaces/admin/components/Menu/Menu.doc.d.ts.map +1 -0
  171. package/build/ts/surfaces/admin/components/Menu.d.ts +133 -0
  172. package/build/ts/surfaces/admin/components/MoneyField.d.ts +16 -18
  173. package/build/ts/surfaces/admin/components/NumberField.d.ts +15 -15
  174. package/build/ts/surfaces/admin/components/Option.d.ts +17 -5
  175. package/build/ts/surfaces/admin/components/OptionGroup.d.ts +18 -5
  176. package/build/ts/surfaces/admin/components/OrderedList.d.ts +18 -6
  177. package/build/ts/surfaces/admin/components/Page.d.ts +38 -6
  178. package/build/ts/surfaces/admin/components/Paragraph.d.ts +18 -6
  179. package/build/ts/surfaces/admin/components/PasswordField.d.ts +15 -15
  180. package/build/ts/surfaces/admin/components/Popover/Popover.ab.doc.d.ts +4 -0
  181. package/build/ts/surfaces/admin/components/Popover/Popover.ab.doc.d.ts.map +1 -0
  182. package/build/ts/surfaces/admin/components/Popover.d.ts +379 -0
  183. package/build/ts/surfaces/admin/components/QueryContainer/QueryContainer.doc.d.ts +4 -0
  184. package/build/ts/surfaces/admin/components/QueryContainer/QueryContainer.doc.d.ts.map +1 -0
  185. package/build/ts/surfaces/admin/components/QueryContainer.d.ts +106 -0
  186. package/build/ts/surfaces/admin/components/SearchField.d.ts +18 -16
  187. package/build/ts/surfaces/admin/components/Section.d.ts +17 -6
  188. package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
  189. package/build/ts/surfaces/admin/components/Select.d.ts +20 -16
  190. package/build/ts/surfaces/admin/components/Spinner.d.ts +12 -2
  191. package/build/ts/surfaces/admin/components/Stack.d.ts +53 -43
  192. package/build/ts/surfaces/admin/components/StandardComponents.d.ts +1 -1
  193. package/build/ts/surfaces/admin/components/StandardComponents.d.ts.map +1 -1
  194. package/build/ts/surfaces/admin/components/Switch.d.ts +16 -12
  195. package/build/ts/surfaces/admin/components/Table.d.ts +27 -16
  196. package/build/ts/surfaces/admin/components/TableBody.d.ts +18 -6
  197. package/build/ts/surfaces/admin/components/TableCell.d.ts +34 -7
  198. package/build/ts/surfaces/admin/components/TableHeader.d.ts +24 -6
  199. package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +19 -6
  200. package/build/ts/surfaces/admin/components/TableRow.d.ts +21 -7
  201. package/build/ts/surfaces/admin/components/Text.d.ts +19 -6
  202. package/build/ts/surfaces/admin/components/TextArea.d.ts +15 -15
  203. package/build/ts/surfaces/admin/components/TextField.d.ts +17 -15
  204. package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts +4 -0
  205. package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts.map +1 -0
  206. package/build/ts/surfaces/admin/components/Thumbnail.d.ts +127 -0
  207. package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts +4 -0
  208. package/build/ts/surfaces/admin/components/Tooltip/Tooltip.doc.d.ts.map +1 -0
  209. package/build/ts/surfaces/admin/components/Tooltip.d.ts +141 -0
  210. package/build/ts/surfaces/admin/components/URLField.d.ts +15 -15
  211. package/build/ts/surfaces/admin/components/UnorderedList.d.ts +18 -6
  212. package/build/ts/surfaces/admin/components/patterns/details.ab.doc.d.ts +4 -0
  213. package/build/ts/surfaces/admin/components/patterns/details.ab.doc.d.ts.map +1 -0
  214. package/build/ts/surfaces/admin/components/patterns/homepage.ab.doc.d.ts +4 -0
  215. package/build/ts/surfaces/admin/components/patterns/homepage.ab.doc.d.ts.map +1 -0
  216. package/build/ts/surfaces/admin/components/patterns/index.ab.doc.d.ts +4 -0
  217. package/build/ts/surfaces/admin/components/patterns/index.ab.doc.d.ts.map +1 -0
  218. package/build/ts/surfaces/admin/components/patterns/settings.ab.doc.d.ts +4 -0
  219. package/build/ts/surfaces/admin/components/patterns/settings.ab.doc.d.ts.map +1 -0
  220. package/build/ts/surfaces/admin/components/shared.d.ts +953 -597
  221. package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.action.render.d.ts +50 -3083
  222. package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.action.should-render.d.ts +1 -3
  223. package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.block.render.d.ts +51 -3125
  224. package/build/ts/surfaces/admin/targets/admin.catalog-details.action.render.d.ts +50 -3083
  225. package/build/ts/surfaces/admin/targets/admin.catalog-details.action.should-render.d.ts +1 -3
  226. package/build/ts/surfaces/admin/targets/admin.catalog-details.block.render.d.ts +51 -3125
  227. package/build/ts/surfaces/admin/targets/admin.collection-details.action.render.d.ts +50 -3083
  228. package/build/ts/surfaces/admin/targets/admin.collection-details.action.should-render.d.ts +1 -3
  229. package/build/ts/surfaces/admin/targets/admin.collection-details.block.render.d.ts +51 -3125
  230. package/build/ts/surfaces/admin/targets/admin.collection-index.action.render.d.ts +50 -3083
  231. package/build/ts/surfaces/admin/targets/admin.collection-index.action.should-render.d.ts +1 -3
  232. package/build/ts/surfaces/admin/targets/admin.company-details.action.render.d.ts +50 -3083
  233. package/build/ts/surfaces/admin/targets/admin.company-details.action.should-render.d.ts +1 -3
  234. package/build/ts/surfaces/admin/targets/admin.company-details.block.render.d.ts +51 -3125
  235. package/build/ts/surfaces/admin/targets/admin.company-location-details.block.render.d.ts +51 -3125
  236. package/build/ts/surfaces/admin/targets/admin.customer-details.action.render.d.ts +50 -3083
  237. package/build/ts/surfaces/admin/targets/admin.customer-details.action.should-render.d.ts +1 -3
  238. package/build/ts/surfaces/admin/targets/admin.customer-details.block.render.d.ts +51 -3125
  239. package/build/ts/surfaces/admin/targets/admin.customer-index.action.render.d.ts +50 -3083
  240. package/build/ts/surfaces/admin/targets/admin.customer-index.action.should-render.d.ts +1 -3
  241. package/build/ts/surfaces/admin/targets/admin.customer-index.selection-action.render.d.ts +50 -3083
  242. package/build/ts/surfaces/admin/targets/admin.customer-index.selection-action.should-render.d.ts +1 -3
  243. package/build/ts/surfaces/admin/targets/admin.customer-segment-details.action.render.d.ts +50 -3083
  244. package/build/ts/surfaces/admin/targets/admin.customer-segment-details.action.should-render.d.ts +1 -3
  245. package/build/ts/surfaces/admin/targets/admin.customers.segmentation-templates.render.d.ts +49 -3032
  246. package/build/ts/surfaces/admin/targets/admin.discount-details.action.render.d.ts +50 -3083
  247. package/build/ts/surfaces/admin/targets/admin.discount-details.action.should-render.d.ts +1 -3
  248. package/build/ts/surfaces/admin/targets/admin.discount-details.function-settings.render.d.ts +51 -3125
  249. package/build/ts/surfaces/admin/targets/admin.discount-index.action.render.d.ts +50 -3083
  250. package/build/ts/surfaces/admin/targets/admin.discount-index.action.should-render.d.ts +1 -3
  251. package/build/ts/surfaces/admin/targets/admin.draft-order-details.action.render.d.ts +50 -3083
  252. package/build/ts/surfaces/admin/targets/admin.draft-order-details.action.should-render.d.ts +1 -3
  253. package/build/ts/surfaces/admin/targets/admin.draft-order-details.block.render.d.ts +51 -3125
  254. package/build/ts/surfaces/admin/targets/admin.draft-order-index.action.render.d.ts +50 -3083
  255. package/build/ts/surfaces/admin/targets/admin.draft-order-index.action.should-render.d.ts +1 -3
  256. package/build/ts/surfaces/admin/targets/admin.draft-order-index.selection-action.render.d.ts +50 -3083
  257. package/build/ts/surfaces/admin/targets/admin.draft-order-index.selection-action.should-render.d.ts +1 -3
  258. package/build/ts/surfaces/admin/targets/admin.gift-card-details.action.render.d.ts +50 -3083
  259. package/build/ts/surfaces/admin/targets/admin.gift-card-details.action.should-render.d.ts +1 -3
  260. package/build/ts/surfaces/admin/targets/admin.gift-card-details.block.render.d.ts +51 -3125
  261. package/build/ts/surfaces/admin/targets/admin.order-details.action.render.d.ts +50 -3083
  262. package/build/ts/surfaces/admin/targets/admin.order-details.action.should-render.d.ts +1 -3
  263. package/build/ts/surfaces/admin/targets/admin.order-details.block.render.d.ts +51 -3125
  264. package/build/ts/surfaces/admin/targets/admin.order-details.print-action.render.d.ts +50 -3072
  265. package/build/ts/surfaces/admin/targets/admin.order-details.print-action.should-render.d.ts +1 -3
  266. package/build/ts/surfaces/admin/targets/admin.order-fulfilled-card.action.render.d.ts +50 -3083
  267. package/build/ts/surfaces/admin/targets/admin.order-fulfilled-card.action.should-render.d.ts +1 -3
  268. package/build/ts/surfaces/admin/targets/admin.order-index.action.render.d.ts +50 -3083
  269. package/build/ts/surfaces/admin/targets/admin.order-index.action.should-render.d.ts +1 -3
  270. package/build/ts/surfaces/admin/targets/admin.order-index.selection-action.render.d.ts +50 -3083
  271. package/build/ts/surfaces/admin/targets/admin.order-index.selection-action.should-render.d.ts +1 -3
  272. package/build/ts/surfaces/admin/targets/admin.order-index.selection-print-action.render.d.ts +50 -3072
  273. package/build/ts/surfaces/admin/targets/admin.order-index.selection-print-action.should-render.d.ts +1 -3
  274. package/build/ts/surfaces/admin/targets/admin.product-details.action.render.d.ts +50 -3083
  275. package/build/ts/surfaces/admin/targets/admin.product-details.action.should-render.d.ts +1 -3
  276. package/build/ts/surfaces/admin/targets/admin.product-details.block.render.d.ts +51 -3125
  277. package/build/ts/surfaces/admin/targets/admin.product-details.configuration.render.d.ts +51 -3125
  278. package/build/ts/surfaces/admin/targets/admin.product-details.print-action.render.d.ts +50 -3072
  279. package/build/ts/surfaces/admin/targets/admin.product-details.print-action.should-render.d.ts +1 -3
  280. package/build/ts/surfaces/admin/targets/admin.product-details.reorder.render.d.ts +51 -3125
  281. package/build/ts/surfaces/admin/targets/admin.product-index.action.render.d.ts +50 -3083
  282. package/build/ts/surfaces/admin/targets/admin.product-index.action.should-render.d.ts +1 -3
  283. package/build/ts/surfaces/admin/targets/admin.product-index.selection-action.render.d.ts +50 -3083
  284. package/build/ts/surfaces/admin/targets/admin.product-index.selection-action.should-render.d.ts +1 -3
  285. package/build/ts/surfaces/admin/targets/admin.product-index.selection-print-action.render.d.ts +50 -3072
  286. package/build/ts/surfaces/admin/targets/admin.product-index.selection-print-action.should-render.d.ts +1 -3
  287. package/build/ts/surfaces/admin/targets/admin.product-purchase-option.action.render.d.ts +50 -3083
  288. package/build/ts/surfaces/admin/targets/admin.product-variant-details.action.render.d.ts +50 -3083
  289. package/build/ts/surfaces/admin/targets/admin.product-variant-details.action.should-render.d.ts +1 -3
  290. package/build/ts/surfaces/admin/targets/admin.product-variant-details.block.render.d.ts +51 -3125
  291. package/build/ts/surfaces/admin/targets/admin.product-variant-details.configuration.render.d.ts +51 -3125
  292. package/build/ts/surfaces/admin/targets/admin.product-variant-purchase-option.action.render.d.ts +50 -3083
  293. package/build/ts/surfaces/admin/targets/admin.settings.internal-order-routing-rule.render.d.ts +49 -3032
  294. package/build/ts/surfaces/admin/targets/admin.settings.order-routing-rule.render.d.ts +49 -3032
  295. package/build/ts/surfaces/admin/targets/admin.settings.validation.render.d.ts +49 -3032
  296. package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts +1 -1
  297. package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts.map +1 -1
  298. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +18 -2
  299. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
  300. package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts +1 -1
  301. package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts.map +1 -1
  302. package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts +1 -1
  303. package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts.map +1 -1
  304. package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts +1 -1
  305. package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts.map +1 -1
  306. package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts +1 -1
  307. package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts.map +1 -1
  308. package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts +1 -1
  309. package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts.map +1 -1
  310. package/build/ts/surfaces/checkout/api/shared.d.ts +4 -0
  311. package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
  312. package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts +1 -1
  313. package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
  314. package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts +1 -1
  315. package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts.map +1 -1
  316. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +21 -3
  317. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  318. package/build/ts/surfaces/checkout/components/Abbreviation/Abbreviation.doc.d.ts.map +1 -1
  319. package/build/ts/surfaces/checkout/components/Abbreviation.d.ts +21 -9
  320. package/build/ts/surfaces/checkout/components/Badge.d.ts +56 -0
  321. package/build/ts/surfaces/checkout/components/Banner/Banner.doc.d.ts.map +1 -1
  322. package/build/ts/surfaces/checkout/components/Banner.d.ts +55 -13
  323. package/build/ts/surfaces/checkout/components/Box/Box.doc.d.ts.map +1 -1
  324. package/build/ts/surfaces/checkout/components/Box.d.ts +20 -9
  325. package/build/ts/surfaces/checkout/components/Button/Button.doc.d.ts.map +1 -1
  326. package/build/ts/surfaces/checkout/components/Button.d.ts +44 -13
  327. package/build/ts/surfaces/checkout/components/Checkbox/Checkbox.doc.d.ts +4 -0
  328. package/build/ts/surfaces/checkout/components/Checkbox/Checkbox.doc.d.ts.map +1 -0
  329. package/build/ts/surfaces/checkout/components/Checkbox.d.ts +60 -0
  330. package/build/ts/surfaces/checkout/components/Clickable.d.ts +89 -0
  331. package/build/ts/surfaces/checkout/components/ClipboardItem/ClipboardItem.doc.d.ts.map +1 -1
  332. package/build/ts/surfaces/checkout/components/ClipboardItem.d.ts +39 -9
  333. package/build/ts/surfaces/checkout/components/Details.d.ts +72 -0
  334. package/build/ts/surfaces/checkout/components/Divider.d.ts +31 -0
  335. package/build/ts/surfaces/checkout/components/DropZone/DropZone.doc.d.ts.map +1 -1
  336. package/build/ts/surfaces/checkout/components/DropZone.d.ts +39 -9
  337. package/build/ts/surfaces/checkout/components/EmailField/EmailField.doc.d.ts +4 -0
  338. package/build/ts/surfaces/checkout/components/EmailField/EmailField.doc.d.ts.map +1 -0
  339. package/build/ts/surfaces/checkout/components/EmailField.d.ts +85 -0
  340. package/build/ts/surfaces/checkout/components/Form/Form.doc.d.ts.map +1 -1
  341. package/build/ts/surfaces/checkout/components/Form.d.ts +40 -12
  342. package/build/ts/surfaces/checkout/components/Grid.d.ts +64 -0
  343. package/build/ts/surfaces/checkout/components/GridItem.d.ts +54 -0
  344. package/build/ts/surfaces/checkout/components/Heading/Heading.doc.d.ts.map +1 -1
  345. package/build/ts/surfaces/checkout/components/Heading.d.ts +20 -8
  346. package/build/ts/surfaces/checkout/components/Icon/Icon.doc.d.ts.map +1 -1
  347. package/build/ts/surfaces/checkout/components/Icon.d.ts +22 -9
  348. package/build/ts/surfaces/checkout/components/Image/Image.doc.d.ts.map +1 -1
  349. package/build/ts/surfaces/checkout/components/Image.d.ts +13 -7
  350. package/build/ts/surfaces/checkout/components/Link/Link.doc.d.ts.map +1 -1
  351. package/build/ts/surfaces/checkout/components/Link.d.ts +44 -13
  352. package/build/ts/surfaces/checkout/components/ListItem.d.ts +22 -10
  353. package/build/ts/surfaces/checkout/components/Map/Map.doc.d.ts +4 -0
  354. package/build/ts/surfaces/checkout/components/Map/Map.doc.d.ts.map +1 -0
  355. package/build/ts/surfaces/checkout/components/Map.d.ts +78 -0
  356. package/build/ts/surfaces/checkout/components/MapMarker.d.ts +77 -0
  357. package/build/ts/surfaces/checkout/components/Modal/Modal.doc.d.ts +4 -0
  358. package/build/ts/surfaces/checkout/components/Modal/Modal.doc.d.ts.map +1 -0
  359. package/build/ts/surfaces/checkout/components/Modal.d.ts +90 -0
  360. package/build/ts/surfaces/checkout/components/NumberField.d.ts +85 -0
  361. package/build/ts/surfaces/checkout/components/Option.d.ts +46 -0
  362. package/build/ts/surfaces/checkout/components/OrderedList/OrderedList.doc.d.ts.map +1 -1
  363. package/build/ts/surfaces/checkout/components/OrderedList.d.ts +20 -8
  364. package/build/ts/surfaces/checkout/components/Paragraph/Paragraph.doc.d.ts.map +1 -1
  365. package/build/ts/surfaces/checkout/components/Paragraph.d.ts +20 -8
  366. package/build/ts/surfaces/checkout/components/PasswordField.d.ts +84 -0
  367. package/build/ts/surfaces/checkout/components/PaymentIcon/PaymentIcon.doc.d.ts.map +1 -1
  368. package/build/ts/surfaces/checkout/components/PaymentIcon.d.ts +14 -7
  369. package/build/ts/surfaces/checkout/components/PhoneField/PhoneField.doc.d.ts +4 -0
  370. package/build/ts/surfaces/checkout/components/PhoneField/PhoneField.doc.d.ts.map +1 -0
  371. package/build/ts/surfaces/checkout/components/PhoneField.d.ts +100 -0
  372. package/build/ts/surfaces/checkout/components/Popover.d.ts +68 -0
  373. package/build/ts/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.doc.d.ts +4 -0
  374. package/build/ts/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.doc.d.ts.map +1 -0
  375. package/build/ts/surfaces/checkout/components/ProductThumbnail.d.ts +41 -0
  376. package/build/ts/surfaces/checkout/components/Progress/Progress.doc.d.ts.map +1 -1
  377. package/build/ts/surfaces/checkout/components/Progress.d.ts +14 -4
  378. package/build/ts/surfaces/checkout/components/QRCode/QRCode.doc.d.ts.map +1 -1
  379. package/build/ts/surfaces/checkout/components/QRCode.d.ts +35 -8
  380. package/build/ts/surfaces/checkout/components/ScrollBox.d.ts +54 -0
  381. package/build/ts/surfaces/checkout/components/Section/Section.doc.d.ts.map +1 -1
  382. package/build/ts/surfaces/checkout/components/Section.d.ts +20 -8
  383. package/build/ts/surfaces/checkout/components/Select.d.ts +79 -0
  384. package/build/ts/surfaces/checkout/components/Sheet.d.ts +94 -0
  385. package/build/ts/surfaces/checkout/components/SkeletonParagraph.d.ts +40 -0
  386. package/build/ts/surfaces/checkout/components/Spinner/Spinner.doc.d.ts.map +1 -1
  387. package/build/ts/surfaces/checkout/components/Spinner.d.ts +14 -4
  388. package/build/ts/surfaces/checkout/components/Stack/Stack.doc.d.ts.map +1 -1
  389. package/build/ts/surfaces/checkout/components/Stack.d.ts +20 -9
  390. package/build/ts/surfaces/checkout/components/Summary.d.ts +35 -0
  391. package/build/ts/surfaces/checkout/components/Switch.d.ts +60 -0
  392. package/build/ts/surfaces/checkout/components/Text/Text.doc.d.ts.map +1 -1
  393. package/build/ts/surfaces/checkout/components/Text.d.ts +20 -8
  394. package/build/ts/surfaces/checkout/components/TextArea/TextArea.doc.d.ts +4 -0
  395. package/build/ts/surfaces/checkout/components/TextArea/TextArea.doc.d.ts.map +1 -0
  396. package/build/ts/surfaces/checkout/components/TextArea.d.ts +85 -0
  397. package/build/ts/surfaces/checkout/components/TextField/TextField.doc.d.ts.map +1 -1
  398. package/build/ts/surfaces/checkout/components/TextField.d.ts +88 -21
  399. package/build/ts/surfaces/checkout/components/Time/Time.doc.d.ts.map +1 -1
  400. package/build/ts/surfaces/checkout/components/Time.d.ts +21 -9
  401. package/build/ts/surfaces/checkout/components/UnorderedList/UnorderedList.doc.d.ts.map +1 -1
  402. package/build/ts/surfaces/checkout/components/UnorderedList.d.ts +20 -8
  403. package/build/ts/surfaces/checkout/components/UrlField.d.ts +84 -0
  404. package/build/ts/surfaces/checkout/components/components-shared.d.ts +853 -85
  405. package/build/ts/surfaces/checkout/components/components.d.ts +1683 -244
  406. package/build/ts/surfaces/checkout/extension-targets.d.ts +4 -0
  407. package/build/ts/surfaces/checkout/extension-targets.d.ts.map +1 -1
  408. package/build/ts/surfaces/checkout/preact/attributes.d.ts +1 -1
  409. package/build/ts/surfaces/checkout/preact/attributes.d.ts.map +1 -1
  410. package/build/ts/surfaces/checkout/preact/subscription.d.ts +1 -1
  411. package/build/ts/surfaces/checkout/preact/subscription.d.ts.map +1 -1
  412. package/build/ts/surfaces/checkout/shared.d.ts +8 -3
  413. package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
  414. package/build/ts/surfaces/checkout/targets/Checkout::Actions::RenderBefore.d.ts +49 -549
  415. package/build/ts/surfaces/checkout/targets/Checkout::CartLineDetails::RenderAfter.d.ts +49 -549
  416. package/build/ts/surfaces/checkout/targets/Checkout::CartLineDetails::RenderLineComponents.d.ts +49 -549
  417. package/build/ts/surfaces/checkout/targets/Checkout::CartLines::RenderAfter.d.ts +49 -549
  418. package/build/ts/surfaces/checkout/targets/Checkout::Contact::RenderAfter.d.ts +49 -549
  419. package/build/ts/surfaces/checkout/targets/Checkout::CustomerInformation::RenderAfter.d.ts +49 -549
  420. package/build/ts/surfaces/checkout/targets/Checkout::DeliveryAddress::RenderBefore.d.ts +49 -549
  421. package/build/ts/surfaces/checkout/targets/Checkout::Dynamic::Render.d.ts +49 -549
  422. package/build/ts/surfaces/checkout/targets/Checkout::GiftCard::Render.d.ts +47 -494
  423. package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::HostedFields::RenderAfter.d.ts +47 -494
  424. package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::Render.d.ts +47 -494
  425. package/build/ts/surfaces/checkout/targets/Checkout::PaymentMethod::RenderRequiredAction.d.ts +49 -549
  426. package/build/ts/surfaces/checkout/targets/Checkout::PickupLocations::RenderAfter.d.ts +49 -549
  427. package/build/ts/surfaces/checkout/targets/Checkout::PickupLocations::RenderBefore.d.ts +49 -549
  428. package/build/ts/surfaces/checkout/targets/Checkout::PickupPoints::RenderAfter.d.ts +49 -549
  429. package/build/ts/surfaces/checkout/targets/Checkout::PickupPoints::RenderBefore.d.ts +49 -549
  430. package/build/ts/surfaces/checkout/targets/Checkout::Reductions::RenderAfter.d.ts +49 -549
  431. package/build/ts/surfaces/checkout/targets/Checkout::Reductions::RenderBefore.d.ts +49 -549
  432. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethodDetails::RenderAfter.d.ts +49 -549
  433. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethodDetails::RenderExpanded.d.ts +49 -549
  434. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethods::RenderAfter.d.ts +49 -549
  435. package/build/ts/surfaces/checkout/targets/Checkout::ShippingMethods::RenderBefore.d.ts +49 -549
  436. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CartLineDetails::RenderAfter.d.ts +49 -549
  437. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CartLines::RenderAfter.d.ts +49 -549
  438. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::CustomerInformation::RenderAfter.d.ts +49 -549
  439. package/build/ts/surfaces/checkout/targets/Checkout::ThankYou::Dynamic::Render.d.ts +49 -549
  440. package/build/ts/surfaces/checkout/targets/purchase.address-autocomplete.format-suggestion.d.ts +1 -3
  441. package/build/ts/surfaces/checkout/targets/purchase.address-autocomplete.suggest.d.ts +1 -3
  442. package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +49 -549
  443. package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +49 -549
  444. package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +49 -549
  445. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +49 -549
  446. package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +49 -549
  447. package/build/ts/surfaces/checkout/targets/purchase.checkout.chat.render.d.ts +1 -3
  448. package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +49 -549
  449. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +49 -549
  450. package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +49 -549
  451. package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +49 -549
  452. package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +47 -494
  453. package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +49 -549
  454. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +49 -549
  455. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +49 -549
  456. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +49 -549
  457. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +47 -494
  458. package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +49 -549
  459. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +49 -549
  460. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +49 -549
  461. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +49 -549
  462. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +49 -549
  463. package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +49 -549
  464. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +49 -549
  465. package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +49 -549
  466. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +49 -549
  467. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +49 -549
  468. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +49 -549
  469. package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +49 -549
  470. package/build/ts/surfaces/checkout/targets/purchase.thank-you.announcement.render.d.ts +54 -0
  471. package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +49 -549
  472. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +49 -549
  473. package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +49 -549
  474. package/build/ts/surfaces/checkout/targets/purchase.thank-you.chat.render.d.ts +1 -3
  475. package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +49 -549
  476. package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +49 -549
  477. package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +49 -549
  478. package/build/ts/surfaces/checkout.d.ts +1 -1
  479. package/build/ts/surfaces/checkout.d.ts.map +1 -1
  480. package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts +2 -2
  481. package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts.map +1 -1
  482. package/build/ts/surfaces/customer-account/api/docs.d.ts +46 -17
  483. package/build/ts/surfaces/customer-account/api/docs.d.ts.map +1 -1
  484. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +29 -42
  485. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
  486. package/build/ts/surfaces/customer-account/api/shared.d.ts +53 -46
  487. package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -1
  488. package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts +38 -23
  489. package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
  490. package/build/ts/surfaces/customer-account/api.d.ts +2 -2
  491. package/build/ts/surfaces/customer-account/api.d.ts.map +1 -1
  492. package/build/ts/surfaces/customer-account/components/Abbreviation.d.ts +21 -9
  493. package/build/ts/surfaces/customer-account/components/Avatar/Avatar.doc.d.ts +4 -0
  494. package/build/ts/surfaces/customer-account/components/Avatar/Avatar.doc.d.ts.map +1 -0
  495. package/build/ts/surfaces/customer-account/components/Avatar.d.ts +92 -0
  496. package/build/ts/surfaces/customer-account/components/Badge.d.ts +56 -0
  497. package/build/ts/surfaces/customer-account/components/Banner.d.ts +55 -13
  498. package/build/ts/surfaces/customer-account/components/Box.d.ts +20 -9
  499. package/build/ts/surfaces/customer-account/components/Button.d.ts +44 -13
  500. package/build/ts/surfaces/customer-account/components/ButtonGroup/ButtonGroup.doc.d.ts +4 -0
  501. package/build/ts/surfaces/customer-account/components/ButtonGroup/ButtonGroup.doc.d.ts.map +1 -0
  502. package/build/ts/surfaces/customer-account/components/ButtonGroup.d.ts +39 -0
  503. package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +60 -0
  504. package/build/ts/surfaces/customer-account/components/Clickable.d.ts +89 -0
  505. package/build/ts/surfaces/customer-account/components/ClipboardItem.d.ts +39 -9
  506. package/build/ts/surfaces/customer-account/components/CustomerAccountAction.d.ts +16 -6
  507. package/build/ts/surfaces/customer-account/components/Details.d.ts +72 -0
  508. package/build/ts/surfaces/customer-account/components/Divider.d.ts +31 -0
  509. package/build/ts/surfaces/customer-account/components/DropZone.d.ts +39 -9
  510. package/build/ts/surfaces/customer-account/components/EmailField.d.ts +85 -0
  511. package/build/ts/surfaces/customer-account/components/Form.d.ts +40 -12
  512. package/build/ts/surfaces/customer-account/components/Grid.d.ts +64 -0
  513. package/build/ts/surfaces/customer-account/components/GridItem.d.ts +54 -0
  514. package/build/ts/surfaces/customer-account/components/Heading.d.ts +20 -8
  515. package/build/ts/surfaces/customer-account/components/Icon.d.ts +22 -9
  516. package/build/ts/surfaces/customer-account/components/Image.d.ts +13 -7
  517. package/build/ts/surfaces/customer-account/components/ImageGroup/ImageGroup.doc.d.ts.map +1 -1
  518. package/build/ts/surfaces/customer-account/components/ImageGroup.d.ts +5 -5
  519. package/build/ts/surfaces/customer-account/components/Link.d.ts +44 -13
  520. package/build/ts/surfaces/customer-account/components/ListItem.d.ts +22 -10
  521. package/build/ts/surfaces/customer-account/components/Map.d.ts +78 -0
  522. package/build/ts/surfaces/customer-account/components/MapMarker.d.ts +77 -0
  523. package/build/ts/surfaces/customer-account/components/Menu/Menu.doc.d.ts +4 -0
  524. package/build/ts/surfaces/customer-account/components/Menu/Menu.doc.d.ts.map +1 -0
  525. package/build/ts/surfaces/customer-account/components/Menu.d.ts +25 -0
  526. package/build/ts/surfaces/customer-account/components/Modal.d.ts +90 -0
  527. package/build/ts/surfaces/customer-account/components/NumberField.d.ts +85 -0
  528. package/build/ts/surfaces/customer-account/components/Option.d.ts +46 -0
  529. package/build/ts/surfaces/customer-account/components/OrderedList.d.ts +20 -8
  530. package/build/ts/surfaces/customer-account/components/Page/Page.doc.d.ts.map +1 -1
  531. package/build/ts/surfaces/customer-account/components/Page.d.ts +19 -6
  532. package/build/ts/surfaces/customer-account/components/Paragraph.d.ts +20 -8
  533. package/build/ts/surfaces/customer-account/components/PasswordField.d.ts +84 -0
  534. package/build/ts/surfaces/customer-account/components/PaymentIcon.d.ts +14 -7
  535. package/build/ts/surfaces/customer-account/components/PhoneField.d.ts +100 -0
  536. package/build/ts/surfaces/customer-account/components/Popover.d.ts +68 -0
  537. package/build/ts/surfaces/customer-account/components/ProductThumbnail.d.ts +41 -0
  538. package/build/ts/surfaces/customer-account/components/Progress.d.ts +14 -4
  539. package/build/ts/surfaces/customer-account/components/QRCode.d.ts +35 -8
  540. package/build/ts/surfaces/customer-account/components/ScrollBox.d.ts +54 -0
  541. package/build/ts/surfaces/customer-account/components/Section/Section.doc.d.ts +4 -0
  542. package/build/ts/surfaces/customer-account/components/Section/Section.doc.d.ts.map +1 -0
  543. package/build/ts/surfaces/customer-account/components/Section.d.ts +20 -8
  544. package/build/ts/surfaces/customer-account/components/Select.d.ts +79 -0
  545. package/build/ts/surfaces/customer-account/components/Sheet.d.ts +94 -0
  546. package/build/ts/surfaces/customer-account/components/SkeletonParagraph.d.ts +40 -0
  547. package/build/ts/surfaces/customer-account/components/Spinner.d.ts +14 -4
  548. package/build/ts/surfaces/customer-account/components/Stack.d.ts +20 -9
  549. package/build/ts/surfaces/customer-account/components/StandardComponents.d.ts +1 -1
  550. package/build/ts/surfaces/customer-account/components/StandardComponents.d.ts.map +1 -1
  551. package/build/ts/surfaces/customer-account/components/Summary.d.ts +35 -0
  552. package/build/ts/surfaces/customer-account/components/Switch.d.ts +60 -0
  553. package/build/ts/surfaces/customer-account/components/Text.d.ts +20 -8
  554. package/build/ts/surfaces/customer-account/components/TextArea.d.ts +85 -0
  555. package/build/ts/surfaces/customer-account/components/TextField.d.ts +88 -21
  556. package/build/ts/surfaces/customer-account/components/Time.d.ts +21 -9
  557. package/build/ts/surfaces/customer-account/components/UnorderedList.d.ts +20 -8
  558. package/build/ts/surfaces/customer-account/components/UrlField.d.ts +84 -0
  559. package/build/ts/surfaces/customer-account/components/components-shared.d.ts +853 -85
  560. package/build/ts/surfaces/customer-account/components/components.d.ts +1683 -244
  561. package/build/ts/surfaces/customer-account/components/shared.d.ts +13 -2
  562. package/build/ts/surfaces/customer-account/components/shared.d.ts.map +1 -1
  563. package/build/ts/surfaces/customer-account/components/shared.ts +29 -5
  564. package/build/ts/surfaces/customer-account/extension-targets.d.ts +6 -6
  565. package/build/ts/surfaces/customer-account/extension-targets.d.ts.map +1 -1
  566. package/build/ts/surfaces/customer-account/globals.d.ts +2 -1
  567. package/build/ts/surfaces/customer-account/globals.d.ts.map +1 -1
  568. package/build/ts/surfaces/customer-account/preact/live-navigation.d.ts +1 -2
  569. package/build/ts/surfaces/customer-account/preact/live-navigation.d.ts.map +1 -1
  570. package/build/ts/surfaces/customer-account/preact/navigation.d.ts +2 -2
  571. package/build/ts/surfaces/customer-account/preact/navigation.d.ts.map +1 -1
  572. package/build/ts/surfaces/customer-account/preact/subscription.d.ts +2 -2
  573. package/build/ts/surfaces/customer-account/preact/subscription.d.ts.map +1 -1
  574. package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +56 -640
  575. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +61 -0
  576. package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +56 -640
  577. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +61 -0
  578. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +56 -640
  579. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +56 -640
  580. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +56 -640
  581. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +56 -640
  582. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +56 -640
  583. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +56 -640
  584. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +56 -640
  585. package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +56 -640
  586. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +56 -640
  587. package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +56 -640
  588. package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +56 -640
  589. package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +56 -640
  590. package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +56 -640
  591. package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +61 -0
  592. package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +56 -640
  593. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +56 -640
  594. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +56 -640
  595. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +56 -640
  596. package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +56 -640
  597. package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +56 -640
  598. package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts +15 -0
  599. package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts.map +1 -0
  600. package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts +9 -0
  601. package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts.map +1 -0
  602. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +182 -0
  603. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -0
  604. package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts +11 -0
  605. package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts.map +1 -0
  606. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts +22 -0
  607. package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts.map +1 -0
  608. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +10 -0
  609. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -0
  610. package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts +21 -0
  611. package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts.map +1 -0
  612. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +18 -0
  613. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -0
  614. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts +15 -0
  615. package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts.map +1 -0
  616. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts +41 -0
  617. package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map +1 -0
  618. package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +24 -0
  619. package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts.map +1 -0
  620. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +17 -0
  621. package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map +1 -0
  622. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +29 -0
  623. package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -0
  624. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +14 -0
  625. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -0
  626. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts +67 -0
  627. package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts.map +1 -0
  628. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +37 -0
  629. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts.map +1 -0
  630. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts +21 -0
  631. package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts.map +1 -0
  632. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +15 -0
  633. package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -0
  634. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts +5 -0
  635. package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -0
  636. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +15 -0
  637. package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -0
  638. package/build/ts/surfaces/point-of-sale/api.d.ts +35 -0
  639. package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -0
  640. package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts +4 -0
  641. package/build/ts/surfaces/point-of-sale/components/Badge/Badge.doc.d.ts.map +1 -0
  642. package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +52 -0
  643. package/build/ts/surfaces/point-of-sale/components/Banner/Banner.doc.d.ts +4 -0
  644. package/build/ts/surfaces/point-of-sale/components/Banner/Banner.doc.d.ts.map +1 -0
  645. package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +60 -0
  646. package/build/ts/surfaces/point-of-sale/components/Box/Box.doc.d.ts +4 -0
  647. package/build/ts/surfaces/point-of-sale/components/Box/Box.doc.d.ts.map +1 -0
  648. package/build/ts/surfaces/point-of-sale/components/Box.d.ts +64 -0
  649. package/build/ts/surfaces/point-of-sale/components/Button/Button.doc.d.ts +4 -0
  650. package/build/ts/surfaces/point-of-sale/components/Button/Button.doc.d.ts.map +1 -0
  651. package/build/ts/surfaces/point-of-sale/components/Button.d.ts +67 -0
  652. package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +49 -0
  653. package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts +4 -0
  654. package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts.map +1 -0
  655. package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +61 -0
  656. package/build/ts/surfaces/point-of-sale/components/Clickable/Clickable.doc.d.ts +4 -0
  657. package/build/ts/surfaces/point-of-sale/components/Clickable/Clickable.doc.d.ts.map +1 -0
  658. package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +59 -0
  659. package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts +4 -0
  660. package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts.map +1 -0
  661. package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +71 -0
  662. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts +4 -0
  663. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts.map +1 -0
  664. package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +62 -0
  665. package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts +4 -0
  666. package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts.map +1 -0
  667. package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +62 -0
  668. package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts +4 -0
  669. package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts.map +1 -0
  670. package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +78 -0
  671. package/build/ts/surfaces/point-of-sale/components/Heading/Heading.doc.d.ts +4 -0
  672. package/build/ts/surfaces/point-of-sale/components/Heading/Heading.doc.d.ts.map +1 -0
  673. package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +49 -0
  674. package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts +4 -0
  675. package/build/ts/surfaces/point-of-sale/components/Icon/Icon.doc.d.ts.map +1 -0
  676. package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +92 -0
  677. package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts +4 -0
  678. package/build/ts/surfaces/point-of-sale/components/Image/Image.doc.d.ts.map +1 -0
  679. package/build/ts/surfaces/point-of-sale/components/Image.d.ts +64 -0
  680. package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts +4 -0
  681. package/build/ts/surfaces/point-of-sale/components/Modal/Modal.doc.d.ts.map +1 -0
  682. package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +70 -0
  683. package/build/ts/surfaces/point-of-sale/components/Navigator.d.ts +50 -0
  684. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts +4 -0
  685. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts.map +1 -0
  686. package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +150 -0
  687. package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts +4 -0
  688. package/build/ts/surfaces/point-of-sale/components/Page/Page.doc.d.ts.map +1 -0
  689. package/build/ts/surfaces/point-of-sale/components/Page.d.ts +62 -0
  690. package/build/ts/surfaces/point-of-sale/components/Screen.d.ts +91 -0
  691. package/build/ts/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.d.ts +4 -0
  692. package/build/ts/surfaces/point-of-sale/components/ScrollBox/ScrollBox.doc.d.ts.map +1 -0
  693. package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +49 -0
  694. package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts +4 -0
  695. package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts.map +1 -0
  696. package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +65 -0
  697. package/build/ts/surfaces/point-of-sale/components/Section/Section.doc.d.ts +4 -0
  698. package/build/ts/surfaces/point-of-sale/components/Section/Section.doc.d.ts.map +1 -0
  699. package/build/ts/surfaces/point-of-sale/components/Section.d.ts +62 -0
  700. package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts +4 -0
  701. package/build/ts/surfaces/point-of-sale/components/Stack/Stack.doc.d.ts.map +1 -0
  702. package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +116 -0
  703. package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts +4 -0
  704. package/build/ts/surfaces/point-of-sale/components/Text/Text.doc.d.ts.map +1 -0
  705. package/build/ts/surfaces/point-of-sale/components/Text.d.ts +54 -0
  706. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts +4 -0
  707. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts.map +1 -0
  708. package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +79 -0
  709. package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts +4 -0
  710. package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts.map +1 -0
  711. package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +78 -0
  712. package/build/ts/surfaces/point-of-sale/components/Tile/Tile.doc.d.ts +4 -0
  713. package/build/ts/surfaces/point-of-sale/components/Tile/Tile.doc.d.ts.map +1 -0
  714. package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +98 -0
  715. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts +4 -0
  716. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts.map +1 -0
  717. package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +62 -0
  718. package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +2924 -0
  719. package/build/ts/surfaces/point-of-sale/components/shared.d.ts +76 -0
  720. package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts +2 -0
  721. package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts.map +1 -0
  722. package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts +3 -0
  723. package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts.map +1 -0
  724. package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts +2 -0
  725. package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts.map +1 -0
  726. package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +2 -0
  727. package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts.map +1 -0
  728. package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts +2 -0
  729. package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts.map +1 -0
  730. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +3 -0
  731. package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -0
  732. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +3 -0
  733. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -0
  734. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +8 -0
  735. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -0
  736. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +7 -0
  737. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -0
  738. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +16 -0
  739. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -0
  740. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +10 -0
  741. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -0
  742. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +7 -0
  743. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -0
  744. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +10 -0
  745. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -0
  746. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +8 -0
  747. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -0
  748. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +13 -0
  749. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -0
  750. package/build/ts/surfaces/point-of-sale/event/data.d.ts +9 -0
  751. package/build/ts/surfaces/point-of-sale/event/data.d.ts.map +1 -0
  752. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +9 -0
  753. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -0
  754. package/build/ts/surfaces/point-of-sale/event/output.d.ts +2 -0
  755. package/build/ts/surfaces/point-of-sale/event/output.d.ts.map +1 -0
  756. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +57 -0
  757. package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -0
  758. package/build/ts/surfaces/point-of-sale/targets/pos.cart-update.event.observe.d.ts +6 -0
  759. package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.menu-item.render.d.ts +7 -0
  760. package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.render.d.ts +31 -0
  761. package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-complete.event.observe.d.ts +6 -0
  762. package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-start.event.observe.d.ts +6 -0
  763. package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.action.menu-item.render.d.ts +7 -0
  764. package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.action.render.d.ts +31 -0
  765. package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.block.render.d.ts +18 -0
  766. package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.action.menu-item.render.d.ts +7 -0
  767. package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.action.render.d.ts +31 -0
  768. package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.block.render.d.ts +18 -0
  769. package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.action.menu-item.render.d.ts +7 -0
  770. package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.action.render.d.ts +31 -0
  771. package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.block.render.d.ts +18 -0
  772. package/build/ts/surfaces/point-of-sale/targets/pos.home.modal.render.d.ts +31 -0
  773. package/build/ts/surfaces/point-of-sale/targets/pos.home.tile.render.d.ts +7 -0
  774. package/build/ts/surfaces/point-of-sale/targets/pos.order-details.action.menu-item.render.d.ts +7 -0
  775. package/build/ts/surfaces/point-of-sale/targets/pos.order-details.action.render.d.ts +31 -0
  776. package/build/ts/surfaces/point-of-sale/targets/pos.order-details.block.render.d.ts +18 -0
  777. package/build/ts/surfaces/point-of-sale/targets/pos.product-details.action.menu-item.render.d.ts +7 -0
  778. package/build/ts/surfaces/point-of-sale/targets/pos.product-details.action.render.d.ts +31 -0
  779. package/build/ts/surfaces/point-of-sale/targets/pos.product-details.block.render.d.ts +18 -0
  780. package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.action.menu-item.render.d.ts +7 -0
  781. package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.action.render.d.ts +31 -0
  782. package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.block.render.d.ts +18 -0
  783. package/build/ts/surfaces/point-of-sale/targets/pos.receipt-footer.block.render.d.ts +7 -0
  784. package/build/ts/surfaces/point-of-sale/targets/pos.receipt-header.block.render.d.ts +7 -0
  785. package/build/ts/surfaces/point-of-sale/targets/pos.return.post.action.menu-item.render.d.ts +7 -0
  786. package/build/ts/surfaces/point-of-sale/targets/pos.return.post.action.render.d.ts +31 -0
  787. package/build/ts/surfaces/point-of-sale/targets/pos.return.post.block.render.d.ts +18 -0
  788. package/build/ts/surfaces/point-of-sale/targets/pos.transaction-complete.event.observe.d.ts +6 -0
  789. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +21 -0
  790. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -0
  791. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +178 -0
  792. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -0
  793. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +248 -0
  794. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -0
  795. package/build/ts/surfaces/point-of-sale/types/device.d.ts +15 -0
  796. package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -0
  797. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +14 -0
  798. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts.map +1 -0
  799. package/build/ts/surfaces/point-of-sale/types/money.d.ts +5 -0
  800. package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -0
  801. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +15 -0
  802. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -0
  803. package/build/ts/surfaces/point-of-sale/types/order.d.ts +10 -0
  804. package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -0
  805. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +19 -0
  806. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -0
  807. package/build/ts/surfaces/point-of-sale/types/payment.d.ts +7 -0
  808. package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -0
  809. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +55 -0
  810. package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -0
  811. package/build/ts/surfaces/point-of-sale/types/product.d.ts +61 -0
  812. package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -0
  813. package/build/ts/surfaces/point-of-sale/types/session.d.ts +33 -0
  814. package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -0
  815. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +16 -0
  816. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -0
  817. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +45 -0
  818. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -0
  819. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +13 -0
  820. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -0
  821. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +2 -0
  822. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -0
  823. package/build/ts/surfaces/point-of-sale.d.ts +5 -0
  824. package/build/ts/surfaces/point-of-sale.d.ts.map +1 -0
  825. package/build/tsconfig.tsbuildinfo +1 -1
  826. package/package.json +23 -2
  827. package/src/docs/shared/components/Avatar.ts +12 -0
  828. package/src/docs/shared/components/Badge.ts +1 -1
  829. package/src/docs/shared/components/Banner.ts +1 -1
  830. package/src/docs/shared/components/ButtonGroup.ts +11 -0
  831. package/src/docs/shared/components/Checkbox.ts +1 -1
  832. package/src/docs/shared/components/Chip.ts +12 -0
  833. package/src/docs/shared/components/Choice.ts +1 -1
  834. package/src/docs/shared/components/ChoiceList.ts +1 -1
  835. package/src/docs/shared/components/Clickable.ts +1 -1
  836. package/src/docs/shared/components/ClickableChip.ts +12 -0
  837. package/src/docs/shared/components/ColorField.ts +11 -0
  838. package/src/docs/shared/components/ColorPicker.ts +11 -0
  839. package/src/docs/shared/components/DatePicker.ts +1 -1
  840. package/src/docs/shared/components/Divider.ts +1 -1
  841. package/src/docs/shared/components/EmailField.ts +1 -1
  842. package/src/docs/shared/components/Grid.ts +1 -1
  843. package/src/docs/shared/components/GridItem.ts +1 -1
  844. package/src/docs/shared/components/Map.ts +12 -0
  845. package/src/docs/shared/components/MapMarker.ts +12 -0
  846. package/src/docs/shared/components/Menu.ts +12 -0
  847. package/src/docs/shared/components/Modal.ts +12 -0
  848. package/src/docs/shared/components/MoneyField.ts +1 -1
  849. package/src/docs/shared/components/NumberField.ts +1 -1
  850. package/src/docs/shared/components/Option.ts +12 -0
  851. package/src/docs/shared/components/OptionGroup.ts +12 -0
  852. package/src/docs/shared/components/Paragraph.ts +1 -1
  853. package/src/docs/shared/components/PasswordField.ts +1 -1
  854. package/src/docs/shared/components/PhoneField.ts +11 -0
  855. package/src/docs/shared/components/Popover.ts +12 -0
  856. package/src/docs/shared/components/ProductThumbnail.ts +11 -0
  857. package/src/docs/shared/components/QueryContainer.ts +12 -0
  858. package/src/docs/shared/components/SearchField.ts +1 -1
  859. package/src/docs/shared/components/Section.ts +1 -1
  860. package/src/docs/shared/components/Select.ts +1 -1
  861. package/src/docs/shared/components/Switch.ts +1 -1
  862. package/src/docs/shared/components/Table.ts +1 -1
  863. package/src/docs/shared/components/TableBody.ts +1 -1
  864. package/src/docs/shared/components/TableCell.ts +1 -1
  865. package/src/docs/shared/components/TableHeader.ts +1 -1
  866. package/src/docs/shared/components/TableHeaderRow.ts +1 -1
  867. package/src/docs/shared/components/TableRow.ts +1 -1
  868. package/src/docs/shared/components/TextArea.ts +1 -1
  869. package/src/docs/shared/components/Thumbnail.ts +12 -0
  870. package/src/docs/shared/components/Tooltip.ts +12 -0
  871. package/src/docs/shared/components/URLField.ts +1 -1
  872. package/src/docs/shared/docs-type.ts +6 -5
  873. package/src/shared.ts +25 -0
  874. package/src/surfaces/admin/api/standard/standard.ts +7 -1
  875. package/src/surfaces/admin/api/standard/storage.ts +110 -0
  876. package/src/surfaces/admin/components/AdminAction.d.ts +1 -1
  877. package/src/surfaces/admin/components/AdminBlock.d.ts +1 -1
  878. package/src/surfaces/admin/components/AdminPrintAction/examples/default.tsx +1 -1
  879. package/src/surfaces/admin/components/AdminPrintAction.d.ts +1 -1
  880. package/src/surfaces/admin/components/Avatar/examples/default.html +4 -0
  881. package/src/surfaces/admin/components/Avatar.d.ts +133 -0
  882. package/src/surfaces/admin/components/Badge.d.ts +21 -7
  883. package/src/surfaces/admin/components/Banner.d.ts +21 -16
  884. package/src/surfaces/admin/components/Box.d.ts +35 -26
  885. package/src/surfaces/admin/components/Button.d.ts +34 -20
  886. package/src/surfaces/admin/components/ButtonGroup/examples/default.html +4 -0
  887. package/src/surfaces/admin/components/ButtonGroup.d.ts +117 -0
  888. package/src/surfaces/admin/components/Checkbox.d.ts +22 -12
  889. package/src/surfaces/admin/components/Chip/examples/default.html +1 -0
  890. package/src/surfaces/admin/components/Chip.d.ts +120 -0
  891. package/src/surfaces/admin/components/Choice.d.ts +39 -9
  892. package/src/surfaces/admin/components/ChoiceList/examples/default.html +3 -3
  893. package/src/surfaces/admin/components/ChoiceList.d.ts +21 -16
  894. package/src/surfaces/admin/components/Clickable.d.ts +49 -39
  895. package/src/surfaces/admin/components/ClickableChip/examples/default.html +1 -0
  896. package/src/surfaces/admin/components/ClickableChip.d.ts +151 -0
  897. package/src/surfaces/admin/components/ColorField/examples/default.html +4 -0
  898. package/src/surfaces/admin/components/ColorField.d.ts +238 -0
  899. package/src/surfaces/admin/components/ColorPicker/examples/default.html +4 -0
  900. package/src/surfaces/admin/components/ColorPicker.d.ts +132 -0
  901. package/src/surfaces/admin/components/DatePicker.d.ts +18 -35
  902. package/src/surfaces/admin/components/Divider.d.ts +12 -5
  903. package/src/surfaces/admin/components/DropZone/examples/default.html +9 -0
  904. package/src/surfaces/admin/components/DropZone.d.ts +160 -0
  905. package/src/surfaces/admin/components/EmailField.d.ts +15 -15
  906. package/src/surfaces/admin/components/Form.d.ts +43 -35
  907. package/src/surfaces/admin/components/FunctionSettings.d.ts +183 -0
  908. package/src/surfaces/admin/components/Grid.d.ts +42 -33
  909. package/src/surfaces/admin/components/GridItem.d.ts +36 -26
  910. package/src/surfaces/admin/components/Heading.d.ts +17 -6
  911. package/src/surfaces/admin/components/Icon.d.ts +17 -6
  912. package/src/surfaces/admin/components/Image.d.ts +34 -42
  913. package/src/surfaces/admin/components/Link.d.ts +35 -29
  914. package/src/surfaces/admin/components/ListItem.d.ts +18 -6
  915. package/src/surfaces/admin/components/Menu/examples/default.html +7 -0
  916. package/src/surfaces/admin/components/Menu.d.ts +133 -0
  917. package/src/surfaces/admin/components/MoneyField.d.ts +16 -18
  918. package/src/surfaces/admin/components/NumberField.d.ts +15 -15
  919. package/src/surfaces/admin/components/Option.d.ts +17 -5
  920. package/src/surfaces/admin/components/OptionGroup.d.ts +18 -5
  921. package/src/surfaces/admin/components/OrderedList.d.ts +18 -6
  922. package/src/surfaces/admin/components/Page.d.ts +38 -6
  923. package/src/surfaces/admin/components/Paragraph.d.ts +18 -6
  924. package/src/surfaces/admin/components/PasswordField.d.ts +15 -15
  925. package/src/surfaces/admin/components/Popover/examples/default.html +8 -0
  926. package/src/surfaces/admin/components/Popover.d.ts +379 -0
  927. package/src/surfaces/admin/components/QueryContainer/examples/default.html +8 -0
  928. package/src/surfaces/admin/components/QueryContainer.d.ts +106 -0
  929. package/src/surfaces/admin/components/SearchField.d.ts +18 -16
  930. package/src/surfaces/admin/components/Section.d.ts +17 -6
  931. package/src/surfaces/admin/components/Select/examples/default.html +4 -0
  932. package/src/surfaces/admin/components/Select.d.ts +20 -16
  933. package/src/surfaces/admin/components/Spinner.d.ts +12 -2
  934. package/src/surfaces/admin/components/Stack.d.ts +53 -43
  935. package/src/surfaces/admin/components/StandardComponents.ts +8 -0
  936. package/src/surfaces/admin/components/Switch.d.ts +16 -12
  937. package/src/surfaces/admin/components/Table.d.ts +27 -16
  938. package/src/surfaces/admin/components/TableBody.d.ts +18 -6
  939. package/src/surfaces/admin/components/TableCell.d.ts +34 -7
  940. package/src/surfaces/admin/components/TableHeader.d.ts +24 -6
  941. package/src/surfaces/admin/components/TableHeaderRow.d.ts +19 -6
  942. package/src/surfaces/admin/components/TableRow.d.ts +21 -7
  943. package/src/surfaces/admin/components/Text.d.ts +19 -6
  944. package/src/surfaces/admin/components/TextArea.d.ts +15 -15
  945. package/src/surfaces/admin/components/TextField.d.ts +17 -15
  946. package/src/surfaces/admin/components/Thumbnail/examples/default.html +4 -0
  947. package/src/surfaces/admin/components/Thumbnail.d.ts +127 -0
  948. package/src/surfaces/admin/components/Tooltip/examples/default.html +2 -0
  949. package/src/surfaces/admin/components/Tooltip.d.ts +141 -0
  950. package/src/surfaces/admin/components/URLField.d.ts +15 -15
  951. package/src/surfaces/admin/components/UnorderedList.d.ts +18 -6
  952. package/src/surfaces/admin/components/patterns/examples/details.html +228 -0
  953. package/src/surfaces/admin/components/patterns/examples/details.jsx +262 -0
  954. package/src/surfaces/admin/components/patterns/examples/homepage.html +587 -0
  955. package/src/surfaces/admin/components/patterns/examples/homepage.jsx +691 -0
  956. package/src/surfaces/admin/components/patterns/examples/index.html +143 -0
  957. package/src/surfaces/admin/components/patterns/examples/index.jsx +162 -0
  958. package/src/surfaces/admin/components/patterns/examples/settings.html +154 -0
  959. package/src/surfaces/admin/components/patterns/examples/settings.jsx +166 -0
  960. package/src/surfaces/admin/components/patterns/index.ab.doc.ts +79 -0
  961. package/src/surfaces/admin/components/shared.d.ts +953 -597
  962. package/src/surfaces/admin/components.d.ts +2962 -1505
  963. package/src/surfaces/checkout/api/cart-line/cart-line-item.ts +1 -2
  964. package/src/surfaces/checkout/api/checkout/checkout.ts +12 -2
  965. package/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts +1 -1
  966. package/src/surfaces/checkout/api/payment/payment-option-item.ts +1 -1
  967. package/src/surfaces/checkout/api/pickup/pickup-location-item.ts +1 -2
  968. package/src/surfaces/checkout/api/pickup/pickup-location-list.ts +1 -1
  969. package/src/surfaces/checkout/api/pickup/pickup-point-list.ts +1 -1
  970. package/src/surfaces/checkout/api/shared.ts +5 -0
  971. package/src/surfaces/checkout/api/shipping/shipping-option-item.ts +1 -2
  972. package/src/surfaces/checkout/api/shipping/shipping-option-list.ts +1 -2
  973. package/src/surfaces/checkout/api/standard/standard.ts +23 -3
  974. package/src/surfaces/checkout/components/Abbreviation.d.ts +21 -9
  975. package/src/surfaces/checkout/components/Badge.d.ts +56 -0
  976. package/src/surfaces/checkout/components/Banner.d.ts +55 -13
  977. package/src/surfaces/checkout/components/Box.d.ts +20 -9
  978. package/src/surfaces/checkout/components/Button.d.ts +44 -13
  979. package/src/surfaces/checkout/components/Chat/examples/app-bridge-communication.example.tsx +58 -0
  980. package/src/surfaces/checkout/components/Chat/examples/app-bridge-css.example.css +16 -0
  981. package/src/surfaces/checkout/components/Chat/examples/app-bridge-resize.example.html +48 -0
  982. package/src/surfaces/checkout/components/Chat/examples/app-bridge-resize.example.tsx +9 -0
  983. package/src/surfaces/checkout/components/Chat/examples/include-app-bridge.example.html +3 -0
  984. package/src/surfaces/checkout/components/Chat/examples/shopify-extension-toml.example.toml +5 -0
  985. package/src/surfaces/checkout/components/Checkbox/examples/basic-checkbox.example.html +1 -0
  986. package/src/surfaces/checkout/components/Checkbox.d.ts +60 -0
  987. package/src/surfaces/checkout/components/Clickable.d.ts +89 -0
  988. package/src/surfaces/checkout/components/ClipboardItem.d.ts +39 -9
  989. package/src/surfaces/checkout/components/Details.d.ts +72 -0
  990. package/src/surfaces/checkout/components/Divider.d.ts +31 -0
  991. package/src/surfaces/checkout/components/DropZone.d.ts +39 -9
  992. package/src/surfaces/checkout/components/EmailField/examples/basic-emailfield.example.html +4 -0
  993. package/src/surfaces/checkout/components/EmailField.d.ts +85 -0
  994. package/src/surfaces/checkout/components/Form/examples/basic-form.example.html +1 -1
  995. package/src/surfaces/checkout/components/Form.d.ts +40 -12
  996. package/src/surfaces/checkout/components/Grid.d.ts +64 -0
  997. package/src/surfaces/checkout/components/GridItem.d.ts +54 -0
  998. package/src/surfaces/checkout/components/Heading.d.ts +20 -8
  999. package/src/surfaces/checkout/components/Icon.d.ts +22 -9
  1000. package/src/surfaces/checkout/components/Image.d.ts +13 -7
  1001. package/src/surfaces/checkout/components/Link.d.ts +44 -13
  1002. package/src/surfaces/checkout/components/ListItem.d.ts +22 -10
  1003. package/src/surfaces/checkout/components/Map/examples/basic-map.example.html +3 -0
  1004. package/src/surfaces/checkout/components/Map.d.ts +78 -0
  1005. package/src/surfaces/checkout/components/MapMarker.d.ts +77 -0
  1006. package/src/surfaces/checkout/components/Modal/examples/basic-modal.example.html +20 -0
  1007. package/src/surfaces/checkout/components/Modal.d.ts +90 -0
  1008. package/src/surfaces/checkout/components/NumberField.d.ts +85 -0
  1009. package/src/surfaces/checkout/components/Option.d.ts +46 -0
  1010. package/src/surfaces/checkout/components/OrderedList.d.ts +20 -8
  1011. package/src/surfaces/checkout/components/Paragraph.d.ts +20 -8
  1012. package/src/surfaces/checkout/components/PasswordField.d.ts +84 -0
  1013. package/src/surfaces/checkout/components/PaymentIcon.d.ts +14 -7
  1014. package/src/surfaces/checkout/components/PhoneField/examples/basic-phonefield.example.html +2 -0
  1015. package/src/surfaces/checkout/components/PhoneField.d.ts +100 -0
  1016. package/src/surfaces/checkout/components/Popover.d.ts +68 -0
  1017. package/src/surfaces/checkout/components/ProductThumbnail/examples/basic-productthumbnail.example.html +4 -0
  1018. package/src/surfaces/checkout/components/ProductThumbnail.d.ts +41 -0
  1019. package/src/surfaces/checkout/components/Progress.d.ts +14 -4
  1020. package/src/surfaces/checkout/components/QRCode.d.ts +35 -8
  1021. package/src/surfaces/checkout/components/ScrollBox.d.ts +54 -0
  1022. package/src/surfaces/checkout/components/Section.d.ts +20 -8
  1023. package/src/surfaces/checkout/components/Select.d.ts +79 -0
  1024. package/src/surfaces/checkout/components/Sheet.d.ts +94 -0
  1025. package/src/surfaces/checkout/components/SkeletonParagraph.d.ts +40 -0
  1026. package/src/surfaces/checkout/components/Spinner.d.ts +14 -4
  1027. package/src/surfaces/checkout/components/Stack.d.ts +20 -9
  1028. package/src/surfaces/checkout/components/Summary.d.ts +35 -0
  1029. package/src/surfaces/checkout/components/Switch.d.ts +60 -0
  1030. package/src/surfaces/checkout/components/Text.d.ts +20 -8
  1031. package/src/surfaces/checkout/components/TextArea/examples/basic-textarea.example.html +5 -0
  1032. package/src/surfaces/checkout/components/TextArea.d.ts +85 -0
  1033. package/src/surfaces/checkout/components/TextField.d.ts +88 -21
  1034. package/src/surfaces/checkout/components/Time.d.ts +21 -9
  1035. package/src/surfaces/checkout/components/UnorderedList.d.ts +20 -8
  1036. package/src/surfaces/checkout/components/UrlField.d.ts +84 -0
  1037. package/src/surfaces/checkout/components/components-shared.d.ts +853 -85
  1038. package/src/surfaces/checkout/components/components.d.ts +1683 -244
  1039. package/src/surfaces/checkout/extension-targets.ts +8 -0
  1040. package/src/surfaces/checkout/preact/attributes.ts +2 -2
  1041. package/src/surfaces/checkout/preact/subscription.ts +2 -1
  1042. package/src/surfaces/checkout/preact/tests/delivery-group-target.test.ts +2 -2
  1043. package/src/surfaces/checkout/shared.ts +65 -28
  1044. package/src/surfaces/checkout.ts +1 -0
  1045. package/src/surfaces/customer-account/api/cart-line/cart-line-item.ts +2 -3
  1046. package/src/surfaces/customer-account/api/docs.ts +81 -26
  1047. package/src/surfaces/customer-account/api/order-status/order-status.ts +29 -42
  1048. package/src/surfaces/customer-account/api/shared.ts +55 -44
  1049. package/src/surfaces/customer-account/api/standard-api/standard-api.ts +42 -23
  1050. package/src/surfaces/customer-account/api.ts +8 -4
  1051. package/src/surfaces/customer-account/components/Avatar/examples/basic-Avatar-preact.example.tsx +10 -0
  1052. package/src/surfaces/customer-account/components/Avatar.d.ts +92 -0
  1053. package/src/surfaces/customer-account/components/ButtonGroup/examples/basic-ButtonGroup-preact.example.tsx +22 -0
  1054. package/src/surfaces/customer-account/components/ButtonGroup.d.ts +39 -0
  1055. package/src/surfaces/customer-account/components/CustomerAccountAction/examples/basic-CustomerAccountAction-preact.example.tsx +8 -7
  1056. package/src/surfaces/customer-account/components/CustomerAccountAction.d.ts +16 -6
  1057. package/src/surfaces/customer-account/components/ImageGroup/examples/basic-ImageGroup-preact.example.tsx +6 -4
  1058. package/src/surfaces/customer-account/components/ImageGroup.d.ts +5 -5
  1059. package/src/surfaces/customer-account/components/Menu/examples/basic-Menu-preact.example.tsx +24 -0
  1060. package/src/surfaces/customer-account/components/Menu.d.ts +25 -0
  1061. package/src/surfaces/customer-account/components/Page/examples/basic-Page-preact.example.tsx +10 -9
  1062. package/src/surfaces/customer-account/components/Page.d.ts +19 -6
  1063. package/src/surfaces/customer-account/components/Section/examples/basic-Section-preact.example.tsx +23 -0
  1064. package/src/surfaces/customer-account/components/Section.d.ts +46 -0
  1065. package/src/surfaces/customer-account/components/StandardComponents.ts +6 -2
  1066. package/src/surfaces/customer-account/components/shared.ts +29 -5
  1067. package/src/surfaces/customer-account/components.d.ts +124 -31
  1068. package/src/surfaces/customer-account/extension-targets.ts +15 -9
  1069. package/src/surfaces/customer-account/globals.ts +2 -4
  1070. package/src/surfaces/customer-account/preact/live-navigation.ts +1 -8
  1071. package/src/surfaces/customer-account/preact/navigation.ts +3 -10
  1072. package/src/surfaces/customer-account/preact/subscription.ts +7 -6
  1073. package/src/surfaces/point-of-sale/api/action-api/action-api.ts +15 -0
  1074. package/src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts +9 -0
  1075. package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +239 -0
  1076. package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +11 -0
  1077. package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +25 -0
  1078. package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +10 -0
  1079. package/src/surfaces/point-of-sale/api/device-api/device-api.ts +21 -0
  1080. package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +20 -0
  1081. package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +16 -0
  1082. package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +45 -0
  1083. package/src/surfaces/point-of-sale/api/order-api/order-api.ts +26 -0
  1084. package/src/surfaces/point-of-sale/api/pin-pad-api.ts +23 -0
  1085. package/src/surfaces/point-of-sale/api/print-api/print-api.ts +29 -0
  1086. package/src/surfaces/point-of-sale/api/product-api/product-api.ts +14 -0
  1087. package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +94 -0
  1088. package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +42 -0
  1089. package/src/surfaces/point-of-sale/api/session-api/session-api.ts +22 -0
  1090. package/src/surfaces/point-of-sale/api/standard/standard-api.ts +21 -0
  1091. package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +5 -0
  1092. package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +16 -0
  1093. package/src/surfaces/point-of-sale/api.ts +133 -0
  1094. package/src/surfaces/point-of-sale/components/Badge/examples/default.html +7 -0
  1095. package/src/surfaces/point-of-sale/components/Badge.d.ts +52 -0
  1096. package/src/surfaces/point-of-sale/components/Banner/examples/default.html +15 -0
  1097. package/src/surfaces/point-of-sale/components/Banner.d.ts +60 -0
  1098. package/src/surfaces/point-of-sale/components/Box/examples/default.html +3 -0
  1099. package/src/surfaces/point-of-sale/components/Box.d.ts +64 -0
  1100. package/src/surfaces/point-of-sale/components/Button/examples/default.html +4 -0
  1101. package/src/surfaces/point-of-sale/components/Button.d.ts +67 -0
  1102. package/src/surfaces/point-of-sale/components/Choice.d.ts +49 -0
  1103. package/src/surfaces/point-of-sale/components/ChoiceList/examples/default.html +5 -0
  1104. package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +61 -0
  1105. package/src/surfaces/point-of-sale/components/Clickable/examples/default.html +3 -0
  1106. package/src/surfaces/point-of-sale/components/Clickable.d.ts +59 -0
  1107. package/src/surfaces/point-of-sale/components/DateField/examples/default.html +14 -0
  1108. package/src/surfaces/point-of-sale/components/DateField.d.ts +71 -0
  1109. package/src/surfaces/point-of-sale/components/DatePicker/examples/default.html +8 -0
  1110. package/src/surfaces/point-of-sale/components/DatePicker.d.ts +62 -0
  1111. package/src/surfaces/point-of-sale/components/DateSpinner/examples/default.html +8 -0
  1112. package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +62 -0
  1113. package/src/surfaces/point-of-sale/components/EmailField/examples/default.html +12 -0
  1114. package/src/surfaces/point-of-sale/components/EmailField.d.ts +78 -0
  1115. package/src/surfaces/point-of-sale/components/Heading/examples/default.html +8 -0
  1116. package/src/surfaces/point-of-sale/components/Heading.d.ts +49 -0
  1117. package/src/surfaces/point-of-sale/components/Icon/examples/default.html +1 -0
  1118. package/src/surfaces/point-of-sale/components/Icon.d.ts +92 -0
  1119. package/src/surfaces/point-of-sale/components/Image/examples/default.html +1 -0
  1120. package/src/surfaces/point-of-sale/components/Image.d.ts +64 -0
  1121. package/src/surfaces/point-of-sale/components/Modal/examples/default.html +9 -0
  1122. package/src/surfaces/point-of-sale/components/Modal.d.ts +70 -0
  1123. package/src/surfaces/point-of-sale/components/Navigator.d.ts +50 -0
  1124. package/src/surfaces/point-of-sale/components/NumberField/examples/default.html +2 -0
  1125. package/src/surfaces/point-of-sale/components/NumberField.d.ts +150 -0
  1126. package/src/surfaces/point-of-sale/components/Page/examples/default.html +6 -0
  1127. package/src/surfaces/point-of-sale/components/Page.d.ts +62 -0
  1128. package/src/surfaces/point-of-sale/components/Screen.d.ts +91 -0
  1129. package/src/surfaces/point-of-sale/components/ScrollBox/examples/default.html +7 -0
  1130. package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +49 -0
  1131. package/src/surfaces/point-of-sale/components/SearchField/examples/default.html +1 -0
  1132. package/src/surfaces/point-of-sale/components/SearchField.d.ts +65 -0
  1133. package/src/surfaces/point-of-sale/components/Section/examples/default.html +10 -0
  1134. package/src/surfaces/point-of-sale/components/Section.d.ts +62 -0
  1135. package/src/surfaces/point-of-sale/components/Stack/examples/default.html +4 -0
  1136. package/src/surfaces/point-of-sale/components/Stack.d.ts +116 -0
  1137. package/src/surfaces/point-of-sale/components/Text/examples/default.html +6 -0
  1138. package/src/surfaces/point-of-sale/components/Text.d.ts +54 -0
  1139. package/src/surfaces/point-of-sale/components/TextArea/examples/default.html +1 -0
  1140. package/src/surfaces/point-of-sale/components/TextArea.d.ts +79 -0
  1141. package/src/surfaces/point-of-sale/components/TextField/examples/default.html +3 -0
  1142. package/src/surfaces/point-of-sale/components/TextField.d.ts +78 -0
  1143. package/src/surfaces/point-of-sale/components/Tile/examples/default.html +5 -0
  1144. package/src/surfaces/point-of-sale/components/Tile.d.ts +98 -0
  1145. package/src/surfaces/point-of-sale/components/TimePicker/examples/default.html +4 -0
  1146. package/src/surfaces/point-of-sale/components/TimePicker.d.ts +62 -0
  1147. package/src/surfaces/point-of-sale/components/components-shared.d.ts +2924 -0
  1148. package/src/surfaces/point-of-sale/components/shared.d.ts +76 -0
  1149. package/src/surfaces/point-of-sale/components/targets/ActionExtensionComponents.ts +1 -0
  1150. package/src/surfaces/point-of-sale/components/targets/BasicComponents.ts +3 -0
  1151. package/src/surfaces/point-of-sale/components/targets/BlockExtensionComponents.ts +18 -0
  1152. package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +1 -0
  1153. package/src/surfaces/point-of-sale/components/targets/SmartGridComponents.ts +1 -0
  1154. package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +36 -0
  1155. package/src/surfaces/point-of-sale/components.d.ts +5327 -0
  1156. package/src/surfaces/point-of-sale/event/data/BaseApi.ts +3 -0
  1157. package/src/surfaces/point-of-sale/event/data/BaseData.ts +8 -0
  1158. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +7 -0
  1159. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +17 -0
  1160. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +10 -0
  1161. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +7 -0
  1162. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +10 -0
  1163. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +8 -0
  1164. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +21 -0
  1165. package/src/surfaces/point-of-sale/event/data.ts +16 -0
  1166. package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +8 -0
  1167. package/src/surfaces/point-of-sale/event/output.ts +1 -0
  1168. package/src/surfaces/point-of-sale/extension-targets.ts +202 -0
  1169. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +21 -0
  1170. package/src/surfaces/point-of-sale/types/cart.ts +188 -0
  1171. package/src/surfaces/point-of-sale/types/country-code.ts +249 -0
  1172. package/src/surfaces/point-of-sale/types/device.ts +14 -0
  1173. package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +13 -0
  1174. package/src/surfaces/point-of-sale/types/money.ts +4 -0
  1175. package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +14 -0
  1176. package/src/surfaces/point-of-sale/types/order.ts +12 -0
  1177. package/src/surfaces/point-of-sale/types/paginated-result.ts +20 -0
  1178. package/src/surfaces/point-of-sale/types/payment.ts +16 -0
  1179. package/src/surfaces/point-of-sale/types/pin-pad.ts +58 -0
  1180. package/src/surfaces/point-of-sale/types/product.ts +64 -0
  1181. package/src/surfaces/point-of-sale/types/session.ts +39 -0
  1182. package/src/surfaces/point-of-sale/types/shipping-line.ts +18 -0
  1183. package/src/surfaces/point-of-sale/types/storage.ts +73 -0
  1184. package/src/surfaces/point-of-sale/types/tax-line.ts +10 -0
  1185. package/src/surfaces/point-of-sale/types/transaction-type.ts +1 -0
  1186. package/src/surfaces/point-of-sale.ts +4 -0
  1187. package/src/surfaces/customer-account/components/CustomerAccountAction/examples/basic-CustomerAccountAction-js.example.ts +0 -15
  1188. package/src/surfaces/customer-account/components/ImageGroup/examples/basic-ImageGroup-js.example.ts +0 -17
  1189. package/src/surfaces/customer-account/components/Page/examples/basic-Page-js.example.ts +0 -39
@@ -0,0 +1,2924 @@
1
+ /** VERSION: undefined **/
2
+ /* eslint-disable import-x/extensions */
3
+ /* eslint-disable @typescript-eslint/no-namespace */
4
+ /* eslint-disable @typescript-eslint/member-ordering */
5
+ /* eslint-disable line-comment-position */
6
+ /* eslint-disable @typescript-eslint/unified-signatures */
7
+ /* eslint-disable no-var */
8
+ /* eslint-disable import-x/namespace */
9
+ /**
10
+ * TODO: Update `any` type here after this is resolved
11
+ * https://github.com/Shopify/ui-api-design/issues/139
12
+ */
13
+ export type ComponentChildren = any;
14
+ export type StringChildren = string;
15
+ export interface GlobalProps {
16
+ /**
17
+ * A unique identifier for the element.
18
+ */
19
+ id?: string;
20
+ }
21
+ export interface ActionSlots {
22
+ /**
23
+ * The primary action to perform, provided as a button or link type element.
24
+ */
25
+ primaryAction?: ComponentChildren;
26
+ /**
27
+ * The secondary actions to perform, provided as button or link type elements.
28
+ */
29
+ secondaryActions?: ComponentChildren;
30
+ }
31
+ export interface BaseOverlayProps {
32
+ /**
33
+ * Callback fired after the overlay is shown.
34
+ */
35
+ onShow?: (event: Event) => void;
36
+ /**
37
+ * Callback fired when the overlay is shown **after** any animations to show the overlay have finished.
38
+ */
39
+ onAfterShow?: (event: Event) => void;
40
+ /**
41
+ * Callback fired after the overlay is hidden.
42
+ */
43
+ onHide?: (event: Event) => void;
44
+ /**
45
+ * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished.
46
+ */
47
+ onAfterHide?: (event: Event) => void;
48
+ }
49
+ /**
50
+ * Shared interfaces for web component methods.
51
+ *
52
+ * Methods are required (not optional) because:
53
+ * - Components implementing this interface must provide all methods
54
+ * - Unlike props/attributes, methods are not rendered in HTML but are JavaScript APIs
55
+ * - Consumers expect these methods to be consistently available on all instances
56
+ */
57
+ export interface BaseOverlayMethods {
58
+ /**
59
+ * Method to show an overlay.
60
+ *
61
+ * @implementation This is a method to be called on the element and not a callback and should hence be camelCase
62
+ */
63
+ showOverlay: () => void;
64
+ /**
65
+ * Method to hide an overlay.
66
+ *
67
+ * @implementation This is a method to be called on the element and not a callback and should hence be camelCase
68
+ */
69
+ hideOverlay: () => void;
70
+ /**
71
+ * Method to toggle the visiblity of an overlay.
72
+ *
73
+ * @implementation This is a method to be called on the element and not a callback and should hence be camelCase
74
+ */
75
+ toggleOverlay: () => void;
76
+ }
77
+ export type SizeKeyword =
78
+ | 'small-500'
79
+ | 'small-400'
80
+ | 'small-300'
81
+ | 'small-200'
82
+ | 'small-100'
83
+ | 'small'
84
+ | 'base'
85
+ | 'large'
86
+ | 'large-100'
87
+ | 'large-200'
88
+ | 'large-300'
89
+ | 'large-400'
90
+ | 'large-500';
91
+ export type ColorKeyword = 'subdued' | 'base' | 'strong';
92
+ export type BackgroundColorKeyword = 'transparent' | ColorKeyword;
93
+ export interface BackgroundProps {
94
+ /**
95
+ * Adjust the background of the element.
96
+ *
97
+ * @default 'transparent'
98
+ */
99
+ background?: BackgroundColorKeyword;
100
+ }
101
+ /**
102
+ * Tone is a property for defining the color treatment of a component.
103
+ *
104
+ * A tone can apply a grouping of colors to a component. For example,
105
+ * critical may have a specific text color and background color.
106
+ *
107
+ * In some cases, like for Banner, the tone may also affect the semantic and accessibility treatment of the component.
108
+ *
109
+ * @default 'auto'
110
+ */
111
+ export type ToneKeyword =
112
+ | 'auto'
113
+ | 'neutral'
114
+ | 'info'
115
+ | 'success'
116
+ | 'caution'
117
+ | 'warning'
118
+ | 'critical'
119
+ | 'custom';
120
+ declare const privateIconArray: readonly [
121
+ 'adjust',
122
+ 'affiliate',
123
+ 'airplane',
124
+ 'alert-bubble',
125
+ 'alert-circle',
126
+ 'alert-diamond',
127
+ 'alert-location',
128
+ 'alert-octagon-filled',
129
+ 'alert-octagon',
130
+ 'alert-triangle-filled',
131
+ 'alert-triangle',
132
+ 'app-extension',
133
+ 'apps',
134
+ 'archive',
135
+ 'arrow-down-circle',
136
+ 'arrow-down-right',
137
+ 'arrow-down',
138
+ 'arrow-left-circle',
139
+ 'arrow-left',
140
+ 'arrow-right-circle',
141
+ 'arrow-right',
142
+ 'arrow-up-circle',
143
+ 'arrow-up-right',
144
+ 'arrow-up',
145
+ 'arrows-in-horizontal',
146
+ 'arrows-out-horizontal',
147
+ 'attachment',
148
+ 'automation',
149
+ 'backspace',
150
+ 'bag',
151
+ 'bank',
152
+ 'barcode',
153
+ 'bill',
154
+ 'blank',
155
+ 'blog',
156
+ 'bolt-filled',
157
+ 'bolt',
158
+ 'book-open',
159
+ 'book',
160
+ 'bug',
161
+ 'bullet',
162
+ 'business-entity',
163
+ 'button-press',
164
+ 'button',
165
+ 'calculator',
166
+ 'calendar-check',
167
+ 'calendar-compare',
168
+ 'calendar-list',
169
+ 'calendar-time',
170
+ 'calendar',
171
+ 'camera-flip',
172
+ 'camera',
173
+ 'caret-down',
174
+ 'caret-left',
175
+ 'caret-right',
176
+ 'caret-up',
177
+ 'cart-abandoned',
178
+ 'cart-discount',
179
+ 'cart-down',
180
+ 'cart-sale',
181
+ 'cart-up',
182
+ 'cart',
183
+ 'cash-dollar',
184
+ 'cash-euro',
185
+ 'cash-pound',
186
+ 'cash-rupee',
187
+ 'cash-yen',
188
+ 'catalog-product',
189
+ 'categories',
190
+ 'channels',
191
+ 'chart-cohort',
192
+ 'chart-donut',
193
+ 'chart-funnel',
194
+ 'chart-histogram-first-last',
195
+ 'chart-histogram-first',
196
+ 'chart-histogram-flat',
197
+ 'chart-histogram-full',
198
+ 'chart-histogram-growth',
199
+ 'chart-histogram-last',
200
+ 'chart-histogram-second-last',
201
+ 'chart-horizontal',
202
+ 'chart-line',
203
+ 'chart-popular',
204
+ 'chart-stacked',
205
+ 'chart-vertical',
206
+ 'chat-new',
207
+ 'chat-referral',
208
+ 'chat',
209
+ 'check-circle-filled',
210
+ 'check-circle',
211
+ 'check',
212
+ 'checkbox',
213
+ 'chevron-down-circle',
214
+ 'chevron-down',
215
+ 'chevron-left-circle',
216
+ 'chevron-left',
217
+ 'chevron-right-circle',
218
+ 'chevron-right',
219
+ 'chevron-up-circle',
220
+ 'chevron-up',
221
+ 'circle-dashed',
222
+ 'circle',
223
+ 'clipboard-check',
224
+ 'clipboard-checklist',
225
+ 'clipboard',
226
+ 'clock-revert',
227
+ 'clock',
228
+ 'code-add',
229
+ 'code',
230
+ 'collection-featured',
231
+ 'collection-list',
232
+ 'collection-reference',
233
+ 'collection',
234
+ 'color-none',
235
+ 'color',
236
+ 'compass',
237
+ 'complete',
238
+ 'compose',
239
+ 'confetti',
240
+ 'connect',
241
+ 'content',
242
+ 'contract',
243
+ 'corner-pill',
244
+ 'corner-round',
245
+ 'corner-square',
246
+ 'credit-card-cancel',
247
+ 'credit-card-percent',
248
+ 'credit-card-reader-chip',
249
+ 'credit-card-reader-tap',
250
+ 'credit-card-reader',
251
+ 'credit-card-secure',
252
+ 'credit-card-tap-chip',
253
+ 'credit-card',
254
+ 'crop',
255
+ 'currency-convert',
256
+ 'cursor-banner',
257
+ 'cursor-option',
258
+ 'cursor',
259
+ 'data-presentation',
260
+ 'data-table',
261
+ 'database-add',
262
+ 'database-connect',
263
+ 'database',
264
+ 'delete',
265
+ 'delivered',
266
+ 'delivery',
267
+ 'desktop',
268
+ 'disabled',
269
+ 'discount-add',
270
+ 'discount-code',
271
+ 'discount',
272
+ 'dns-settings',
273
+ 'dock-floating',
274
+ 'dock-side',
275
+ 'domain-landing-page',
276
+ 'domain-new',
277
+ 'domain-redirect',
278
+ 'domain',
279
+ 'download',
280
+ 'drag-drop',
281
+ 'drag-handle',
282
+ 'duplicate',
283
+ 'edit',
284
+ 'email-follow-up',
285
+ 'email-newsletter',
286
+ 'email',
287
+ 'empty',
288
+ 'enabled',
289
+ 'enter',
290
+ 'envelope-soft-pack',
291
+ 'envelope',
292
+ 'eraser',
293
+ 'exchange',
294
+ 'exit',
295
+ 'export',
296
+ 'external',
297
+ 'eye-check-mark',
298
+ 'eye-dropper-list',
299
+ 'eye-dropper',
300
+ 'eye-first',
301
+ 'eyeglasses',
302
+ 'fav',
303
+ 'favicon',
304
+ 'file-list',
305
+ 'file',
306
+ 'filter-active',
307
+ 'filter',
308
+ 'flag',
309
+ 'flip-horizontal',
310
+ 'flip-vertical',
311
+ 'flower',
312
+ 'folder-add',
313
+ 'folder-down',
314
+ 'folder-remove',
315
+ 'folder-up',
316
+ 'folder',
317
+ 'food',
318
+ 'foreground',
319
+ 'forklift',
320
+ 'forms',
321
+ 'games',
322
+ 'gauge',
323
+ 'geolocation',
324
+ 'gift-card',
325
+ 'gift',
326
+ 'git-branch',
327
+ 'git-commit',
328
+ 'git-repository',
329
+ 'globe-asia',
330
+ 'globe-europe',
331
+ 'globe-lines',
332
+ 'globe-list',
333
+ 'globe',
334
+ 'grid',
335
+ 'hashtag-decimal',
336
+ 'hashtag-list',
337
+ 'hashtag',
338
+ 'heart',
339
+ 'hide-filled',
340
+ 'hide',
341
+ 'home',
342
+ 'icons',
343
+ 'identity-card',
344
+ 'image-add',
345
+ 'image-alt',
346
+ 'image-explore',
347
+ 'image-magic',
348
+ 'image-none',
349
+ 'image-with-text-overlay',
350
+ 'image',
351
+ 'images',
352
+ 'import',
353
+ 'in-progress',
354
+ 'incentive',
355
+ 'incoming',
356
+ 'incomplete',
357
+ 'info-filled',
358
+ 'info',
359
+ 'inheritance',
360
+ 'inventory-updated',
361
+ 'inventory',
362
+ 'iq',
363
+ 'key',
364
+ 'keyboard-filled',
365
+ 'keyboard-hide',
366
+ 'keyboard',
367
+ 'label-printer',
368
+ 'language-translate',
369
+ 'language',
370
+ 'layout-block',
371
+ 'layout-buy-button-horizontal',
372
+ 'layout-buy-button-vertical',
373
+ 'layout-buy-button',
374
+ 'layout-column-1',
375
+ 'layout-columns-2',
376
+ 'layout-columns-3',
377
+ 'layout-footer',
378
+ 'layout-header',
379
+ 'layout-logo-block',
380
+ 'layout-popup',
381
+ 'layout-rows-2',
382
+ 'layout-section',
383
+ 'layout-sidebar-left',
384
+ 'layout-sidebar-right',
385
+ 'lightbulb',
386
+ 'link-list',
387
+ 'link',
388
+ 'list-bulleted',
389
+ 'list-numbered',
390
+ 'live',
391
+ 'location-none',
392
+ 'location',
393
+ 'lock',
394
+ 'map',
395
+ 'markets-euro',
396
+ 'markets-rupee',
397
+ 'markets-yen',
398
+ 'markets',
399
+ 'maximize',
400
+ 'measurement-size-list',
401
+ 'measurement-size',
402
+ 'measurement-volume-list',
403
+ 'measurement-volume',
404
+ 'measurement-weight-list',
405
+ 'measurement-weight',
406
+ 'media-receiver',
407
+ 'megaphone',
408
+ 'mention',
409
+ 'menu-horizontal',
410
+ 'menu-vertical',
411
+ 'menu',
412
+ 'merge',
413
+ 'metafields',
414
+ 'metaobject-list',
415
+ 'metaobject-reference',
416
+ 'metaobject',
417
+ 'microphone',
418
+ 'minimize',
419
+ 'minus-circle',
420
+ 'minus',
421
+ 'mobile',
422
+ 'money-none',
423
+ 'money',
424
+ 'moon',
425
+ 'nature',
426
+ 'note-add',
427
+ 'note',
428
+ 'notification',
429
+ 'order-batches',
430
+ 'order-draft',
431
+ 'order-first',
432
+ 'order-fulfilled',
433
+ 'order-repeat',
434
+ 'order-unfulfilled',
435
+ 'order',
436
+ 'orders-status',
437
+ 'organization',
438
+ 'outdent',
439
+ 'outgoing',
440
+ 'package-fulfilled',
441
+ 'package-on-hold',
442
+ 'package-returned',
443
+ 'package',
444
+ 'page-add',
445
+ 'page-attachment',
446
+ 'page-clock',
447
+ 'page-down',
448
+ 'page-heart',
449
+ 'page-list',
450
+ 'page-reference',
451
+ 'page-remove',
452
+ 'page-report',
453
+ 'page-up',
454
+ 'page',
455
+ 'pagination-end',
456
+ 'pagination-start',
457
+ 'paint-brush-flat',
458
+ 'paint-brush-round',
459
+ 'paper-check',
460
+ 'partially-complete',
461
+ 'passkey',
462
+ 'paste',
463
+ 'pause-circle',
464
+ 'payment-capture',
465
+ 'payment',
466
+ 'payout-dollar',
467
+ 'payout-euro',
468
+ 'payout-pound',
469
+ 'payout-rupee',
470
+ 'payout-yen',
471
+ 'payout',
472
+ 'person-add',
473
+ 'person-exit',
474
+ 'person-list',
475
+ 'person-lock',
476
+ 'person-remove',
477
+ 'person-segment',
478
+ 'person',
479
+ 'personalized-text',
480
+ 'phone-in',
481
+ 'phone-out',
482
+ 'phone',
483
+ 'pin-remove',
484
+ 'pin',
485
+ 'plan',
486
+ 'play-circle',
487
+ 'play',
488
+ 'plus-circle-down',
489
+ 'plus-circle-filled',
490
+ 'plus-circle-up',
491
+ 'plus-circle',
492
+ 'plus',
493
+ 'point-of-sale',
494
+ 'price-list',
495
+ 'print',
496
+ 'product-add',
497
+ 'product-cost',
498
+ 'product-list',
499
+ 'product-reference',
500
+ 'product-remove',
501
+ 'product-return',
502
+ 'product-unavailable',
503
+ 'product',
504
+ 'profile-filled',
505
+ 'profile',
506
+ 'question-circle-filled',
507
+ 'question-circle',
508
+ 'receipt-dollar',
509
+ 'receipt-euro',
510
+ 'receipt-folded',
511
+ 'receipt-paid',
512
+ 'receipt-pound',
513
+ 'receipt-refund',
514
+ 'receipt-rupee',
515
+ 'receipt-yen',
516
+ 'receipt',
517
+ 'receivables',
518
+ 'redo',
519
+ 'referral-code',
520
+ 'refresh',
521
+ 'remove-background',
522
+ 'reorder',
523
+ 'replace',
524
+ 'replay',
525
+ 'reset',
526
+ 'return',
527
+ 'reward',
528
+ 'rocket',
529
+ 'rotate-left',
530
+ 'rotate-right',
531
+ 'sandbox',
532
+ 'save',
533
+ 'savings',
534
+ 'search-add',
535
+ 'search-list',
536
+ 'search-recent',
537
+ 'search-resource',
538
+ 'search',
539
+ 'select',
540
+ 'send',
541
+ 'settings',
542
+ 'share',
543
+ 'shield-check-mark',
544
+ 'shield-none',
545
+ 'shield-pending',
546
+ 'shield-person',
547
+ 'shipping-label',
548
+ 'shopcodes',
549
+ 'slideshow',
550
+ 'smiley-happy',
551
+ 'smiley-joy',
552
+ 'smiley-neutral',
553
+ 'smiley-sad',
554
+ 'social-ad',
555
+ 'social-post',
556
+ 'sort-ascending',
557
+ 'sort-descending',
558
+ 'sort',
559
+ 'sound',
560
+ 'sports',
561
+ 'star-filled',
562
+ 'star-half',
563
+ 'star-list',
564
+ 'star',
565
+ 'status-active',
566
+ 'status',
567
+ 'stop-circle',
568
+ 'store-import',
569
+ 'store-managed',
570
+ 'store-online',
571
+ 'store',
572
+ 'sun',
573
+ 'table-masonry',
574
+ 'table',
575
+ 'tablet',
576
+ 'target',
577
+ 'tax',
578
+ 'team',
579
+ 'text-align-center',
580
+ 'text-align-left',
581
+ 'text-align-right',
582
+ 'text-block',
583
+ 'text-bold',
584
+ 'text-color',
585
+ 'text-font-list',
586
+ 'text-font',
587
+ 'text-grammar',
588
+ 'text-in-columns',
589
+ 'text-in-rows',
590
+ 'text-indent-remove',
591
+ 'text-indent',
592
+ 'text-italic',
593
+ 'text-quote',
594
+ 'text-title',
595
+ 'text-underline',
596
+ 'text-with-image',
597
+ 'text',
598
+ 'theme-edit',
599
+ 'theme-store',
600
+ 'theme-template',
601
+ 'theme',
602
+ 'three-d-environment',
603
+ 'thumbs-down',
604
+ 'thumbs-up',
605
+ 'tip-jar',
606
+ 'toggle-off',
607
+ 'toggle-on',
608
+ 'transaction-fee-dollar',
609
+ 'transaction-fee-euro',
610
+ 'transaction-fee-pound',
611
+ 'transaction-fee-rupee',
612
+ 'transaction-fee-yen',
613
+ 'transaction',
614
+ 'transfer-in',
615
+ 'transfer-internal',
616
+ 'transfer-out',
617
+ 'transfer',
618
+ 'truck',
619
+ 'undo',
620
+ 'unknown-device',
621
+ 'unlock',
622
+ 'upload',
623
+ 'variant',
624
+ 'view',
625
+ 'viewport-narrow',
626
+ 'viewport-short',
627
+ 'viewport-tall',
628
+ 'viewport-wide',
629
+ 'wallet',
630
+ 'wand',
631
+ 'watch',
632
+ 'wifi',
633
+ 'work-list',
634
+ 'work',
635
+ 'wrench',
636
+ 'x-circle-filled',
637
+ 'x-circle',
638
+ 'x',
639
+ ];
640
+ export type IconType = (typeof privateIconArray)[number];
641
+ /**
642
+ * Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.
643
+ */
644
+ export type ExtractStrict<T, U extends T> = Extract<T, U>;
645
+ export type MaybeAllValuesShorthandProperty<T extends string> =
646
+ | T
647
+ | `${T} ${T}`
648
+ | `${T} ${T} ${T}`
649
+ | `${T} ${T} ${T} ${T}`;
650
+ export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
651
+ /**
652
+ * Prevents widening string literal types in a union to `string`.
653
+ * @example
654
+ * type PropName = 'foo' | 'bar' | string
655
+ * // ^? string
656
+ * type PropName = 'foo' | 'bar' | (string & {})
657
+ * // ^? 'foo' | 'bar' | (string & {})
658
+ */
659
+ export type AnyString = string & {};
660
+ /**
661
+ * This is purely to give the ability
662
+ * to have a space or not in the string literal types.
663
+ *
664
+ * For example in the `aspectRatio` property, `16/9` and `16 / 9` are both valid.
665
+ */
666
+ export type optionalSpace = '' | ' ';
667
+ export interface BadgeProps extends GlobalProps {
668
+ /**
669
+ * The content of the Badge.
670
+ */
671
+ children?: ComponentChildren;
672
+ /**
673
+ * Sets the tone of the Badge, based on the intention of the information being conveyed.
674
+ *
675
+ * @default 'auto'
676
+ */
677
+ tone?: ToneKeyword;
678
+ /**
679
+ * Modify the color to be more or less intense.
680
+ *
681
+ * @default 'base'
682
+ */
683
+ color?: ColorKeyword;
684
+ /**
685
+ * The type of icon to be displayed in the badge.
686
+ *
687
+ * @default ''
688
+ */
689
+ icon?: IconType | AnyString;
690
+ /**
691
+ * The position of the icon in relation to the text.
692
+ */
693
+ iconPosition?: 'start' | 'end';
694
+ /**
695
+ * Adjusts the size.
696
+ *
697
+ * @default 'base'
698
+ */
699
+ size?: SizeKeyword;
700
+ }
701
+ export interface BannerProps extends GlobalProps, ActionSlots {
702
+ /**
703
+ * The title of the banner.
704
+ *
705
+ * @default ''
706
+ */
707
+ heading?: string;
708
+ /**
709
+ * The content of the Banner.
710
+ */
711
+ children?: ComponentChildren;
712
+ /**
713
+ * Sets the tone of the Banner, based on the intention of the information being conveyed.
714
+ *
715
+ * The banner is a live region and the type of status will be dictated by the Tone selected.
716
+ *
717
+ * - `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.
718
+ * - `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.
719
+ *
720
+ * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions
721
+ * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role
722
+ * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role
723
+ *
724
+ * @default 'auto'
725
+ */
726
+ tone?: ToneKeyword;
727
+ /**
728
+ * Makes the content collapsible.
729
+ * A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.
730
+ *
731
+ * @default false
732
+ */
733
+ collapsible?: boolean;
734
+ /**
735
+ * Determines whether the close button of the banner is present.
736
+ *
737
+ * When the close button is pressed, the `dismiss` event will fire,
738
+ * then `hidden` will be true,
739
+ * any animation will complete,
740
+ * and the `afterhide` event will fire.
741
+ *
742
+ * @default false
743
+ */
744
+ dismissible?: boolean;
745
+ /**
746
+ * Event handler when the banner is dismissed by the user.
747
+ *
748
+ * This does not fire when setting `hidden` manually.
749
+ *
750
+ * The `hidden` property will be `false` when this event fires.
751
+ */
752
+ onDismiss?: (event: Event) => void;
753
+ /**
754
+ * Event handler when the banner has fully hidden.
755
+ *
756
+ * The `hidden` property will be `true` when this event fires.
757
+ *
758
+ * @implementation If implementations animate the hiding of the banner,
759
+ * this event must fire after the banner has fully hidden.
760
+ * We can add an `onHide` event in future if we want to provide a hook for the start of the animation.
761
+ */
762
+ onAfterHide?: (event: Event) => void;
763
+ /**
764
+ * Determines whether the banner is hidden.
765
+ *
766
+ * If this property is being set on each framework render (as in 'controlled' usage),
767
+ * and the banner is `dismissible`,
768
+ * ensure you update app state for this property when the `dismiss` event fires.
769
+ *
770
+ * If the banner is not `dismissible`, it can still be hidden by setting this property.
771
+ *
772
+ * @default false
773
+ */
774
+ hidden?: boolean;
775
+ }
776
+ export interface DisplayProps {
777
+ /**
778
+ * Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
779
+ *
780
+ * - `auto`: the component’s initial value. The actual value depends on the component and context.
781
+ * - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
782
+ *
783
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
784
+ * @default 'auto'
785
+ */
786
+ display?: 'auto' | 'none';
787
+ }
788
+ export interface AccessibilityRoleProps {
789
+ /**
790
+ * Sets the semantic meaning of the component’s content. When set,
791
+ * the role will be used by assistive technologies to help users
792
+ * navigate the page.
793
+ *
794
+ * @implementation Although, in HTML hosts, this property changes the element used,
795
+ * changing this property must not impact the visual styling of inside or outside of the box.
796
+ *
797
+ * @default 'generic'
798
+ */
799
+ accessibilityRole?: AccessibilityRole;
800
+ }
801
+ export type AccessibilityRole =
802
+ /**
803
+ * Used to indicate the primary content.
804
+ *
805
+ * In an HTML host, `main` will render a `<main>` element.
806
+ * Learn more about the [`<main>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs.
807
+ */
808
+ | 'main'
809
+ /**
810
+ * Used to indicate the component is a header.
811
+ *
812
+ * In an HTML host `header` will render a `<header>` element.
813
+ * Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs.
814
+ */
815
+ | 'header'
816
+ /**
817
+ * Used to display information such as copyright information, navigation links, and privacy statements.
818
+ *
819
+ * In an HTML host `footer` will render a `<footer>` element.
820
+ * Learn more about the [`<footer>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/footer) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/contentinfo_role) in the MDN web docs.
821
+ */
822
+ | 'footer'
823
+ /**
824
+ * Used to indicate a generic section.
825
+ * Sections should always have a `Heading` or an accessible name provided in the `accessibilityLabel` property.
826
+ *
827
+ * In an HTML host `section` will render a `<section>` element.
828
+ * Learn more about the [`<section>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/section) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/region_role) in the MDN web docs.
829
+ *
830
+ */
831
+ | 'section'
832
+ /**
833
+ * Used to designate a supporting section that relates to the main content.
834
+ *
835
+ * In an HTML host `aside` will render an `<aside>` element.
836
+ * Learn more about the [`<aside>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/aside) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/complementary_role) in the MDN web docs.
837
+ */
838
+ | 'aside'
839
+ /**
840
+ * Used to identify major groups of links used for navigating.
841
+ *
842
+ * In an HTML host `navigation` will render a `<nav>` element.
843
+ * Learn more about the [`<nav>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/nav) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/navigation_role) in the MDN web docs.
844
+ */
845
+ | 'navigation'
846
+ /**
847
+ * Used to identify a list of ordered items.
848
+ *
849
+ * In an HTML host `ordered-list` will render a `<ol>` element.
850
+ * Learn more about the [`<ol>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/list_role) in the MDN web docs.
851
+ */
852
+ | 'ordered-list'
853
+ /**
854
+ * Used to identify an item inside a list of items.
855
+ *
856
+ * In an HTML host `list-item` will render a `<li>` element.
857
+ * Learn more about the [`<li>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/listitem_role) in the MDN web docs.
858
+ */
859
+ | 'list-item'
860
+ /**
861
+ * Used to indicates the component acts as a divider that separates and distinguishes sections of content in a list of items.
862
+ *
863
+ * In an HTML host `list-item-separator` will render as `<li role="separator">`.
864
+ * Learn more about the [`<li>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/li) and the [`separator` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/separator_role) in the MDN web docs.
865
+ */
866
+ | 'list-item-separator'
867
+ /**
868
+ * Used to identify a list of unordered items.
869
+ *
870
+ * In an HTML host `unordered-list` will render a `<ul>` element.
871
+ * Learn more about the [`<ul>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ul) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/list_role) in the MDN web docs.
872
+ */
873
+ | 'unordered-list'
874
+ /**
875
+ * Used to indicates the component acts as a divider that separates and distinguishes sections of content.
876
+ *
877
+ * In an HTML host `separator` will render as `<div role="separator">`.
878
+ * Learn more about the [`separator` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/separator_role) in the MDN web docs.
879
+ */
880
+ | 'separator'
881
+ /**
882
+ * Used to define a live region containing advisory information for the user that is not important enough to be an alert.
883
+ *
884
+ * In an HTML host `status` will render as `<div role="status">`.
885
+ * Learn more about the [`status` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) in the MDN web docs.
886
+ */
887
+ | 'status'
888
+ /**
889
+ * Used for important, and usually time-sensitive, information.
890
+ *
891
+ * In an HTML host `alert` will render as `<div role="alert">`.
892
+ * Learn more about the [`alert` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) in the MDN web docs.
893
+ */
894
+ | 'alert'
895
+ /**
896
+ * Used to create a nameless container element which has no semantic meaning on its own.
897
+ *
898
+ * In an HTML host `generic'` will render a `<div>` element.
899
+ * Learn more about the [`generic` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/generic_role) in the MDN web docs.
900
+ */
901
+ | 'generic'
902
+ /**
903
+ * Used to strip the semantic meaning of an element, but leave the visual styling intact.
904
+ *
905
+ * Synonym for `none`
906
+ * Learn more about the [`presentation` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/presentation_role) in the MDN web docs.
907
+ */
908
+ | 'presentation'
909
+ /**
910
+ * Used to strip the semantic meaning of an element, but leave the visual styling intact.
911
+ *
912
+ * Synonym for `presentation`
913
+ * Learn more about the [`none` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/none_role) in the MDN web docs.
914
+ */
915
+ | 'none';
916
+ export interface AccessibilityVisibilityProps {
917
+ /**
918
+ * Changes the visibility of the element.
919
+ *
920
+ * - `visible`: the element is visible to all users.
921
+ * - `hidden`: the element is removed from the accessibility tree but remains visible.
922
+ * - `exclusive`: the element is visually hidden but remains in the accessibility tree.
923
+ *
924
+ * @default 'visible'
925
+ */
926
+ accessibilityVisibility?: 'visible' | 'hidden' | 'exclusive';
927
+ }
928
+ export interface LabelAccessibilityVisibilityProps {
929
+ /**
930
+ * Changes the visibility of the component's label.
931
+ *
932
+ * - `visible`: the label is visible to all users.
933
+ * - `exclusive`: the label is visually hidden but remains in the accessibility tree.
934
+ *
935
+ * @default 'visible'
936
+ */
937
+ labelAccessibilityVisibility?: ExtractStrict<
938
+ AccessibilityVisibilityProps['accessibilityVisibility'],
939
+ 'visible' | 'exclusive'
940
+ >;
941
+ }
942
+ export type PaddingKeyword = SizeKeyword | 'none';
943
+ export interface PaddingProps {
944
+ /**
945
+ * Adjust the padding of all edges.
946
+ *
947
+ * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
948
+ * supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
949
+ *
950
+ * - 4 values: `block-start inline-end block-end inline-start`
951
+ * - 3 values: `block-start inline block-end`
952
+ * - 2 values: `block inline`
953
+ *
954
+ * For example:
955
+ * - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
956
+ * - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
957
+ * - `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.
958
+ * - `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.
959
+ *
960
+ * A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
961
+ *
962
+ * @default 'none'
963
+ */
964
+ padding?: MaybeAllValuesShorthandProperty<PaddingKeyword>;
965
+ /**
966
+ * Adjust the block-padding.
967
+ *
968
+ * - `large none` means block-start padding is `large`, block-end padding is `none`.
969
+ *
970
+ * This overrides the block value of `padding`.
971
+ *
972
+ * @default '' - meaning no override
973
+ */
974
+ paddingBlock?: MaybeTwoValuesShorthandProperty<PaddingKeyword> | '';
975
+ /**
976
+ * Adjust the block-start padding.
977
+ *
978
+ * This overrides the block-start value of `paddingBlock`.
979
+ *
980
+ * @default '' - meaning no override
981
+ */
982
+ paddingBlockStart?: PaddingKeyword | '';
983
+ /**
984
+ * Adjust the block-end padding.
985
+ *
986
+ * This overrides the block-end value of `paddingBlock`.
987
+ *
988
+ * @default '' - meaning no override
989
+ */
990
+ paddingBlockEnd?: PaddingKeyword | '';
991
+ /**
992
+ * Adjust the inline padding.
993
+ *
994
+ * - `large none` means inline-start padding is `large`, inline-end padding is `none`.
995
+ *
996
+ * This overrides the inline value of `padding`.
997
+ *
998
+ * @default '' - meaning no override
999
+ */
1000
+ paddingInline?: MaybeTwoValuesShorthandProperty<PaddingKeyword> | '';
1001
+ /**
1002
+ * Adjust the inline-start padding.
1003
+ *
1004
+ * This overrides the inline-start value of `paddingInline`.
1005
+ *
1006
+ * @default '' - meaning no override
1007
+ */
1008
+ paddingInlineStart?: PaddingKeyword | '';
1009
+ /**
1010
+ * Adjust the inline-end padding.
1011
+ *
1012
+ * This overrides the inline-end value of `paddingInline`.
1013
+ *
1014
+ * @default '' - meaning no override
1015
+ */
1016
+ paddingInlineEnd?: PaddingKeyword | '';
1017
+ }
1018
+ export type SizeUnits = `${number}px` | `${number}%` | `0`;
1019
+ export type SizeUnitsOrAuto = SizeUnits | 'auto';
1020
+ export type SizeUnitsOrNone = SizeUnits | 'none';
1021
+ export interface SizingProps {
1022
+ /**
1023
+ * Adjust the block size.
1024
+ *
1025
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size
1026
+ *
1027
+ * @default 'auto'
1028
+ */
1029
+ blockSize?: SizeUnitsOrAuto;
1030
+ /**
1031
+ * Adjust the minimum block size.
1032
+ *
1033
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size
1034
+ *
1035
+ * @default '0'
1036
+ */
1037
+ minBlockSize?: SizeUnits;
1038
+ /**
1039
+ * Adjust the maximum block size.
1040
+ *
1041
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size
1042
+ *
1043
+ * @default 'none'
1044
+ */
1045
+ maxBlockSize?: SizeUnitsOrNone;
1046
+ /**
1047
+ * Adjust the inline size.
1048
+ *
1049
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size
1050
+ *
1051
+ * @default 'auto'
1052
+ */
1053
+ inlineSize?: SizeUnitsOrAuto;
1054
+ /**
1055
+ * Adjust the minimum inline size.
1056
+ *
1057
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size
1058
+ *
1059
+ * @default '0'
1060
+ */
1061
+ minInlineSize?: SizeUnits;
1062
+ /**
1063
+ * Adjust the maximum inline size.
1064
+ *
1065
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size
1066
+ *
1067
+ * @default 'none'
1068
+ */
1069
+ maxInlineSize?: SizeUnitsOrNone;
1070
+ }
1071
+ export type BorderStyleKeyword =
1072
+ | 'none'
1073
+ | 'solid'
1074
+ | 'dashed'
1075
+ | 'dotted'
1076
+ | 'auto';
1077
+ export type BorderSizeKeyword = SizeKeyword | 'none';
1078
+ export type BorderRadiusKeyword = SizeKeyword | 'max' | 'none';
1079
+ /**
1080
+ * Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.
1081
+ */
1082
+ export type BorderShorthand =
1083
+ | BorderSizeKeyword
1084
+ | `${BorderSizeKeyword} ${ColorKeyword}`
1085
+ | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`;
1086
+ export interface BorderProps {
1087
+ /**
1088
+ * Set the border via the shorthand property.
1089
+ *
1090
+ * This can be a size, optionally followed by a color, optionally followed by a style.
1091
+ *
1092
+ * If the color is not specified, it will be `base`.
1093
+ *
1094
+ * If the style is not specified, it will be `auto`.
1095
+ *
1096
+ * Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.
1097
+ *
1098
+ * @example
1099
+ * // The following are equivalent:
1100
+ * <Box border="large-100 strong dashed" />
1101
+ * <Box borderWidth="large-100" borderColor="strong" borderStyle="dashed" />
1102
+ *
1103
+ * @default 'none' - equivalent to `none base auto`.
1104
+ */
1105
+ border?: BorderShorthand;
1106
+ /**
1107
+ * Set the width of the border.
1108
+ *
1109
+ * If set, it takes precedence over the `border` property's width.
1110
+ *
1111
+ * Like CSS, up to 4 values can be specified.
1112
+ *
1113
+ * If one value is specified, it applies to all sides.
1114
+ *
1115
+ * If two values are specified, they apply to the block sides and inline sides respectively.
1116
+ *
1117
+ * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
1118
+ *
1119
+ * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
1120
+ *
1121
+ * @default '' - meaning no override
1122
+ */
1123
+ borderWidth?: MaybeAllValuesShorthandProperty<BorderSizeKeyword> | '';
1124
+ /**
1125
+ * Set the style of the border.
1126
+ *
1127
+ * If set, it takes precedence over the `border` property's style.
1128
+ *
1129
+ * Like CSS, up to 4 values can be specified.
1130
+ *
1131
+ * If one value is specified, it applies to all sides.
1132
+ *
1133
+ * If two values are specified, they apply to the block sides and inline sides respectively.
1134
+ *
1135
+ * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
1136
+ *
1137
+ * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
1138
+ *
1139
+ * @default '' - meaning no override
1140
+ */
1141
+ borderStyle?: MaybeAllValuesShorthandProperty<BorderStyleKeyword> | '';
1142
+ /**
1143
+ * Set the color of the border.
1144
+ *
1145
+ * If set, it takes precedence over the `border` property's color.
1146
+ *
1147
+ * @default '' - meaning no override
1148
+ */
1149
+ borderColor?: ColorKeyword | '';
1150
+ /**
1151
+ * Set the radius of the border.
1152
+ *
1153
+ * [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is
1154
+ * supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
1155
+ *
1156
+ * - 4 values: `start-start start-end end-end end-start`
1157
+ * - 3 values: `start-start (start-end & end-start) start-end`
1158
+ * - 2 values: `(start-start & end-end) (start-end & end-start)`
1159
+ *
1160
+ * For example:
1161
+ * - `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.
1162
+ * - `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.
1163
+ * - `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.
1164
+ * - `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.
1165
+ *
1166
+ * @defaultValue 'none'
1167
+ */
1168
+ borderRadius?: MaybeAllValuesShorthandProperty<BorderRadiusKeyword>;
1169
+ }
1170
+ export interface OverflowProps {
1171
+ /**
1172
+ * Sets the overflow behavior of the element.
1173
+ *
1174
+ * - `hidden`: clips the content when it is larger than the element’s container.
1175
+ * The element will not be scrollable and the users will not be able
1176
+ * to access the clipped content by dragging or using a scroll wheel on a mouse.
1177
+ * - `visible`: the content that extends beyond the element’s container is visible.
1178
+ *
1179
+ * @default 'visible'
1180
+ */
1181
+ overflow?: 'hidden' | 'visible';
1182
+ }
1183
+ export interface BaseBoxProps
1184
+ extends AccessibilityVisibilityProps,
1185
+ BackgroundProps,
1186
+ DisplayProps,
1187
+ SizingProps,
1188
+ PaddingProps,
1189
+ BorderProps,
1190
+ OverflowProps {
1191
+ /**
1192
+ * The content of the Box.
1193
+ */
1194
+ children?: ComponentChildren;
1195
+ /**
1196
+ * A label that describes the purpose or contents of the element.
1197
+ * When set, it will be announced to users using assistive technologies and will provide them with more context.
1198
+ *
1199
+ * Only use this when the element's content is not enough context for users using assistive technologies.
1200
+ */
1201
+ accessibilityLabel?: string;
1202
+ }
1203
+ export interface BaseBoxPropsWithRole
1204
+ extends BaseBoxProps,
1205
+ AccessibilityRoleProps {}
1206
+ export interface BoxProps extends BaseBoxPropsWithRole, GlobalProps {}
1207
+ export interface FocusEventProps {
1208
+ /**
1209
+ * Callback when the element loses focus.
1210
+ *
1211
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event
1212
+ */
1213
+ onBlur?: (event: FocusEvent) => void;
1214
+ /**
1215
+ * Callback when the element receives focus.
1216
+ *
1217
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event
1218
+ */
1219
+ onFocus?: (event: FocusEvent) => void;
1220
+ }
1221
+ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
1222
+ /**
1223
+ * The behavior of the button.
1224
+ *
1225
+ * - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.
1226
+ * - `button`: Used to indicate the component acts as a button, meaning it has no default action.
1227
+ * - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).
1228
+ *
1229
+ * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.
1230
+ *
1231
+ * @default 'button'
1232
+ */
1233
+ type?: 'submit' | 'button' | 'reset';
1234
+ /**
1235
+ * Callback when the button is activated.
1236
+ * This will be called before the action indicated by `type`.
1237
+ *
1238
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
1239
+ */
1240
+ onClick?: (event: Event) => void;
1241
+ /**
1242
+ * Disables the button, meaning it cannot be clicked or receive focus.
1243
+ *
1244
+ * @default false
1245
+ */
1246
+ disabled?: boolean;
1247
+ /**
1248
+ * Replaces content with a loading indicator while a background action is being performed.
1249
+ *
1250
+ * This also disables the button.
1251
+ *
1252
+ * @default false
1253
+ */
1254
+ loading?: boolean;
1255
+ }
1256
+ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
1257
+ /**
1258
+ * The URL to link to.
1259
+ *
1260
+ * - If set, it will navigate to the location specified by `href` after executing the `click` event.
1261
+ * - If a `commandFor` is set, the `command` will be executed instead of the navigation.
1262
+ */
1263
+ href?: string;
1264
+ /**
1265
+ * Specifies where to display the linked URL.
1266
+ *
1267
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target
1268
+ *
1269
+ * 'auto': The target is automatically determined based on the origin of the URL.
1270
+ *
1271
+ * @implementation Surfaces can set specific rules on how they handle each URL.
1272
+ * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.
1273
+ * @implementation For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).
1274
+ *
1275
+ * @default 'auto'
1276
+ */
1277
+ target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString;
1278
+ /**
1279
+ * Causes the browser to treat the linked URL as a download with the string being the file name.
1280
+ * Download only works for same-origin URLs, or the blob: and data: schemes.
1281
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download
1282
+ */
1283
+ download?: string;
1284
+ /**
1285
+ * Callback when the link is activated.
1286
+ * This will be called before navigating to the location specified by `href`.
1287
+ *
1288
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
1289
+ */
1290
+ onClick?: (event: Event) => void;
1291
+ }
1292
+ export interface InteractionProps {
1293
+ /**
1294
+ * ID of a component that should respond to activations (e.g. clicks) on this component.
1295
+ *
1296
+ * See `command` for how to control the behavior of the target.
1297
+ *
1298
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor
1299
+ */
1300
+ commandFor?: string;
1301
+ /**
1302
+ * Sets the action the `commandFor` should take when this clickable is activated.
1303
+ *
1304
+ * See the documentation of particular components for the actions they support.
1305
+ *
1306
+ * - `--auto`: a default action for the target component.
1307
+ * - `--show`: shows the target component.
1308
+ * - `--hide`: hides the target component.
1309
+ * - `--toggle`: toggles the target component.
1310
+ * - `--copy`: copies the target ClipboardItem.
1311
+ *
1312
+ * @default '--auto'
1313
+ *
1314
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command
1315
+ */
1316
+ command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';
1317
+ /**
1318
+ * ID of a component that should respond to interest (e.g. hover and focus) on this component.
1319
+ */
1320
+ interestFor?: string;
1321
+ }
1322
+ export interface BaseClickableProps
1323
+ extends ButtonBehaviorProps,
1324
+ LinkBehaviorProps {}
1325
+ export interface ButtonProps extends GlobalProps, BaseClickableProps {
1326
+ /**
1327
+ * A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers.
1328
+ *
1329
+ * Use this when using only an icon or the button text is not enough context
1330
+ * for users using assistive technologies.
1331
+ */
1332
+ accessibilityLabel?: string;
1333
+ /**
1334
+ * The content of the Button.
1335
+ */
1336
+ children?: ComponentChildren;
1337
+ /**
1338
+ * The type of icon to be displayed in the button.
1339
+ *
1340
+ * @default ''
1341
+ */
1342
+ icon?: IconType | AnyString;
1343
+ /**
1344
+ * The displayed inline width of the button.
1345
+ *
1346
+ * - `auto`: the size of the button depends on the surface and context.
1347
+ * - `fill`: the button will takes up 100% of the available inline size.
1348
+ * - `fit-content`: the button will take up the minimum inline-size required to fit its content.
1349
+ *
1350
+ * @default 'auto'
1351
+ */
1352
+ inlineSize?: 'auto' | 'fill' | 'fit-content';
1353
+ /**
1354
+ * Changes the visual appearance of the Button.
1355
+ *
1356
+ * @default 'auto' - the variant is automatically determined by the Button's context
1357
+ */
1358
+ variant?: 'auto' | 'primary' | 'secondary' | 'tertiary';
1359
+ /**
1360
+ * Sets the tone of the Button, based on the intention of the information being conveyed.
1361
+ *
1362
+ * @default 'auto'
1363
+ */
1364
+ tone?: ToneKeyword;
1365
+ /**
1366
+ * Indicate the text language. Useful when the text is in a different language than the rest of the page.
1367
+ * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
1368
+ * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
1369
+ */
1370
+ lang?: string;
1371
+ }
1372
+ export interface BaseInputProps {
1373
+ /**
1374
+ * An identifier for the field that is unique within the nearest containing form.
1375
+ */
1376
+ name?: string;
1377
+ /**
1378
+ * Disables the field, disallowing any interaction.
1379
+ *
1380
+ * @default false
1381
+ */
1382
+ disabled?: boolean;
1383
+ }
1384
+ export interface InputProps extends BaseInputProps {
1385
+ /**
1386
+ * Callback when the user has **finished editing** a field, e.g. once they have blurred the field.
1387
+ *
1388
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
1389
+ */
1390
+ onChange?: (event: Event) => void;
1391
+ /**
1392
+ * Callback when the user makes any changes in the field.
1393
+ *
1394
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
1395
+ */
1396
+ onInput?: (event: Event) => void;
1397
+ /**
1398
+ * The current value for the field. If omitted, the field will be empty.
1399
+ */
1400
+ value?: string;
1401
+ /**
1402
+ * The default value for the field.
1403
+ *
1404
+ * @implementation `defaultValue` reflects to the `value` attribute.
1405
+ */
1406
+ defaultValue?: string;
1407
+ }
1408
+ export interface MultipleInputProps extends BaseInputProps {
1409
+ /**
1410
+ * Callback when the user has selected option(s).
1411
+ *
1412
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
1413
+ */
1414
+ onChange?: (event: Event) => void;
1415
+ /**
1416
+ * Callback when the user has selected option(s).
1417
+ *
1418
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event
1419
+ */
1420
+ onInput?: (event: Event) => void;
1421
+ /**
1422
+ * An array of the `value`s of the selected options.
1423
+ *
1424
+ * This is a convenience prop for setting the `selected` prop on child options.
1425
+ */
1426
+ values?: string[];
1427
+ }
1428
+ export interface FieldErrorProps {
1429
+ /**
1430
+ * Indicate an error to the user. The field will be given a specific stylistic treatment
1431
+ * to communicate problems that have to be resolved immediately.
1432
+ */
1433
+ error?: string;
1434
+ }
1435
+ export interface BasicFieldProps
1436
+ extends FieldErrorProps,
1437
+ LabelAccessibilityVisibilityProps {
1438
+ /**
1439
+ * Whether the field needs a value. This requirement adds semantic value
1440
+ * to the field, but it will not cause an error to appear automatically.
1441
+ * If you want to present an error when this field is empty, you can do
1442
+ * so with the `error` property.
1443
+ *
1444
+ * @default false
1445
+ */
1446
+ required?: boolean;
1447
+ /**
1448
+ * Content to use as the field label.
1449
+ */
1450
+ label?: string;
1451
+ }
1452
+ export interface FieldDetailsProps {
1453
+ /**
1454
+ * Additional text to provide context or guidance for the field.
1455
+ * This text is displayed along with the field and its label
1456
+ * to offer more information or instructions to the user.
1457
+ *
1458
+ * This will also be exposed to screen reader users.
1459
+ */
1460
+ details?: string;
1461
+ }
1462
+ export interface FieldProps
1463
+ extends BasicFieldProps,
1464
+ InputProps,
1465
+ FocusEventProps,
1466
+ FieldDetailsProps {
1467
+ /**
1468
+ * A short hint that describes the expected value of the field.
1469
+ */
1470
+ placeholder?: string;
1471
+ }
1472
+ export interface BaseTextFieldProps extends FieldProps {
1473
+ /**
1474
+ * The field cannot be edited by the user. It is focusable will be announced by screen readers.
1475
+ *
1476
+ * @default false
1477
+ */
1478
+ readOnly?: boolean;
1479
+ }
1480
+ export interface FieldDecorationProps {
1481
+ /**
1482
+ * A value to be displayed immediately after the editable portion of the field.
1483
+ *
1484
+ * This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".
1485
+ *
1486
+ * This cannot be edited by the user, and it isn't included in the value of the field.
1487
+ *
1488
+ * It may not be displayed until the user has interacted with the input.
1489
+ * For example, an inline label may take the place of the suffix until the user focuses the input.
1490
+ *
1491
+ * @default ''
1492
+ */
1493
+ suffix?: string;
1494
+ /**
1495
+ * A value to be displayed immediately before the editable portion of the field.
1496
+ *
1497
+ * This is useful for displaying an implied part of the value, such as "https://" or "+353".
1498
+ *
1499
+ * This cannot be edited by the user, and it isn't included in the value of the field.
1500
+ *
1501
+ * It may not be displayed until the user has interacted with the input.
1502
+ * For example, an inline label may take the place of the prefix until the user focuses the input.
1503
+ *
1504
+ * @default ''
1505
+ */
1506
+ prefix?: string;
1507
+ /**
1508
+ * The type of icon to be displayed in the field.
1509
+ *
1510
+ * @default ''
1511
+ */
1512
+ icon?: IconType | AnyString;
1513
+ /**
1514
+ * Additional content to be displayed in the field.
1515
+ * Commonly used to display an icon that activates a tooltip providing more information.
1516
+ */
1517
+ accessory?: ComponentChildren;
1518
+ }
1519
+ export interface NumberConstraintsProps {
1520
+ /**
1521
+ * The highest decimal or integer to be accepted for the field.
1522
+ * When used with `step` the value will round down to the max number.
1523
+ *
1524
+ * Note: a user will still be able to use the keyboard to input a number higher than
1525
+ * the max. It is up to the developer to add appropriate validation.
1526
+ *
1527
+ * @default Infinity
1528
+ */
1529
+ max?: number;
1530
+ /**
1531
+ * The lowest decimal or integer to be accepted for the field.
1532
+ * When used with `step` the value will round up to the min number.
1533
+ *
1534
+ * Note: a user will still be able to use the keyboard to input a number lower than
1535
+ * the min. It is up to the developer to add appropriate validation.
1536
+ *
1537
+ * @default -Infinity
1538
+ */
1539
+ min?: number;
1540
+ /**
1541
+ * The amount the value can increase or decrease by. This can be an integer or decimal.
1542
+ * If a `max` or `min` is specified with `step` when increasing/decreasing the value
1543
+ * via the buttons, the final value will always round to the `max` or `min`
1544
+ * rather than the closest valid amount.
1545
+ *
1546
+ * @default 1
1547
+ */
1548
+ step?: number;
1549
+ /**
1550
+ * Sets the type of controls displayed in the field.
1551
+ *
1552
+ * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.
1553
+ * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.
1554
+ * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.
1555
+ * - `auto`: the presence of the controls depends on the surface and context.
1556
+ *
1557
+ * @default 'auto'
1558
+ */
1559
+ controls?: 'auto' | 'stepper' | 'none';
1560
+ }
1561
+ export interface MinMaxLengthProps {
1562
+ /**
1563
+ * Specifies the maximum number of characters allowed.
1564
+ *
1565
+ * @default Infinity
1566
+ */
1567
+ maxLength?: number;
1568
+ /**
1569
+ * Specifies the min number of characters allowed.
1570
+ *
1571
+ * @default 0
1572
+ */
1573
+ minLength?: number;
1574
+ }
1575
+ export interface BaseSelectableProps {
1576
+ /**
1577
+ * A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced.
1578
+ * This can also be used to display a control without a visual label, while still providing context to users using screen readers.
1579
+ */
1580
+ accessibilityLabel?: string;
1581
+ /**
1582
+ * Disables the control, disallowing any interaction.
1583
+ *
1584
+ * @default false
1585
+ */
1586
+ disabled?: boolean;
1587
+ /**
1588
+ * The value used in form data when the control is checked.
1589
+ */
1590
+ value?: string;
1591
+ }
1592
+ export interface BaseOptionProps extends BaseSelectableProps {
1593
+ /**
1594
+ * Whether the control is active.
1595
+ *
1596
+ * @default false
1597
+ */
1598
+ selected?: boolean;
1599
+ /**
1600
+ * Whether the control is active by default.
1601
+ *
1602
+ * @implementation `defaultSelected` reflects to the `selected` attribute.
1603
+ *
1604
+ * @default false
1605
+ */
1606
+ defaultSelected?: boolean;
1607
+ }
1608
+ export interface ChoiceProps extends GlobalProps, BaseOptionProps {
1609
+ /**
1610
+ * Content to use as the choice label.
1611
+ *
1612
+ * @implementation (StringChildren) The label is produced by extracting and
1613
+ * concatenating the text nodes from the provided content; any markup or
1614
+ * element structure is ignored.
1615
+ *
1616
+ * @implementation (ComponentChildren) Behaves as a slot: any elements passed
1617
+ * are rendered as the label content (subject to surface constraints); there
1618
+ * is no coercion to a string.
1619
+ */
1620
+ children?: ComponentChildren | StringChildren;
1621
+ /**
1622
+ * Additional text to provide context or guidance for the input.
1623
+ *
1624
+ * This text is displayed along with the input and its label
1625
+ * to offer more information or instructions to the user.
1626
+ *
1627
+ * @implementation this content should be linked to the input with an `aria-describedby` attribute.
1628
+ */
1629
+ details?: ComponentChildren;
1630
+ /**
1631
+ * Set to `true` to associate a choice with the error passed to `ChoiceList`
1632
+ *
1633
+ * @default false
1634
+ */
1635
+ error?: boolean;
1636
+ /**
1637
+ * Secondary content for a choice.
1638
+ */
1639
+ secondaryContent?: ComponentChildren;
1640
+ /**
1641
+ * Content to display when the option is selected.
1642
+ *
1643
+ * This can be used to provide additional information or options related to the choice.
1644
+ */
1645
+ selectedContent?: ComponentChildren;
1646
+ }
1647
+ export interface ChoiceListProps
1648
+ extends GlobalProps,
1649
+ Pick<BasicFieldProps, 'label' | 'labelAccessibilityVisibility' | 'error'>,
1650
+ MultipleInputProps,
1651
+ FieldDetailsProps {
1652
+ /**
1653
+ * Whether multiple choices can be selected.
1654
+ *
1655
+ * @default false
1656
+ */
1657
+ multiple?: boolean;
1658
+ /**
1659
+ * The choices a user can select from.
1660
+ *
1661
+ * Accepts `Choice` components.
1662
+ */
1663
+ children?: ComponentChildren;
1664
+ /**
1665
+ * Disables the field, disallowing any interaction.
1666
+ *
1667
+ * `disabled` on any child choices is ignored when this is true.
1668
+ *
1669
+ * @default false
1670
+ */
1671
+ disabled?: MultipleInputProps['disabled'];
1672
+ /**
1673
+ * The variant of the choice grid.
1674
+ *
1675
+ * - `auto`: The variant is determined by the context.
1676
+ * - `list`: The choices are displayed in a list.
1677
+ * - `inline`: The choices are displayed on the inline axis.
1678
+ * - `block`: The choices are displayed on the block axis.
1679
+ * - `grid`: The choices are displayed in a grid.
1680
+ *
1681
+ * @implementation The `block`, `inline` and `grid` variants are more suitable for button looking choices, but it's at the
1682
+ * discretion of each surface.
1683
+ *
1684
+ * @default 'auto'
1685
+ */
1686
+ variant?: 'auto' | 'list' | 'inline' | 'block' | 'grid';
1687
+ }
1688
+ export interface ClickableProps
1689
+ extends GlobalProps,
1690
+ BaseBoxProps,
1691
+ BaseClickableProps {
1692
+ /**
1693
+ * Disables the clickable, and indicates to assistive technology that the loading is in progress.
1694
+ *
1695
+ * This also disables the clickable.
1696
+ */
1697
+ loading?: BaseClickableProps['loading'];
1698
+ /**
1699
+ * Disables the clickable, meaning it cannot be clicked or receive focus.
1700
+ *
1701
+ * In this state, onClick will not fire.
1702
+ * If the click event originates from a child element, the event will immediately stop propagating from this element.
1703
+ *
1704
+ * However, items within the clickable can still receive focus and be interacted with.
1705
+ *
1706
+ * This has no impact on the visual state by default,
1707
+ * but developers are encouraged to style the clickable accordingly.
1708
+ */
1709
+ disabled?: BaseClickableProps['disabled'];
1710
+ /**
1711
+ * Indicate the text language. Useful when the text is in a different language than the rest of the page.
1712
+ * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
1713
+ * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
1714
+ *
1715
+ * @default ''
1716
+ */
1717
+ lang?: string;
1718
+ }
1719
+ export interface AutocompleteProps<
1720
+ AutocompleteField extends AnyAutocompleteField,
1721
+ > {
1722
+ /**
1723
+ * A hint as to the intended content of the field.
1724
+ *
1725
+ * When set to `on` (the default), this property indicates that the field should support
1726
+ * autofill, but you do not have any more semantic information on the intended
1727
+ * contents.
1728
+ *
1729
+ * When set to `off`, you are indicating that this field contains sensitive
1730
+ * information, or contents that are never saved, like one-time codes.
1731
+ *
1732
+ * Alternatively, you can provide value which describes the
1733
+ * specific data you would like to be entered into this field during autofill.
1734
+ *
1735
+ * @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers.
1736
+ *
1737
+ * @default 'tel' for PhoneField
1738
+ * @default 'email' for EmailField
1739
+ * @default 'url' for URLField
1740
+ * @default 'on' for everything else
1741
+ */
1742
+ autocomplete?:
1743
+ | AutocompleteField
1744
+ | `${AutocompleteSection} ${AutocompleteField}`
1745
+ | `${AutocompleteGroup} ${AutocompleteField}`
1746
+ | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`
1747
+ | 'on'
1748
+ | 'off';
1749
+ }
1750
+ /**
1751
+ * The “section” scopes the autocomplete data that should be inserted
1752
+ * to a specific area of the page.
1753
+ *
1754
+ * Commonly used when there are multiple fields with the same autocomplete needs
1755
+ * in the same page. For example: 2 shipping address forms in the same page.
1756
+ */
1757
+ export type AutocompleteSection = `section-${string}`;
1758
+ /**
1759
+ * The contact information group the autocomplete data should be sourced from.
1760
+ */
1761
+ export type AutocompleteGroup = 'shipping' | 'billing';
1762
+ /**
1763
+ * The contact information subgroup the autocomplete data should be sourced from.
1764
+ */
1765
+ export type AutocompleteAddressGroup = 'fax' | 'home' | 'mobile' | 'pager';
1766
+ export type AnyAutocompleteField =
1767
+ | 'additional-name'
1768
+ | 'address-level1'
1769
+ | 'address-level2'
1770
+ | 'address-level3'
1771
+ | 'address-level4'
1772
+ | 'address-line1'
1773
+ | 'address-line2'
1774
+ | 'address-line3'
1775
+ | 'country-name'
1776
+ | 'country'
1777
+ | 'current-password'
1778
+ | 'email'
1779
+ | 'family-name'
1780
+ | 'given-name'
1781
+ | 'honorific-prefix'
1782
+ | 'honorific-suffix'
1783
+ | 'language'
1784
+ | 'name'
1785
+ | 'new-password'
1786
+ | 'nickname'
1787
+ | 'one-time-code'
1788
+ | 'organization-title'
1789
+ | 'organization'
1790
+ | 'photo'
1791
+ | 'postal-code'
1792
+ | 'sex'
1793
+ | 'street-address'
1794
+ | 'transaction-amount'
1795
+ | 'transaction-currency'
1796
+ | 'url'
1797
+ | 'username'
1798
+ | 'bday-day'
1799
+ | 'bday-month'
1800
+ | 'bday-year'
1801
+ | 'bday'
1802
+ | 'cc-additional-name'
1803
+ | 'cc-expiry-month'
1804
+ | 'cc-expiry-year'
1805
+ | 'cc-expiry'
1806
+ | 'cc-family-name'
1807
+ | 'cc-given-name'
1808
+ | 'cc-name'
1809
+ | 'cc-number'
1810
+ | 'cc-csc'
1811
+ | 'cc-type'
1812
+ | `${AutocompleteAddressGroup} email`
1813
+ | 'impp'
1814
+ | `${AutocompleteAddressGroup} impp`
1815
+ | 'tel'
1816
+ | 'tel-area-code'
1817
+ | 'tel-country-code'
1818
+ | 'tel-extension'
1819
+ | 'tel-local-prefix'
1820
+ | 'tel-local-suffix'
1821
+ | 'tel-local'
1822
+ | 'tel-national'
1823
+ | `${AutocompleteAddressGroup} tel`
1824
+ | `${AutocompleteAddressGroup} tel-area-code`
1825
+ | `${AutocompleteAddressGroup} tel-country-code`
1826
+ | `${AutocompleteAddressGroup} tel-extension`
1827
+ | `${AutocompleteAddressGroup} tel-local-prefix`
1828
+ | `${AutocompleteAddressGroup} tel-local-suffix`
1829
+ | `${AutocompleteAddressGroup} tel-local`
1830
+ | `${AutocompleteAddressGroup} tel-national`;
1831
+ export type TextAutocompleteField = ExtractStrict<
1832
+ AnyAutocompleteField,
1833
+ | 'additional-name'
1834
+ | 'address-level1'
1835
+ | 'address-level2'
1836
+ | 'address-level3'
1837
+ | 'address-level4'
1838
+ | 'address-line1'
1839
+ | 'address-line2'
1840
+ | 'address-line3'
1841
+ | 'country-name'
1842
+ | 'country'
1843
+ | 'family-name'
1844
+ | 'given-name'
1845
+ | 'honorific-prefix'
1846
+ | 'honorific-suffix'
1847
+ | 'language'
1848
+ | 'name'
1849
+ | 'nickname'
1850
+ | 'one-time-code'
1851
+ | 'organization-title'
1852
+ | 'organization'
1853
+ | 'postal-code'
1854
+ | 'sex'
1855
+ | 'street-address'
1856
+ | 'transaction-currency'
1857
+ | 'username'
1858
+ | 'cc-name'
1859
+ | 'cc-given-name'
1860
+ | 'cc-additional-name'
1861
+ | 'cc-family-name'
1862
+ | 'cc-type'
1863
+ >;
1864
+ export interface DatePickerProps
1865
+ extends GlobalProps,
1866
+ InputProps,
1867
+ FocusEventProps {
1868
+ /**
1869
+ * Default month to display in `YYYY-MM` format.
1870
+ *
1871
+ * This value is used until `view` is set, either directly or as a result of user interaction.
1872
+ *
1873
+ * Defaults to the current month in the user's locale.
1874
+ */
1875
+ defaultView?: string;
1876
+ /**
1877
+ * Displayed month in `YYYY-MM` format.
1878
+ *
1879
+ * `onViewChange` is called when this value changes.
1880
+ *
1881
+ * Defaults to `defaultView`.
1882
+ */
1883
+ view?: string;
1884
+ /**
1885
+ * Called whenever the month to display changes.
1886
+ *
1887
+ * @param view The new month to display in `YYYY-MM` format.
1888
+ */
1889
+ onViewChange?: (view: string) => void;
1890
+ /**
1891
+ * The type of selection the date picker allows.
1892
+ *
1893
+ * - `single` allows selecting a single date.
1894
+ * - `multiple` allows selecting multiple non-contiguous dates.
1895
+ * - `range` allows selecting a single range of dates.
1896
+ *
1897
+ * @default "single"
1898
+ */
1899
+ type?: 'single' | 'multiple' | 'range';
1900
+ /**
1901
+ * Dates that can be selected.
1902
+ *
1903
+ * A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
1904
+ *
1905
+ * The default `''` allows all dates.
1906
+ *
1907
+ * - Dates in `YYYY-MM-DD` format allow a single date.
1908
+ * - Dates in `YYYY-MM` format allow a whole month.
1909
+ * - Dates in `YYYY` format allow a whole year.
1910
+ * - Ranges are expressed as `start--end`.
1911
+ * - Ranges are inclusive.
1912
+ * - If either `start` or `end` is omitted, the range is unbounded in that direction.
1913
+ * - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
1914
+ * So `2024--` is equivalent to `2024-01-01--`.
1915
+ * - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
1916
+ * So `--2024` is equivalent to `--2024-12-31`.
1917
+ * - Whitespace is allowed either side of `--`.
1918
+ *
1919
+ * @default ""
1920
+ *
1921
+ * @example
1922
+ * `2024-02--2025` // allow any date from February 2024 to the end of 2025
1923
+ * `2024-02--` // allow any date from February 2024 to the end of the month
1924
+ * `2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024
1925
+ */
1926
+ allow?: string;
1927
+ /**
1928
+ * Dates that cannot be selected. These subtract from `allow`.
1929
+ *
1930
+ * A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
1931
+ *
1932
+ * The default `''` has no effect on `allow`.
1933
+ *
1934
+ * - Dates in `YYYY-MM-DD` format disallow a single date.
1935
+ * - Dates in `YYYY-MM` format disallow a whole month.
1936
+ * - Dates in `YYYY` format disallow a whole year.
1937
+ * - Ranges are expressed as `start--end`.
1938
+ * - Ranges are inclusive.
1939
+ * - If either `start` or `end` is omitted, the range is unbounded in that direction.
1940
+ * - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.
1941
+ * So `2024--` is equivalent to `2024-01-01--`.
1942
+ * - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.
1943
+ * So `--2024` is equivalent to `--2024-12-31`.
1944
+ * - Whitespace is allowed either side of `--`.
1945
+ *
1946
+ * @default ""
1947
+ *
1948
+ * @example
1949
+ * `--2024-02` // disallow any date before February 2024
1950
+ * `2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024
1951
+ */
1952
+ disallow?: string;
1953
+ /**
1954
+ * Days of the week that can be selected. These intersect with the result of `allow` and `disallow`.
1955
+ *
1956
+ * A comma-separated list of days. Whitespace is allowed after commas.
1957
+ *
1958
+ * The default `''` has no effect on the result of `allow` and `disallow`.
1959
+ *
1960
+ * Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
1961
+ *
1962
+ * @default ""
1963
+ *
1964
+ * @example
1965
+ * 'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.
1966
+ */
1967
+ allowDays?: string;
1968
+ /**
1969
+ * Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.
1970
+ *
1971
+ * A comma-separated list of days. Whitespace is allowed after commas.
1972
+ *
1973
+ * The default `''` has no effect on `allowDays`.
1974
+ *
1975
+ * Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.
1976
+ *
1977
+ * @default ""
1978
+ *
1979
+ * @example
1980
+ * 'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.
1981
+ */
1982
+ disallowDays?: string;
1983
+ /**
1984
+ * Default selected value.
1985
+ *
1986
+ * The default means no date is selected.
1987
+ *
1988
+ * If the provided value is invalid, no date is selected.
1989
+ *
1990
+ * - If `type="single"`, this is a date in `YYYY-MM-DD` format.
1991
+ * - If `type="multiple"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.
1992
+ * - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
1993
+ *
1994
+ * @default ""
1995
+ */
1996
+ defaultValue?: string;
1997
+ /**
1998
+ * Current selected value.
1999
+ *
2000
+ * The default means no date is selected.
2001
+ *
2002
+ * If the provided value is invalid, no date is selected.
2003
+ *
2004
+ * Otherwise:
2005
+ *
2006
+ * - If `type="single"`, this is a date in `YYYY-MM-DD` format.
2007
+ * - If `type="multiple"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.
2008
+ * - If `type="range"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.
2009
+ *
2010
+ * @default ""
2011
+ */
2012
+ value?: string;
2013
+ /**
2014
+ * Callback when any date is selected. Will fire before `onChange`.
2015
+ */
2016
+ onInput?: (event: Event) => void;
2017
+ /**
2018
+ * Callback when the `value` is changed. For `type="single"` and `type="multiple"`, this is the same as `onInput`.
2019
+ * For `type="range"`, this is only called when the range is completed by selecting the end date of the range.
2020
+ */
2021
+ onChange?: (event: Event) => void;
2022
+ }
2023
+ export interface DateFieldProps
2024
+ extends GlobalProps,
2025
+ BaseTextFieldProps,
2026
+ Pick<
2027
+ DatePickerProps,
2028
+ | 'view'
2029
+ | 'defaultView'
2030
+ | 'value'
2031
+ | 'defaultValue'
2032
+ | 'allow'
2033
+ | 'disallow'
2034
+ | 'allowDays'
2035
+ | 'disallowDays'
2036
+ | 'onViewChange'
2037
+ >,
2038
+ AutocompleteProps<DateAutocompleteField> {
2039
+ /**
2040
+ * Callback when the field has an invalid date.
2041
+ * This callback will be called, if the date typed is invalid or disabled.
2042
+ *
2043
+ * Dates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:
2044
+ * - 2021-02-31: February doesn’t have 31 days
2045
+ * - 2021-02-00: The day can’t be 00
2046
+ *
2047
+ * Disallowed dates are considered invalid.
2048
+ *
2049
+ * It’s important to note that this callback will be called only when the user **finishes editing** the date,
2050
+ * and it’s called right after the `onChange` callback.
2051
+ * The field is **not** validated on every change to the input. Once the buyer has signalled that
2052
+ * they have finished editing the field (typically, by blurring the field), the field gets validated and the callback is run if the value is invalid.
2053
+ */
2054
+ onInvalid?: (event: Event) => void;
2055
+ }
2056
+ export type DateAutocompleteField = ExtractStrict<
2057
+ AnyAutocompleteField,
2058
+ | 'bday'
2059
+ | 'bday-day'
2060
+ | 'bday-month'
2061
+ | 'bday-year'
2062
+ | 'cc-expiry'
2063
+ | 'cc-expiry-month'
2064
+ | 'cc-expiry-year'
2065
+ >;
2066
+ export interface DateSpinnerProps
2067
+ extends GlobalProps,
2068
+ Pick<
2069
+ DatePickerProps,
2070
+ 'defaultValue' | 'value' | 'onInput' | 'onChange' | 'onBlur' | 'onFocus'
2071
+ > {
2072
+ /**
2073
+ * Default selected value for the spinner.
2074
+ *
2075
+ * This uses a date in `YYYY-MM-DD` format.
2076
+ *
2077
+ * @default ""
2078
+ */
2079
+ defaultValue?: string;
2080
+ /**
2081
+ * Current selected value for the spinner.
2082
+ *
2083
+ * This uses a date in `YYYY-MM-DD` format.
2084
+ *
2085
+ * @default ""
2086
+ */
2087
+ value?: string;
2088
+ /**
2089
+ * Callback after the wheels have finished spinning and the value has
2090
+ * settled.
2091
+ *
2092
+ * Fires once when inertial/momentum scrolling stops and the selection snaps
2093
+ * into place.
2094
+ */
2095
+ onInput?: (event: Event) => void;
2096
+ /**
2097
+ * Callback when the selection has been confirmed by the user.
2098
+ *
2099
+ * Fires only when the user explicitly commits the selection (for example, by
2100
+ * pressing a confirmation control).
2101
+ */
2102
+ onChange?: (event: Event) => void;
2103
+ }
2104
+ export interface EmailFieldProps
2105
+ extends GlobalProps,
2106
+ BaseTextFieldProps,
2107
+ MinMaxLengthProps,
2108
+ AutocompleteProps<EmailAutocompleteField> {}
2109
+ export type EmailAutocompleteField = ExtractStrict<
2110
+ AnyAutocompleteField,
2111
+ 'email' | `${AutocompleteAddressGroup} email`
2112
+ >;
2113
+ export type SpacingKeyword = SizeKeyword | 'none';
2114
+ export interface GapProps {
2115
+ /**
2116
+ * Adjust spacing between elements.
2117
+ *
2118
+ * A single value applies to both axes.
2119
+ * A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.
2120
+ *
2121
+ * @default 'none'
2122
+ */
2123
+ gap?: MaybeTwoValuesShorthandProperty<SpacingKeyword>;
2124
+ /**
2125
+ * Adjust spacing between elements in the block axis.
2126
+ *
2127
+ * This overrides the row value of `gap`.
2128
+ *
2129
+ * @default '' - meaning no override
2130
+ */
2131
+ rowGap?: SpacingKeyword | '';
2132
+ /**
2133
+ * Adjust spacing between elements in the inline axis.
2134
+ *
2135
+ * This overrides the column value of `gap`.
2136
+ *
2137
+ * @default '' - meaning no override
2138
+ */
2139
+ columnGap?: SpacingKeyword | '';
2140
+ }
2141
+ export type BaselinePosition = 'baseline' | 'first baseline' | 'last baseline';
2142
+ export type ContentDistribution =
2143
+ | 'space-between'
2144
+ | 'space-around'
2145
+ | 'space-evenly'
2146
+ | 'stretch';
2147
+ export type ContentPosition = 'center' | 'start' | 'end';
2148
+ export type OverflowPosition =
2149
+ | `unsafe ${ContentPosition}`
2150
+ | `safe ${ContentPosition}`;
2151
+ /**
2152
+ * Align items sets the align-self value on all direct children as a group.
2153
+ *
2154
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
2155
+ */
2156
+ export type AlignItemsKeyword =
2157
+ | 'normal'
2158
+ | 'stretch'
2159
+ | BaselinePosition
2160
+ | OverflowPosition
2161
+ | ContentPosition;
2162
+ /**
2163
+ * Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container.
2164
+ *
2165
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
2166
+ */
2167
+ export type JustifyContentKeyword =
2168
+ | 'normal'
2169
+ | ContentDistribution
2170
+ | OverflowPosition
2171
+ | ContentPosition;
2172
+ /**
2173
+ *Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.
2174
+ *
2175
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
2176
+ */
2177
+ export type AlignContentKeyword =
2178
+ | 'normal'
2179
+ | BaselinePosition
2180
+ | ContentDistribution
2181
+ | OverflowPosition
2182
+ | ContentPosition;
2183
+ export interface BaseTypographyProps {
2184
+ /**
2185
+ * Modify the color to be more or less intense.
2186
+ *
2187
+ * @default 'base'
2188
+ */
2189
+ color?: ColorKeyword;
2190
+ /**
2191
+ * Sets the tone of the component, based on the intention of the information being conveyed.
2192
+ *
2193
+ * @default 'auto'
2194
+ */
2195
+ tone?: ToneKeyword;
2196
+ /**
2197
+ * Set the numeric properties of the font.
2198
+ *
2199
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric
2200
+ *
2201
+ * @default 'auto' - inherit from the parent element
2202
+ */
2203
+ fontVariantNumeric?: 'auto' | 'normal' | 'tabular-nums';
2204
+ /**
2205
+ * Indicate the text language. Useful when the text is in a different language than the rest of the page.
2206
+ * It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
2207
+ * [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
2208
+ *
2209
+ * It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.
2210
+ *
2211
+ * @default ''
2212
+ */
2213
+ lang?: string;
2214
+ /**
2215
+ * Indicates the directionality of the element’s text.
2216
+ *
2217
+ * - `ltr`: languages written from left to right (e.g. English)
2218
+ * - `rtl`: languages written from right to left (e.g. Arabic)
2219
+ * - `auto`: the user agent determines the direction based on the content
2220
+ * - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)
2221
+ *
2222
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir
2223
+ *
2224
+ * @default ''
2225
+ */
2226
+ dir?: 'ltr' | 'rtl' | 'auto' | '';
2227
+ }
2228
+ export interface IconProps
2229
+ extends GlobalProps,
2230
+ Pick<InteractionProps, 'interestFor'> {
2231
+ /**
2232
+ * Sets the tone of the icon, based on the intention of the information being conveyed.
2233
+ *
2234
+ * @default 'auto'
2235
+ */
2236
+ tone?: ToneKeyword;
2237
+ /**
2238
+ * Modify the color to be more or less intense.
2239
+ *
2240
+ * @default 'base'
2241
+ */
2242
+ color?: ColorKeyword;
2243
+ /**
2244
+ * Adjusts the size of the icon.
2245
+ *
2246
+ * @default 'base'
2247
+ */
2248
+ size?: SizeKeyword;
2249
+ type?: IconType | AnyString;
2250
+ }
2251
+ export interface BaseImageProps {
2252
+ /**
2253
+ * An alternative text description that describe the image for the reader to
2254
+ * understand what it is about. It is extremely useful for both users using
2255
+ * assistive technology and sighted users. A well written description
2256
+ * provides people with visual impairments the ability to participate in
2257
+ * consuming non-text content. When a screen readers encounters an `s-image`,
2258
+ * the description is read and announced aloud. If an image fails to load,
2259
+ * potentially due to a poor connection, the `alt` is displayed on
2260
+ * screen instead. This has the benefit of letting a sighted buyer know an
2261
+ * image was meant to load here, but as an alternative, they’re still able to
2262
+ * consume the text content. Read
2263
+ * [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4)
2264
+ * to learn more.
2265
+ *
2266
+ * @default `''`
2267
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
2268
+ */
2269
+ alt?: string;
2270
+ /**
2271
+ * A set of media conditions and their corresponding sizes.
2272
+ *
2273
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes
2274
+ */
2275
+ sizes?: string;
2276
+ /**
2277
+ * The image source (either a remote URL or a local file resource).
2278
+ *
2279
+ * When the image is loading or no `src` is provided, a placeholder will be rendered.
2280
+ *
2281
+ * @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be
2282
+ * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.
2283
+ *
2284
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
2285
+ */
2286
+ src?: string;
2287
+ /**
2288
+ * A set of image sources and their width or pixel density descriptors.
2289
+ *
2290
+ * This overrides the `src` property.
2291
+ *
2292
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset
2293
+ */
2294
+ srcSet?: string;
2295
+ }
2296
+ export interface ImageProps extends GlobalProps, BaseImageProps, BorderProps {
2297
+ /**
2298
+ * Sets the semantic meaning of the component’s content. When set,
2299
+ * the role will be used by assistive technologies to help users
2300
+ * navigate the page.
2301
+ *
2302
+ * @default 'img'
2303
+ *
2304
+ * @implementation The `img` role doesn't need to be applied if
2305
+ * the host applies it for you; for example, an HTML host rendering
2306
+ * an `<img>` element should not apply the `img` role.
2307
+ */
2308
+ accessibilityRole?:
2309
+ | 'img'
2310
+ | ExtractStrict<AccessibilityRole, 'presentation' | 'none'>;
2311
+ /**
2312
+ * The displayed inline width of the image.
2313
+ *
2314
+ * - `fill`: the image will takes up 100% of the available inline size.
2315
+ * - `auto`: the image will be displayed at its natural size.
2316
+ *
2317
+ * @default 'fill'
2318
+ *
2319
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width
2320
+ */
2321
+ inlineSize?: 'fill' | 'auto';
2322
+ /**
2323
+ * The aspect ratio of the image.
2324
+ *
2325
+ * The rendering of the image will depend on the `inlineSize` value:
2326
+ *
2327
+ * - `inlineSize="fill"`: the aspect ratio will be respected and the image will take the necessary space.
2328
+ * - `inlineSize="auto"`: the image will not render until it has loaded and the aspect ratio will be ignored.
2329
+ *
2330
+ * For example, if the value is set as `50 / 100`, the getter returns `50 / 100`.
2331
+ * If the value is set as `0.5`, the getter returns `0.5 / 1`.
2332
+ *
2333
+ * @default '1/1'
2334
+ *
2335
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio
2336
+ */
2337
+ aspectRatio?:
2338
+ | `${number}${optionalSpace}/${optionalSpace}${number}`
2339
+ | `${number}`;
2340
+ /**
2341
+ * Determines how the content of the image is resized to fit its container.
2342
+ * The image is positioned in the center of the container.
2343
+ *
2344
+ * @default 'contain'
2345
+ *
2346
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
2347
+ */
2348
+ objectFit?: 'contain' | 'cover';
2349
+ /**
2350
+ * Determines the loading behavior of the image:
2351
+ * - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
2352
+ * - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
2353
+ *
2354
+ * @default 'eager'
2355
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
2356
+ */
2357
+ loading?: 'eager' | 'lazy';
2358
+ /**
2359
+ * Invoked when load completes successfully.
2360
+ *
2361
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
2362
+ */
2363
+ onLoad?: (event: Event) => void;
2364
+ /**
2365
+ * Invoked on load error.
2366
+ *
2367
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
2368
+ */
2369
+ onError?: (event: Event) => void;
2370
+ }
2371
+ export interface ModalProps
2372
+ extends GlobalProps,
2373
+ BaseOverlayProps,
2374
+ BaseOverlayMethods,
2375
+ ActionSlots {
2376
+ /**
2377
+ * A label that describes the purpose of the modal. When set,
2378
+ * it will be announced to users using assistive technologies and will
2379
+ * provide them with more context.
2380
+ *
2381
+ * This overrides the `heading` prop for screen readers.
2382
+ */
2383
+ accessibilityLabel?: string;
2384
+ /**
2385
+ * A title that describes the content of the Modal.
2386
+ *
2387
+ */
2388
+ heading?: string;
2389
+ /**
2390
+ * Adjust the padding around the Modal content.
2391
+ *
2392
+ * `base`: applies padding that is appropriate for the element.
2393
+ *
2394
+ * `none`: removes all padding from the element. This can be useful when elements inside the Modal need to span
2395
+ * to the edge of the Modal. For example, a full-width image. In this case, rely on `Box` with a padding of 'base'
2396
+ * to bring back the desired padding for the rest of the content.
2397
+ *
2398
+ * @default 'base'
2399
+ */
2400
+ padding?: 'base' | 'none';
2401
+ /**
2402
+ * Adjust the size of the Modal.
2403
+ *
2404
+ * `max`: expands the Modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.
2405
+ *
2406
+ * @default 'base'
2407
+ */
2408
+ size?: SizeKeyword | 'max';
2409
+ /**
2410
+ * The content of the Modal.
2411
+ */
2412
+ children?: ComponentChildren;
2413
+ }
2414
+ export interface NumberFieldProps
2415
+ extends GlobalProps,
2416
+ BaseTextFieldProps,
2417
+ AutocompleteProps<NumberAutocompleteField>,
2418
+ NumberConstraintsProps,
2419
+ FieldDecorationProps {
2420
+ /**
2421
+ * Sets the virtual keyboard.
2422
+ *
2423
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
2424
+ * @default 'decimal'
2425
+ */
2426
+ inputMode?: 'decimal' | 'numeric';
2427
+ }
2428
+ export type NumberAutocompleteField = ExtractStrict<
2429
+ AnyAutocompleteField,
2430
+ 'one-time-code' | 'cc-number' | 'cc-csc'
2431
+ >;
2432
+ export interface PageProps extends GlobalProps {
2433
+ /**
2434
+ * The content of the Page.
2435
+ */
2436
+ children?: ComponentChildren;
2437
+ /**
2438
+ * The main page heading
2439
+ */
2440
+ heading?: string;
2441
+ /**
2442
+ * The text to be used as subtitle.
2443
+ */
2444
+ subheading?: string;
2445
+ /**
2446
+ * Additional contextual information about the page.
2447
+ */
2448
+ accessory?: ComponentChildren;
2449
+ /**
2450
+ * The primary action to perform, provided as a button or link type element.
2451
+ * When a `Button` is added to the `primaryAction` it's variant is set to `primary`
2452
+ */
2453
+ primaryAction?: ComponentChildren;
2454
+ /**
2455
+ * The breadcrumb actions to perform, provided as link elements.
2456
+ */
2457
+ breadcrumbActions?: ComponentChildren;
2458
+ /**
2459
+ * Secondary actions. These are `Button`s that will be contextually the 'secondary' variant.
2460
+ */
2461
+ secondaryActions?: ComponentChildren;
2462
+ /**
2463
+ * The aside element is section of a page that contains content that is tangentially related to the content around the aside element, and which could be considered separate from that content.
2464
+ * Such sections are often represented as sidebars in printed typography.
2465
+ * @implementation surfaces built ontop of the web platform should implement this using the <aside> element https://developer.mozilla.org/en-US/docs/Web/HTML/Element/aside
2466
+ */
2467
+ aside?: ComponentChildren;
2468
+ /**
2469
+ * The inline size of the page
2470
+ * - `base` corresponds to a set default inline size
2471
+ * - `large` full width with whitespace
2472
+ *
2473
+ * @default 'base'
2474
+ */
2475
+ inlineSize?: SizeKeyword;
2476
+ }
2477
+ export type OverflowKeyword = 'auto' | 'hidden';
2478
+ export interface ScrollBoxProps
2479
+ extends GlobalProps,
2480
+ Omit<BaseBoxPropsWithRole, 'overflow'> {
2481
+ /**
2482
+ * Sets the overflow behavior of the element.
2483
+ *
2484
+ * - `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.
2485
+ * - `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.
2486
+ *
2487
+ * 1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is:
2488
+ *
2489
+ * - 2 values: `block inline`
2490
+ *
2491
+ * @default 'auto'
2492
+ *
2493
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/overflow
2494
+ */
2495
+ overflow?: OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`;
2496
+ }
2497
+ export interface SearchFieldProps
2498
+ extends GlobalProps,
2499
+ BaseTextFieldProps,
2500
+ MinMaxLengthProps,
2501
+ AutocompleteProps<SearchAutocompleteField> {}
2502
+ export type SearchAutocompleteField = TextAutocompleteField;
2503
+ export interface SectionProps extends GlobalProps, ActionSlots {
2504
+ /**
2505
+ * The content of the Section.
2506
+ */
2507
+ children?: ComponentChildren;
2508
+ /**
2509
+ * A label used to describe the section that will be announced by assistive technologies.
2510
+ *
2511
+ * When no `heading` property is provided or included as a children of the Section, you **must** provide an
2512
+ * `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide
2513
+ * the right context to users.
2514
+ */
2515
+ accessibilityLabel?: string;
2516
+ /**
2517
+ * A title that describes the content of the section.
2518
+ */
2519
+ heading?: string;
2520
+ /**
2521
+ * Adjust the padding of all edges.
2522
+ *
2523
+ * - `base`: applies padding that is appropriate for the element. Note that it may result in no padding if
2524
+ * this is the right design decision in a particular context.
2525
+ * - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span
2526
+ * to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base'
2527
+ * to bring back the desired padding for the rest of the content.
2528
+ *
2529
+ * @default 'base'
2530
+ */
2531
+ padding?: 'base' | 'none';
2532
+ }
2533
+ export interface StackProps
2534
+ extends GlobalProps,
2535
+ BaseBoxPropsWithRole,
2536
+ GapProps {
2537
+ /**
2538
+ * The content of the Stack.
2539
+ */
2540
+ children?: ComponentChildren;
2541
+ /**
2542
+ * Sets how the children are placed within the Stack.
2543
+ *
2544
+ * @default 'block'
2545
+ *
2546
+ * @implementation the content will wrap if the direction is 'inline', and not wrap if the direction is 'block'
2547
+ */
2548
+ direction?: 'block' | 'inline';
2549
+ /**
2550
+ * Aligns the Stack along the main axis.
2551
+ *
2552
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
2553
+ * @default 'normal'
2554
+ */
2555
+ justifyContent?: JustifyContentKeyword;
2556
+ /**
2557
+ * Aligns the Stack's children along the cross axis.
2558
+ *
2559
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
2560
+ * @default 'normal'
2561
+ */
2562
+ alignItems?: AlignItemsKeyword;
2563
+ /**
2564
+ * Aligns the Stack along the cross axis.
2565
+ *
2566
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
2567
+ * @default 'normal'
2568
+ */
2569
+ alignContent?: AlignContentKeyword;
2570
+ }
2571
+ export interface TextProps
2572
+ extends GlobalProps,
2573
+ AccessibilityVisibilityProps,
2574
+ BaseTypographyProps,
2575
+ DisplayProps,
2576
+ Pick<InteractionProps, 'interestFor'> {
2577
+ /**
2578
+ * The content of the Text.
2579
+ */
2580
+ children?: ComponentChildren;
2581
+ /**
2582
+ * Provide semantic meaning and default styling to the text.
2583
+ *
2584
+ * Other presentation properties on `<s-text>` override the default styling.
2585
+ *
2586
+ * @default 'generic'
2587
+ */
2588
+ type?: TextType;
2589
+ }
2590
+ export type TextType =
2591
+ /**
2592
+ * Indicate the text is contact information. Typically used for addresses.
2593
+ *
2594
+ * This must have `inline` layout (despite the default being `block` in HTML hosts).
2595
+ *
2596
+ * Surfaces may apply styling to this type.
2597
+ *
2598
+ * In an HTML host, the text will be rendered in an `<address>` element.
2599
+ *
2600
+ * @implementation vertical alignment should be `baseline` (`vertical-align: baseline`)
2601
+ *
2602
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address
2603
+ */
2604
+ | 'address'
2605
+ /**
2606
+ * Indicate the text is no longer accurate or no longer relevant. One such use-case is discounted prices.
2607
+ *
2608
+ * Surfaces should apply styling to this type to suggest its content no longer applies.
2609
+ *
2610
+ * In an HTML host, the text will be rendered in a `<s>` element.
2611
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s
2612
+ */
2613
+ | 'redundant'
2614
+ /**
2615
+ * Indicate the text is marked or highlighted and relevant to the user’s current action.
2616
+ * One such use-case is to indicate the characters that matched a search query.
2617
+ *
2618
+ * Surfaces should apply styling to this type to draw attention to the content.
2619
+ *
2620
+ * In an HTML host, the text will be rendered in a `<mark>` element.
2621
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark
2622
+ */
2623
+ | 'mark'
2624
+ /**
2625
+ * Indicate emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.
2626
+ *
2627
+ * Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required.
2628
+ *
2629
+ * In an HTML host, the text will be rendered in an `<em>` element.
2630
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em
2631
+ */
2632
+ | 'emphasis'
2633
+ /**
2634
+ * Indicate an offset from the normal prose of the text. Typically used to indicate
2635
+ * a foreign word, fictional character thoughts, or when the text refers to the definition of a word
2636
+ * instead of representing its semantic meaning.
2637
+ *
2638
+ * Surfaces should italicize this content by default.
2639
+ *
2640
+ * In an HTML host, the text will be rendered in a `<i>` tag.
2641
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i
2642
+ */
2643
+ | 'offset'
2644
+ /**
2645
+ * Indicate strong importance, seriousness, or urgency.
2646
+ *
2647
+ * Surfaces should render this content bold by default.
2648
+ *
2649
+ * In an HTML host, the text will be rendered in a `<strong>` tag.
2650
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong
2651
+ */
2652
+ | 'strong'
2653
+ /**
2654
+ * Indicates the text is considered less important than the main content, but is still necessary for the reader to understand.
2655
+ * It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
2656
+ *
2657
+ * Surfaces should apply a smaller font size than the default size.
2658
+ *
2659
+ * In an HTML host, the text will be rendered in a `<small>` element.
2660
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
2661
+ */
2662
+ | 'small'
2663
+ /**
2664
+ * No additional semantics or styling is applied.
2665
+ *
2666
+ * Surfaces must not apply any default styling to this type.
2667
+ *
2668
+ * In an HTML host, the text will be rendered in a `<span>` tag.
2669
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span
2670
+ */
2671
+ | 'generic';
2672
+ export interface TextAreaProps
2673
+ extends GlobalProps,
2674
+ BaseTextFieldProps,
2675
+ MinMaxLengthProps,
2676
+ AutocompleteProps<TextAutocompleteField> {
2677
+ /**
2678
+ * A number of visible text lines.
2679
+ *
2680
+ * @default 2
2681
+ */
2682
+ rows?: number;
2683
+ }
2684
+ export interface TextFieldProps
2685
+ extends GlobalProps,
2686
+ BaseTextFieldProps,
2687
+ MinMaxLengthProps,
2688
+ AutocompleteProps<TextAutocompleteField>,
2689
+ FieldDecorationProps {}
2690
+ export interface TimePickerProps
2691
+ extends GlobalProps,
2692
+ InputProps,
2693
+ FocusEventProps {
2694
+ /**
2695
+ * Times that can be selected.
2696
+ *
2697
+ * A comma-separated list of allowed time ranges. Whitespace is allowed after commas.
2698
+ *
2699
+ * The default `''` allows all times.
2700
+ *
2701
+ * Each time range is in `HH:MM--HH:MM` format.
2702
+ *
2703
+ * The end of the range is exclusive, so `09:00--10:00` allows selecting `09:00` but not `10:00`.
2704
+ *
2705
+ * Either side of `--` can be omitted to create an unbounded range.
2706
+ *
2707
+ * Whitespace is allowed either side of `--`.
2708
+ *
2709
+ * @default ''
2710
+ *
2711
+ * @example
2712
+ * `09:00--10:00, 13:00--14:00` - assuming the step is 1 hour, this allows selecting `09:00` or `13:00`.
2713
+ * `12:00--` - allows selecting `12:00` and all times after it.
2714
+ */
2715
+ allow?: string;
2716
+ /**
2717
+ * Times that cannot be selected. This subtracts from `allow`.
2718
+ *
2719
+ * A comma-separated list of allowed time ranges. Whitespace is allowed after commas.
2720
+ *
2721
+ * The default `''` has no effect on `allow`.
2722
+ *
2723
+ * Each time range is in `HH:MM--HH:MM` format.
2724
+ *
2725
+ * The end of the range is exclusive, so `09:00--10:00` disallows selecting `09:00` but not `10:00`.
2726
+ *
2727
+ * Either side of `--` can be omitted to create an unbounded range.
2728
+ *
2729
+ * Whitespace is allowed either side of `--`.
2730
+ *
2731
+ * @default ''
2732
+ *
2733
+ * @example
2734
+ * `09:00--10:00, 13:00--14:00` - assuming the step is 1 hour, this disallows selecting `09:00` or `13:00`.
2735
+ */
2736
+ disallow?: string;
2737
+ /**
2738
+ * Default selected value.
2739
+ *
2740
+ * The default, `''`, means no time is selected.
2741
+ *
2742
+ * The value must be in `HH:MM` format.
2743
+ *
2744
+ * If the provided value is invalid, '' is used as the value.
2745
+ *
2746
+ * @default ''
2747
+ */
2748
+ defaultValue?: string;
2749
+ /**
2750
+ * Current selected value.
2751
+ *
2752
+ * The default, `''`, means no time is selected.
2753
+ *
2754
+ * The value must be in `HH:MM` format.
2755
+ *
2756
+ * If the provided value is invalid, '' is used as the value.
2757
+ *
2758
+ * @default ''
2759
+ */
2760
+ value?: string;
2761
+ /**
2762
+ * The step between selectable times, in seconds.
2763
+ *
2764
+ * @default 60
2765
+ */
2766
+ step?: number;
2767
+ }
2768
+ //
2769
+ // Preact Virtual DOM
2770
+ // -----------------------------------
2771
+ export interface VNode<P = {}> {
2772
+ type: ComponentType<P> | string;
2773
+ props: P & {
2774
+ children: ComponentChildren$1;
2775
+ };
2776
+ key: Key;
2777
+ /**
2778
+ * ref is not guaranteed by React.ReactElement, for compatibility reasons
2779
+ * with popular react libs we define it as optional too
2780
+ */
2781
+ ref?: Ref<any> | null;
2782
+ /**
2783
+ * The time this `vnode` started rendering. Will only be set when
2784
+ * the devtools are attached.
2785
+ * Default value: `0`
2786
+ */
2787
+ startTime?: number;
2788
+ /**
2789
+ * The time that the rendering of this `vnode` was completed. Will only be
2790
+ * set when the devtools are attached.
2791
+ * Default value: `-1`
2792
+ */
2793
+ endTime?: number;
2794
+ }
2795
+ //
2796
+ // Preact Component interface
2797
+ // -----------------------------------
2798
+ export type Key = string | number | any;
2799
+ export type RefObject<T> = {
2800
+ current: T | null;
2801
+ };
2802
+ export type RefCallback<T> = (instance: T | null) => void | (() => void);
2803
+ export type Ref<T> = RefObject<T> | RefCallback<T> | null;
2804
+ export type ComponentChild =
2805
+ | VNode<any>
2806
+ | object
2807
+ | string
2808
+ | number
2809
+ | bigint
2810
+ | boolean
2811
+ | null
2812
+ | undefined;
2813
+ type ComponentChildren$1 = ComponentChild[] | ComponentChild;
2814
+ export interface Attributes {
2815
+ key?: Key | undefined;
2816
+ jsx?: boolean | undefined;
2817
+ }
2818
+ export interface ErrorInfo {
2819
+ componentStack?: string;
2820
+ }
2821
+ export type RenderableProps<P, RefType = any> = P &
2822
+ Readonly<
2823
+ Attributes & {
2824
+ children?: ComponentChildren$1;
2825
+ ref?: Ref<RefType>;
2826
+ }
2827
+ >;
2828
+ export type ComponentType<P = {}> = ComponentClass<P> | FunctionComponent<P>;
2829
+ export interface FunctionComponent<P = {}> {
2830
+ (props: RenderableProps<P>, context?: any): ComponentChildren$1;
2831
+ displayName?: string;
2832
+ defaultProps?: Partial<P> | undefined;
2833
+ }
2834
+ export interface ComponentClass<P = {}, S = {}> {
2835
+ new (props: P, context?: any): Component<P, S>;
2836
+ displayName?: string;
2837
+ defaultProps?: Partial<P>;
2838
+ contextType?: Context<any>;
2839
+ getDerivedStateFromProps?(
2840
+ props: Readonly<P>,
2841
+ state: Readonly<S>,
2842
+ ): Partial<S> | null;
2843
+ getDerivedStateFromError?(error: any): Partial<S> | null;
2844
+ }
2845
+ export interface Component<P = {}, S = {}> {
2846
+ componentWillMount?(): void;
2847
+ componentDidMount?(): void;
2848
+ componentWillUnmount?(): void;
2849
+ getChildContext?(): object;
2850
+ componentWillReceiveProps?(nextProps: Readonly<P>, nextContext: any): void;
2851
+ shouldComponentUpdate?(
2852
+ nextProps: Readonly<P>,
2853
+ nextState: Readonly<S>,
2854
+ nextContext: any,
2855
+ ): boolean;
2856
+ componentWillUpdate?(
2857
+ nextProps: Readonly<P>,
2858
+ nextState: Readonly<S>,
2859
+ nextContext: any,
2860
+ ): void;
2861
+ getSnapshotBeforeUpdate?(oldProps: Readonly<P>, oldState: Readonly<S>): any;
2862
+ componentDidUpdate?(
2863
+ previousProps: Readonly<P>,
2864
+ previousState: Readonly<S>,
2865
+ snapshot: any,
2866
+ ): void;
2867
+ componentDidCatch?(error: any, errorInfo: ErrorInfo): void;
2868
+ }
2869
+ declare abstract class Component<P, S> {
2870
+ constructor(props?: P, context?: any);
2871
+ static displayName?: string;
2872
+ static defaultProps?: any;
2873
+ static contextType?: Context<any>;
2874
+ // Static members cannot reference class type parameters. This is not
2875
+ // supported in TypeScript. Reusing the same type arguments from `Component`
2876
+ // will lead to an impossible state where one cannot satisfy the type
2877
+ // constraint under no circumstances, see #1356.In general type arguments
2878
+ // seem to be a bit buggy and not supported well at the time of this
2879
+ // writing with TS 3.3.3333.
2880
+ static getDerivedStateFromProps?(
2881
+ props: Readonly<object>,
2882
+ state: Readonly<object>,
2883
+ ): object | null;
2884
+ static getDerivedStateFromError?(error: any): object | null;
2885
+ state: Readonly<S>;
2886
+ props: RenderableProps<P>;
2887
+ context: any;
2888
+ base?: Element | Text;
2889
+ // From https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e836acc75a78cf0655b5dfdbe81d69fdd4d8a252/types/react/index.d.ts#L402
2890
+ // // We MUST keep setState() as a unified signature because it allows proper checking of the method return type.
2891
+ // // See: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18365#issuecomment-351013257
2892
+ setState<K extends keyof S>(
2893
+ state:
2894
+ | ((
2895
+ prevState: Readonly<S>,
2896
+ props: Readonly<P>,
2897
+ ) => Pick<S, K> | Partial<S> | null)
2898
+ | (Pick<S, K> | Partial<S> | null),
2899
+ callback?: () => void,
2900
+ ): void;
2901
+ forceUpdate(callback?: () => void): void;
2902
+ abstract render(
2903
+ props?: RenderableProps<P>,
2904
+ state?: Readonly<S>,
2905
+ context?: any,
2906
+ ): ComponentChildren$1;
2907
+ }
2908
+ //
2909
+ // Context
2910
+ // -----------------------------------
2911
+ export interface Consumer<T>
2912
+ extends FunctionComponent<{
2913
+ children: (value: T) => ComponentChildren$1;
2914
+ }> {}
2915
+ export interface Provider<T>
2916
+ extends FunctionComponent<{
2917
+ value: T;
2918
+ children?: ComponentChildren$1;
2919
+ }> {}
2920
+ export interface Context<T> extends Provider<T> {
2921
+ Consumer: Consumer<T>;
2922
+ Provider: Provider<T>;
2923
+ displayName?: string;
2924
+ }