@shopify/ui-extensions 2024.4.1 → 2024.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (361) hide show
  1. package/build/cjs/surfaces/admin/components/AdminPrintAction/AdminPrintAction.js +12 -0
  2. package/build/cjs/surfaces/admin/components/DatePicker/DatePicker.js +12 -0
  3. package/build/cjs/surfaces/admin/components/InternalCustomerSegmentTemplate/InternalCustomerSegmentTemplate.js +5 -0
  4. package/build/cjs/surfaces/admin.js +2 -0
  5. package/build/cjs/surfaces/checkout/components/DatePicker/DatePicker.js +4 -10
  6. package/build/cjs/surfaces/checkout/components/Progress/Progress.js +9 -0
  7. package/build/cjs/surfaces/checkout/components/Sheet/Sheet.js +16 -0
  8. package/build/cjs/surfaces/checkout/components/Switch/Switch.js +9 -0
  9. package/build/cjs/surfaces/checkout.js +6 -0
  10. package/build/cjs/surfaces/customer-account.js +4 -0
  11. package/build/cjs/surfaces/point-of-sale/components/Actiontem/ActionItem.js +7 -0
  12. package/build/cjs/surfaces/point-of-sale/components/Badge/Badge.js +6 -0
  13. package/build/cjs/surfaces/point-of-sale/components/Banner/Banner.js +9 -0
  14. package/build/cjs/surfaces/point-of-sale/components/Button/Button.js +8 -0
  15. package/build/cjs/surfaces/point-of-sale/components/CameraScanner/CameraScanner.js +6 -0
  16. package/build/cjs/surfaces/point-of-sale/components/DatePicker/DatePicker.js +8 -0
  17. package/build/cjs/surfaces/point-of-sale/components/Dialog/Dialog.js +12 -0
  18. package/build/cjs/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.js +10 -0
  19. package/build/cjs/surfaces/point-of-sale/components/Navigator/Navigator.js +1 -1
  20. package/build/cjs/surfaces/point-of-sale/components/NumberField/NumberField.js +6 -0
  21. package/build/cjs/surfaces/point-of-sale/components/PinPad/PinPad.js +24 -0
  22. package/build/cjs/surfaces/point-of-sale/components/Screen/Screen.js +18 -0
  23. package/build/cjs/surfaces/point-of-sale/components/Section/Section.js +10 -0
  24. package/build/cjs/surfaces/point-of-sale/components/TextArea/TextArea.js +6 -0
  25. package/build/cjs/surfaces/point-of-sale/components/TextField/TextField.js +6 -0
  26. package/build/cjs/surfaces/point-of-sale/components/Tile/Tile.js +9 -0
  27. package/build/cjs/surfaces/point-of-sale/components/TimePicker/TimePicker.js +9 -0
  28. package/build/esm/surfaces/admin/components/AdminPrintAction/AdminPrintAction.mjs +8 -0
  29. package/build/esm/surfaces/admin/components/DatePicker/DatePicker.mjs +12 -0
  30. package/build/esm/surfaces/admin/components/InternalCustomerSegmentTemplate/InternalCustomerSegmentTemplate.mjs +5 -0
  31. package/build/esm/surfaces/admin.mjs +1 -0
  32. package/build/esm/surfaces/checkout/components/DatePicker/DatePicker.mjs +5 -11
  33. package/build/esm/surfaces/checkout/components/Progress/Progress.mjs +5 -0
  34. package/build/esm/surfaces/checkout/components/Sheet/Sheet.mjs +12 -0
  35. package/build/esm/surfaces/checkout/components/Switch/Switch.mjs +5 -0
  36. package/build/esm/surfaces/checkout.mjs +3 -0
  37. package/build/esm/surfaces/customer-account.mjs +2 -0
  38. package/build/esm/surfaces/point-of-sale/components/Actiontem/ActionItem.mjs +7 -0
  39. package/build/esm/surfaces/point-of-sale/components/Badge/Badge.mjs +6 -0
  40. package/build/esm/surfaces/point-of-sale/components/Banner/Banner.mjs +9 -0
  41. package/build/esm/surfaces/point-of-sale/components/Button/Button.mjs +8 -0
  42. package/build/esm/surfaces/point-of-sale/components/CameraScanner/CameraScanner.mjs +6 -0
  43. package/build/esm/surfaces/point-of-sale/components/DatePicker/DatePicker.mjs +8 -0
  44. package/build/esm/surfaces/point-of-sale/components/Dialog/Dialog.mjs +12 -0
  45. package/build/esm/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.mjs +10 -0
  46. package/build/esm/surfaces/point-of-sale/components/Navigator/Navigator.mjs +1 -1
  47. package/build/esm/surfaces/point-of-sale/components/NumberField/NumberField.mjs +6 -0
  48. package/build/esm/surfaces/point-of-sale/components/PinPad/PinPad.mjs +24 -0
  49. package/build/esm/surfaces/point-of-sale/components/Screen/Screen.mjs +18 -0
  50. package/build/esm/surfaces/point-of-sale/components/Section/Section.mjs +10 -0
  51. package/build/esm/surfaces/point-of-sale/components/TextArea/TextArea.mjs +6 -0
  52. package/build/esm/surfaces/point-of-sale/components/TextField/TextField.mjs +6 -0
  53. package/build/esm/surfaces/point-of-sale/components/Tile/Tile.mjs +9 -0
  54. package/build/esm/surfaces/point-of-sale/components/TimePicker/TimePicker.mjs +9 -0
  55. package/build/esnext/surfaces/admin/components/AdminPrintAction/AdminPrintAction.esnext +8 -0
  56. package/build/esnext/surfaces/admin/components/DatePicker/DatePicker.esnext +12 -0
  57. package/build/esnext/surfaces/admin/components/InternalCustomerSegmentTemplate/InternalCustomerSegmentTemplate.esnext +5 -0
  58. package/build/esnext/surfaces/admin.esnext +1 -0
  59. package/build/esnext/surfaces/checkout/components/DatePicker/DatePicker.esnext +5 -11
  60. package/build/esnext/surfaces/checkout/components/Progress/Progress.esnext +5 -0
  61. package/build/esnext/surfaces/checkout/components/Sheet/Sheet.esnext +12 -0
  62. package/build/esnext/surfaces/checkout/components/Switch/Switch.esnext +5 -0
  63. package/build/esnext/surfaces/checkout.esnext +3 -0
  64. package/build/esnext/surfaces/customer-account.esnext +2 -0
  65. package/build/esnext/surfaces/point-of-sale/components/Actiontem/ActionItem.esnext +7 -0
  66. package/build/esnext/surfaces/point-of-sale/components/Badge/Badge.esnext +6 -0
  67. package/build/esnext/surfaces/point-of-sale/components/Banner/Banner.esnext +9 -0
  68. package/build/esnext/surfaces/point-of-sale/components/Button/Button.esnext +8 -0
  69. package/build/esnext/surfaces/point-of-sale/components/CameraScanner/CameraScanner.esnext +6 -0
  70. package/build/esnext/surfaces/point-of-sale/components/DatePicker/DatePicker.esnext +8 -0
  71. package/build/esnext/surfaces/point-of-sale/components/Dialog/Dialog.esnext +12 -0
  72. package/build/esnext/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.esnext +10 -0
  73. package/build/esnext/surfaces/point-of-sale/components/Navigator/Navigator.esnext +1 -1
  74. package/build/esnext/surfaces/point-of-sale/components/NumberField/NumberField.esnext +6 -0
  75. package/build/esnext/surfaces/point-of-sale/components/PinPad/PinPad.esnext +24 -0
  76. package/build/esnext/surfaces/point-of-sale/components/Screen/Screen.esnext +18 -0
  77. package/build/esnext/surfaces/point-of-sale/components/Section/Section.esnext +10 -0
  78. package/build/esnext/surfaces/point-of-sale/components/TextArea/TextArea.esnext +6 -0
  79. package/build/esnext/surfaces/point-of-sale/components/TextField/TextField.esnext +6 -0
  80. package/build/esnext/surfaces/point-of-sale/components/Tile/Tile.esnext +9 -0
  81. package/build/esnext/surfaces/point-of-sale/components/TimePicker/TimePicker.esnext +9 -0
  82. package/build/ts/shared.d.ts +16 -2
  83. package/build/ts/shared.d.ts.map +1 -1
  84. package/build/ts/surfaces/admin/api/block/block.d.ts +5 -0
  85. package/build/ts/surfaces/admin/api/block/block.d.ts.map +1 -1
  86. package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts +1 -1
  87. package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts.map +1 -1
  88. package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts +1 -1
  89. package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts.map +1 -1
  90. package/build/ts/surfaces/admin/api/print-action/print-action.d.ts +10 -0
  91. package/build/ts/surfaces/admin/api/print-action/print-action.d.ts.map +1 -0
  92. package/build/ts/surfaces/admin/api/{extension-targets/extension-targets.doc.d.ts → print-action/print-action.doc.d.ts} +1 -1
  93. package/build/ts/surfaces/admin/api/print-action/print-action.doc.d.ts.map +1 -0
  94. package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts +221 -0
  95. package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts.map +1 -0
  96. package/build/ts/surfaces/admin/api.d.ts +1 -0
  97. package/build/ts/surfaces/admin/api.d.ts.map +1 -1
  98. package/build/ts/surfaces/admin/components/AdminPrintAction/AdminPrintAction.d.ts +16 -0
  99. package/build/ts/surfaces/admin/components/AdminPrintAction/AdminPrintAction.d.ts.map +1 -0
  100. package/build/ts/surfaces/admin/components/AdminPrintAction/AdminPrintAction.doc.d.ts +4 -0
  101. package/build/ts/surfaces/admin/components/AdminPrintAction/AdminPrintAction.doc.d.ts.map +1 -0
  102. package/build/ts/surfaces/admin/components/Image/Image.d.ts +2 -2
  103. package/build/ts/surfaces/admin/components.d.ts +2 -0
  104. package/build/ts/surfaces/admin/components.d.ts.map +1 -1
  105. package/build/ts/surfaces/admin/extension-targets.d.ts +60 -6
  106. package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
  107. package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts +20 -0
  108. package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts.map +1 -0
  109. package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts +51 -0
  110. package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts.map +1 -0
  111. package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts +236 -0
  112. package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts.map +1 -0
  113. package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts +56 -0
  114. package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts.map +1 -0
  115. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +11 -7
  116. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
  117. package/build/ts/surfaces/checkout/api/docs.d.ts +2 -0
  118. package/build/ts/surfaces/checkout/api/docs.d.ts.map +1 -1
  119. package/build/ts/surfaces/checkout/api/order-status/order-status.d.ts +5 -0
  120. package/build/ts/surfaces/checkout/api/order-status/order-status.d.ts.map +1 -1
  121. package/build/ts/surfaces/checkout/api/shared.d.ts +6 -0
  122. package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
  123. package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts +13 -0
  124. package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
  125. package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts +49 -3
  126. package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts.map +1 -1
  127. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +228 -70
  128. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  129. package/build/ts/surfaces/checkout/components/BlockLayout/BlockLayout.doc.d.ts.map +1 -1
  130. package/build/ts/surfaces/checkout/components/BlockStack/BlockStack.d.ts +14 -6
  131. package/build/ts/surfaces/checkout/components/BlockStack/BlockStack.d.ts.map +1 -1
  132. package/build/ts/surfaces/checkout/components/BlockStack/BlockStack.doc.d.ts.map +1 -1
  133. package/build/ts/surfaces/checkout/components/Grid/Grid.d.ts +15 -6
  134. package/build/ts/surfaces/checkout/components/Grid/Grid.d.ts.map +1 -1
  135. package/build/ts/surfaces/checkout/components/Grid/Grid.doc.d.ts.map +1 -1
  136. package/build/ts/surfaces/checkout/components/GridItem/GridItem.d.ts +15 -6
  137. package/build/ts/surfaces/checkout/components/GridItem/GridItem.d.ts.map +1 -1
  138. package/build/ts/surfaces/checkout/components/GridItem/GridItem.doc.d.ts.map +1 -1
  139. package/build/ts/surfaces/checkout/components/Icon/Icon.d.ts +2 -2
  140. package/build/ts/surfaces/checkout/components/Icon/Icon.d.ts.map +1 -1
  141. package/build/ts/surfaces/checkout/components/InlineLayout/InlineLayout.doc.d.ts.map +1 -1
  142. package/build/ts/surfaces/checkout/components/InlineStack/InlineStack.d.ts +15 -6
  143. package/build/ts/surfaces/checkout/components/InlineStack/InlineStack.d.ts.map +1 -1
  144. package/build/ts/surfaces/checkout/components/InlineStack/InlineStack.doc.d.ts.map +1 -1
  145. package/build/ts/surfaces/checkout/components/Link/Link.d.ts +1 -1
  146. package/build/ts/surfaces/checkout/components/Pressable/Pressable.d.ts +12 -11
  147. package/build/ts/surfaces/checkout/components/Pressable/Pressable.d.ts.map +1 -1
  148. package/build/ts/surfaces/checkout/components/Pressable/Pressable.doc.d.ts.map +1 -1
  149. package/build/ts/surfaces/checkout/components/Progress/Progress.d.ts +40 -0
  150. package/build/ts/surfaces/checkout/components/Progress/Progress.d.ts.map +1 -0
  151. package/build/ts/surfaces/checkout/components/Progress/Progress.doc.d.ts +4 -0
  152. package/build/ts/surfaces/checkout/components/Progress/Progress.doc.d.ts.map +1 -0
  153. package/build/ts/surfaces/checkout/components/ScrollView/ScrollView.d.ts +32 -5
  154. package/build/ts/surfaces/checkout/components/ScrollView/ScrollView.d.ts.map +1 -1
  155. package/build/ts/surfaces/checkout/components/ScrollView/ScrollView.doc.d.ts.map +1 -1
  156. package/build/ts/surfaces/checkout/components/Sheet/Sheet.d.ts +55 -0
  157. package/build/ts/surfaces/checkout/components/Sheet/Sheet.d.ts.map +1 -0
  158. package/build/ts/surfaces/checkout/components/Sheet/Sheet.doc.d.ts +4 -0
  159. package/build/ts/surfaces/checkout/components/Sheet/Sheet.doc.d.ts.map +1 -0
  160. package/build/ts/surfaces/checkout/components/Spinner/Spinner.doc.d.ts.map +1 -1
  161. package/build/ts/surfaces/checkout/components/Switch/Switch.d.ts +49 -0
  162. package/build/ts/surfaces/checkout/components/Switch/Switch.d.ts.map +1 -0
  163. package/build/ts/surfaces/checkout/components/Switch/Switch.doc.d.ts +4 -0
  164. package/build/ts/surfaces/checkout/components/Switch/Switch.doc.d.ts.map +1 -0
  165. package/build/ts/surfaces/checkout/components/View/View.d.ts +12 -11
  166. package/build/ts/surfaces/checkout/components/View/View.d.ts.map +1 -1
  167. package/build/ts/surfaces/checkout/components/View/View.doc.d.ts.map +1 -1
  168. package/build/ts/surfaces/checkout/components/shared.d.ts +1 -1
  169. package/build/ts/surfaces/checkout/components/shared.d.ts.map +1 -1
  170. package/build/ts/surfaces/checkout/components.d.ts +7 -1
  171. package/build/ts/surfaces/checkout/components.d.ts.map +1 -1
  172. package/build/ts/surfaces/checkout/helper.docs.d.ts.map +1 -1
  173. package/build/ts/surfaces/checkout/style/style.doc.d.ts.map +1 -1
  174. package/build/ts/surfaces/checkout/style/types.d.ts +10 -3
  175. package/build/ts/surfaces/checkout/style/types.d.ts.map +1 -1
  176. package/build/ts/surfaces/checkout/targets.d.ts +22 -14
  177. package/build/ts/surfaces/checkout/targets.d.ts.map +1 -1
  178. package/build/ts/surfaces/checkout.d.ts +9 -5
  179. package/build/ts/surfaces/checkout.d.ts.map +1 -1
  180. package/build/ts/surfaces/customer-account/components/shared-checkout-components.d.ts +1 -1
  181. package/build/ts/surfaces/customer-account/components/shared-checkout-components.d.ts.map +1 -1
  182. package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts +9 -0
  183. package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts.map +1 -0
  184. package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +1 -1
  185. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +10 -0
  186. package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -0
  187. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +18 -0
  188. package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -0
  189. package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +2 -2
  190. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +10 -0
  191. package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -0
  192. package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +2 -2
  193. package/build/ts/surfaces/point-of-sale/api.d.ts +6 -1
  194. package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
  195. package/build/ts/surfaces/point-of-sale/components/Actiontem/ActionItem.d.ts +12 -0
  196. package/build/ts/surfaces/point-of-sale/components/Actiontem/ActionItem.d.ts.map +1 -1
  197. package/build/ts/surfaces/point-of-sale/components/Badge/Badge.d.ts +14 -0
  198. package/build/ts/surfaces/point-of-sale/components/Badge/Badge.d.ts.map +1 -1
  199. package/build/ts/surfaces/point-of-sale/components/Banner/Banner.d.ts +17 -8
  200. package/build/ts/surfaces/point-of-sale/components/Banner/Banner.d.ts.map +1 -1
  201. package/build/ts/surfaces/point-of-sale/components/Button/Button.d.ts +22 -0
  202. package/build/ts/surfaces/point-of-sale/components/Button/Button.d.ts.map +1 -1
  203. package/build/ts/surfaces/point-of-sale/components/CameraScanner/CameraScanner.d.ts +20 -2
  204. package/build/ts/surfaces/point-of-sale/components/CameraScanner/CameraScanner.d.ts.map +1 -1
  205. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.d.ts +21 -0
  206. package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.d.ts.map +1 -1
  207. package/build/ts/surfaces/point-of-sale/components/Dialog/Dialog.d.ts +38 -0
  208. package/build/ts/surfaces/point-of-sale/components/Dialog/Dialog.d.ts.map +1 -1
  209. package/build/ts/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.d.ts +17 -0
  210. package/build/ts/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.d.ts.map +1 -1
  211. package/build/ts/surfaces/point-of-sale/components/Icon/Icon.d.ts +7 -0
  212. package/build/ts/surfaces/point-of-sale/components/Icon/Icon.d.ts.map +1 -1
  213. package/build/ts/surfaces/point-of-sale/components/Image/Image.d.ts +3 -0
  214. package/build/ts/surfaces/point-of-sale/components/Image/Image.d.ts.map +1 -1
  215. package/build/ts/surfaces/point-of-sale/components/List/List.d.ts +14 -2
  216. package/build/ts/surfaces/point-of-sale/components/List/List.d.ts.map +1 -1
  217. package/build/ts/surfaces/point-of-sale/components/Navigator/Navigator.d.ts +4 -1
  218. package/build/ts/surfaces/point-of-sale/components/Navigator/Navigator.d.ts.map +1 -1
  219. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.d.ts +0 -2
  220. package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.d.ts.map +1 -1
  221. package/build/ts/surfaces/point-of-sale/components/PinPad/PinPad.d.ts +27 -0
  222. package/build/ts/surfaces/point-of-sale/components/PinPad/PinPad.d.ts.map +1 -1
  223. package/build/ts/surfaces/point-of-sale/components/RadioButtonList/RadioButtonList.d.ts +12 -0
  224. package/build/ts/surfaces/point-of-sale/components/RadioButtonList/RadioButtonList.d.ts.map +1 -1
  225. package/build/ts/surfaces/point-of-sale/components/Screen/Screen.d.ts +43 -2
  226. package/build/ts/surfaces/point-of-sale/components/Screen/Screen.d.ts.map +1 -1
  227. package/build/ts/surfaces/point-of-sale/components/SearchBar/SearchBar.d.ts +18 -0
  228. package/build/ts/surfaces/point-of-sale/components/SearchBar/SearchBar.d.ts.map +1 -1
  229. package/build/ts/surfaces/point-of-sale/components/Section/Section.d.ts +20 -0
  230. package/build/ts/surfaces/point-of-sale/components/Section/Section.d.ts.map +1 -1
  231. package/build/ts/surfaces/point-of-sale/components/SegmentedControl/SegmentedControl.d.ts +18 -0
  232. package/build/ts/surfaces/point-of-sale/components/SegmentedControl/SegmentedControl.d.ts.map +1 -1
  233. package/build/ts/surfaces/point-of-sale/components/Selectable/Selectable.d.ts +6 -0
  234. package/build/ts/surfaces/point-of-sale/components/Selectable/Selectable.d.ts.map +1 -1
  235. package/build/ts/surfaces/point-of-sale/components/Stack/Stack.d.ts +27 -1
  236. package/build/ts/surfaces/point-of-sale/components/Stack/Stack.d.ts.map +1 -1
  237. package/build/ts/surfaces/point-of-sale/components/Stepper/Stepper.d.ts +3 -3
  238. package/build/ts/surfaces/point-of-sale/components/Text/Text.d.ts +6 -0
  239. package/build/ts/surfaces/point-of-sale/components/Text/Text.d.ts.map +1 -1
  240. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.d.ts +3 -0
  241. package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.d.ts.map +1 -1
  242. package/build/ts/surfaces/point-of-sale/components/Tile/Tile.d.ts +26 -0
  243. package/build/ts/surfaces/point-of-sale/components/Tile/Tile.d.ts.map +1 -1
  244. package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.d.ts +4 -0
  245. package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.d.ts.map +1 -1
  246. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.d.ts +27 -0
  247. package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.d.ts.map +1 -1
  248. package/build/ts/surfaces/point-of-sale/components/shared/BaseTextField.d.ts +26 -1
  249. package/build/ts/surfaces/point-of-sale/components/shared/BaseTextField.d.ts.map +1 -1
  250. package/build/ts/surfaces/point-of-sale/components/shared/InputField.d.ts +48 -0
  251. package/build/ts/surfaces/point-of-sale/components/shared/InputField.d.ts.map +1 -1
  252. package/build/ts/surfaces/point-of-sale/targets.d.ts +14 -3
  253. package/build/ts/surfaces/point-of-sale/targets.d.ts.map +1 -1
  254. package/build/tsconfig.tsbuildinfo +1 -1
  255. package/package.json +5 -3
  256. package/src/shared.ts +23 -0
  257. package/src/surfaces/admin/api/block/block.ts +6 -0
  258. package/src/surfaces/admin/api/checkout-rules/metafields.ts +1 -1
  259. package/src/surfaces/admin/api/checkout-rules/validation-settings.doc.ts +1 -1
  260. package/src/surfaces/admin/api/order-routing-rule/metafields.ts +1 -1
  261. package/src/surfaces/admin/api/print-action/print-action.doc.ts +20 -0
  262. package/src/surfaces/admin/api/print-action/print-action.ts +12 -0
  263. package/src/surfaces/admin/api/resource-picker/resource-picker.ts +240 -0
  264. package/src/surfaces/admin/api.ts +1 -0
  265. package/src/surfaces/admin/components/AdminPrintAction/AdminPrintAction.doc.ts +52 -0
  266. package/src/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ts +17 -0
  267. package/src/surfaces/admin/components/AdminPrintAction/examples/basic-adminprintaction.example.ts +14 -0
  268. package/src/surfaces/admin/components/Image/Image.ts +2 -2
  269. package/src/surfaces/admin/components.ts +2 -0
  270. package/src/surfaces/admin/extension-targets.ts +100 -5
  271. package/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts +24 -0
  272. package/src/surfaces/checkout/api/address-autocomplete/shared.ts +59 -0
  273. package/src/surfaces/checkout/api/address-autocomplete/standard.ts +289 -0
  274. package/src/surfaces/checkout/api/address-autocomplete/suggest.ts +61 -0
  275. package/src/surfaces/checkout/api/checkout/checkout.ts +16 -7
  276. package/src/surfaces/checkout/api/docs.ts +3 -0
  277. package/src/surfaces/checkout/api/order-status/order-status.ts +5 -0
  278. package/src/surfaces/checkout/api/shared.ts +7 -0
  279. package/src/surfaces/checkout/api/shipping/shipping-option-item.ts +15 -0
  280. package/src/surfaces/checkout/api/shipping/shipping-option-list.ts +58 -3
  281. package/src/surfaces/checkout/api/standard/standard.ts +249 -76
  282. package/src/surfaces/checkout/components/BlockLayout/BlockLayout.doc.ts +8 -1
  283. package/src/surfaces/checkout/components/BlockStack/BlockStack.doc.ts +8 -1
  284. package/src/surfaces/checkout/components/BlockStack/BlockStack.ts +14 -4
  285. package/src/surfaces/checkout/components/Grid/Grid.doc.ts +6 -0
  286. package/src/surfaces/checkout/components/Grid/Grid.ts +15 -4
  287. package/src/surfaces/checkout/components/GridItem/GridItem.doc.ts +6 -0
  288. package/src/surfaces/checkout/components/GridItem/GridItem.ts +15 -4
  289. package/src/surfaces/checkout/components/Icon/Icon.ts +3 -0
  290. package/src/surfaces/checkout/components/InlineLayout/InlineLayout.doc.ts +8 -1
  291. package/src/surfaces/checkout/components/InlineStack/InlineStack.doc.ts +8 -1
  292. package/src/surfaces/checkout/components/InlineStack/InlineStack.ts +15 -4
  293. package/src/surfaces/checkout/components/Link/Link.ts +1 -1
  294. package/src/surfaces/checkout/components/Pressable/Pressable.doc.ts +8 -1
  295. package/src/surfaces/checkout/components/Pressable/Pressable.ts +12 -11
  296. package/src/surfaces/checkout/components/Progress/Progress.doc.ts +89 -0
  297. package/src/surfaces/checkout/components/Progress/Progress.ts +44 -0
  298. package/src/surfaces/checkout/components/Progress/examples/basic-progress.example.ts +9 -0
  299. package/src/surfaces/checkout/components/ScrollView/ScrollView.doc.ts +8 -1
  300. package/src/surfaces/checkout/components/ScrollView/ScrollView.ts +31 -3
  301. package/src/surfaces/checkout/components/Sheet/Sheet.doc.ts +69 -0
  302. package/src/surfaces/checkout/components/Sheet/Sheet.ts +56 -0
  303. package/src/surfaces/checkout/components/Sheet/examples/basic-sheet.example.ts +29 -0
  304. package/src/surfaces/checkout/components/Spinner/Spinner.doc.ts +8 -1
  305. package/src/surfaces/checkout/components/Switch/Switch.doc.ts +80 -0
  306. package/src/surfaces/checkout/components/Switch/Switch.ts +50 -0
  307. package/src/surfaces/checkout/components/Switch/examples/basic-switch.example.ts +9 -0
  308. package/src/surfaces/checkout/components/View/View.doc.ts +8 -1
  309. package/src/surfaces/checkout/components/View/View.ts +12 -11
  310. package/src/surfaces/checkout/components/shared.ts +1 -1
  311. package/src/surfaces/checkout/components.ts +10 -0
  312. package/src/surfaces/checkout/helper.docs.ts +57 -0
  313. package/src/surfaces/checkout/style/examples/hiding.example.tsx +8 -0
  314. package/src/surfaces/checkout/style/style.doc.ts +14 -0
  315. package/src/surfaces/checkout/style/types.ts +10 -3
  316. package/src/surfaces/checkout/targets.ts +31 -14
  317. package/src/surfaces/checkout.ts +37 -4
  318. package/src/surfaces/customer-account/components/shared-checkout-components.ts +4 -0
  319. package/src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts +9 -0
  320. package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +1 -1
  321. package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +10 -0
  322. package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +20 -0
  323. package/src/surfaces/point-of-sale/api/order-api/order-api.tsx +2 -2
  324. package/src/surfaces/point-of-sale/api/product-api/product-api.ts +10 -0
  325. package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +2 -2
  326. package/src/surfaces/point-of-sale/api.ts +19 -1
  327. package/src/surfaces/point-of-sale/components/Actiontem/ActionItem.ts +12 -0
  328. package/src/surfaces/point-of-sale/components/Badge/Badge.ts +16 -0
  329. package/src/surfaces/point-of-sale/components/Banner/Banner.ts +17 -8
  330. package/src/surfaces/point-of-sale/components/Button/Button.ts +22 -0
  331. package/src/surfaces/point-of-sale/components/CameraScanner/CameraScanner.ts +21 -5
  332. package/src/surfaces/point-of-sale/components/DatePicker/DatePicker.ts +22 -0
  333. package/src/surfaces/point-of-sale/components/Dialog/Dialog.ts +46 -0
  334. package/src/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.ts +17 -1
  335. package/src/surfaces/point-of-sale/components/Icon/Icon.ts +7 -0
  336. package/src/surfaces/point-of-sale/components/Image/Image.ts +3 -0
  337. package/src/surfaces/point-of-sale/components/List/List.ts +16 -2
  338. package/src/surfaces/point-of-sale/components/Navigator/Navigator.ts +4 -1
  339. package/src/surfaces/point-of-sale/components/NumberField/NumberField.ts +0 -2
  340. package/src/surfaces/point-of-sale/components/PinPad/PinPad.ts +27 -0
  341. package/src/surfaces/point-of-sale/components/RadioButtonList/RadioButtonList.ts +12 -0
  342. package/src/surfaces/point-of-sale/components/Screen/Screen.ts +43 -2
  343. package/src/surfaces/point-of-sale/components/SearchBar/SearchBar.ts +18 -0
  344. package/src/surfaces/point-of-sale/components/Section/Section.ts +20 -0
  345. package/src/surfaces/point-of-sale/components/SegmentedControl/SegmentedControl.ts +18 -0
  346. package/src/surfaces/point-of-sale/components/Selectable/Selectable.ts +6 -0
  347. package/src/surfaces/point-of-sale/components/Stack/Stack.ts +27 -1
  348. package/src/surfaces/point-of-sale/components/Stepper/Stepper.ts +3 -3
  349. package/src/surfaces/point-of-sale/components/Text/Text.ts +6 -0
  350. package/src/surfaces/point-of-sale/components/TextArea/TextArea.ts +3 -0
  351. package/src/surfaces/point-of-sale/components/Tile/Tile.ts +26 -0
  352. package/src/surfaces/point-of-sale/components/TimeField/TimeField.ts +4 -0
  353. package/src/surfaces/point-of-sale/components/TimePicker/TimePicker.ts +27 -0
  354. package/src/surfaces/point-of-sale/components/shared/BaseTextField.ts +26 -1
  355. package/src/surfaces/point-of-sale/components/shared/InputField.ts +48 -0
  356. package/src/surfaces/point-of-sale/targets.ts +56 -6
  357. package/build/ts/surfaces/admin/api/extension-targets/extension-targets.doc.d.ts.map +0 -1
  358. package/build/ts/surfaces/checkout/api/address-autocomplete/address-autocomplete.d.ts +0 -76
  359. package/build/ts/surfaces/checkout/api/address-autocomplete/address-autocomplete.d.ts.map +0 -1
  360. package/src/surfaces/admin/api/extension-targets/extension-targets.doc.ts +0 -20
  361. package/src/surfaces/checkout/api/address-autocomplete/address-autocomplete.ts +0 -87
@@ -4,6 +4,7 @@ import type {
4
4
  BackgroundProps,
5
5
  BorderProps,
6
6
  CornerProps,
7
+ IdProps,
7
8
  InlineAlignment,
8
9
  SizingProps,
9
10
  Spacing,
@@ -16,6 +17,7 @@ export interface BlockStackProps
16
17
  extends Pick<BackgroundProps, 'background'>,
17
18
  BorderProps,
18
19
  CornerProps,
20
+ IdProps,
19
21
  SizingProps,
20
22
  SpacingProps {
21
23
  /**
@@ -47,10 +49,6 @@ export interface BlockStackProps
47
49
  * provide them with more context.
48
50
  */
49
51
  accessibilityLabel?: string;
50
- /**
51
- * A unique identifier for the component.
52
- */
53
- id?: string;
54
52
  /**
55
53
  * Sets the overflow behavior of the element.
56
54
  *
@@ -63,6 +61,18 @@ export interface BlockStackProps
63
61
  * @default 'visible'
64
62
  */
65
63
  overflow?: 'hidden' | 'visible';
64
+ /**
65
+ * Changes the display of the component.
66
+ *
67
+ * `auto` the component's initial value. The actual value depends on the component and context.
68
+ *
69
+ * `none` hides the component and removes it from the accessibility tree, making it invisible to screen readers.
70
+ *
71
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
72
+ *
73
+ * @defaultValue 'auto'
74
+ */
75
+ display?: MaybeResponsiveConditionalStyle<'auto' | 'none'>;
66
76
  }
67
77
 
68
78
  /**
@@ -51,6 +51,12 @@ const data: ReferenceEntityTemplateSchema = {
51
51
  url: 'grid',
52
52
  type: 'Component',
53
53
  },
54
+ {
55
+ subtitle: 'Utility',
56
+ name: 'StyleHelper',
57
+ url: '/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper',
58
+ type: 'utility',
59
+ },
54
60
  ],
55
61
  };
56
62
 
@@ -7,6 +7,7 @@ import type {
7
7
  BorderProps,
8
8
  Columns,
9
9
  CornerProps,
10
+ IdProps,
10
11
  InlineAlignment,
11
12
  Rows,
12
13
  SizingProps,
@@ -17,6 +18,7 @@ import type {
17
18
 
18
19
  export interface GridProps
19
20
  extends Pick<BackgroundProps, 'background'>,
21
+ IdProps,
20
22
  BorderProps,
21
23
  CornerProps,
22
24
  SizingProps,
@@ -103,10 +105,6 @@ export interface GridProps
103
105
  * provide them with more context.
104
106
  */
105
107
  accessibilityLabel?: string;
106
- /**
107
- * A unique identifier for the component.
108
- */
109
- id?: string;
110
108
  /**
111
109
  * Sets the overflow behavior of the element.
112
110
  *
@@ -119,6 +117,19 @@ export interface GridProps
119
117
  * @default 'visible'
120
118
  */
121
119
  overflow?: 'hidden' | 'visible';
120
+ /**
121
+ * Changes the display of the component.
122
+ *
123
+ *
124
+ * `auto` the component's initial value. The actual value depends on the component and context.
125
+ *
126
+ * `none` hides the component and removes it from the accessibility tree, making it invisible to screen readers.
127
+ *
128
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
129
+ *
130
+ * @defaultValue 'auto'
131
+ */
132
+ display?: MaybeResponsiveConditionalStyle<'auto' | 'none'>;
122
133
  }
123
134
 
124
135
  /**
@@ -51,6 +51,12 @@ const data: ReferenceEntityTemplateSchema = {
51
51
  url: 'grid',
52
52
  type: 'Component',
53
53
  },
54
+ {
55
+ subtitle: 'Utility',
56
+ name: 'StyleHelper',
57
+ url: '/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper',
58
+ type: 'utility',
59
+ },
54
60
  ],
55
61
  };
56
62
 
@@ -5,6 +5,7 @@ import type {
5
5
  BackgroundProps,
6
6
  BorderProps,
7
7
  CornerProps,
8
+ IdProps,
8
9
  SizingProps,
9
10
  SpacingProps,
10
11
  ViewLikeAccessibilityRole,
@@ -14,6 +15,7 @@ export interface GridItemProps
14
15
  extends Pick<BackgroundProps, 'background'>,
15
16
  BorderProps,
16
17
  CornerProps,
18
+ IdProps,
17
19
  SizingProps,
18
20
  SpacingProps {
19
21
  /**
@@ -37,10 +39,6 @@ export interface GridItemProps
37
39
  * - In an HTML host a `listItem` string will render: `<li>`
38
40
  */
39
41
  accessibilityRole?: ViewLikeAccessibilityRole;
40
- /**
41
- * A unique identifier for the component.
42
- */
43
- id?: string;
44
42
  /**
45
43
  * Sets the overflow behavior of the element.
46
44
  *
@@ -53,6 +51,19 @@ export interface GridItemProps
53
51
  * @default 'visible'
54
52
  */
55
53
  overflow?: 'hidden' | 'visible';
54
+ /**
55
+ * Changes the display of the component.
56
+ *
57
+ *
58
+ * `auto` the component's initial value. The actual value depends on the component and context.
59
+ *
60
+ * `none` hides the component and removes it from the accessibility tree, making it invisible to screen readers.
61
+ *
62
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
63
+ *
64
+ * @defaultValue 'auto'
65
+ */
66
+ display?: MaybeResponsiveConditionalStyle<'auto' | 'none'>;
56
67
  }
57
68
 
58
69
  /**
@@ -9,10 +9,12 @@ export type IconSource =
9
9
  | 'arrowUpRight'
10
10
  | 'arrowDown'
11
11
  | 'bag'
12
+ | 'bullet'
12
13
  | 'calendar'
13
14
  | 'camera'
14
15
  | 'caretDown'
15
16
  | 'cart'
17
+ | 'categories'
16
18
  | 'checkmark'
17
19
  | 'chevronLeft'
18
20
  | 'chevronRight'
@@ -59,6 +61,7 @@ export type IconSource =
59
61
  | 'reorder'
60
62
  | 'return'
61
63
  | 'savings'
64
+ | 'settings'
62
65
  | 'star'
63
66
  | 'starFill'
64
67
  | 'starHalf'
@@ -55,7 +55,14 @@ const data: ReferenceEntityTemplateSchema = {
55
55
  '| Value | Description |\n| --- | --- |\n| <code>"main"</code> | Used to indicate the primary content. |\n| <code>"header"</code> | Used to indicate the component is a header. |\n| <code>"footer"</code> | Used to display information such as copyright information, navigation links, and privacy statements. |\n| <code>"section"</code> | Used to indicate a generic section. |\n| <code>"complementary"</code> | Used to designate a supporting section that relates to the main content. |\n| <code>"navigation"</code> | Used to identify major groups of links used for navigating. |\n| <code>"orderedList"</code> | Used to identify a list of ordered items. |\n| <code>"listItem"</code> | Used to identify an item inside a list of items. |\n| <code>"unorderedList"</code> | Used to identify a list of unordered items. |\n| <code>"separator"</code> | Used to indicates the component acts as a divider that separates and distinguishes sections of content. |\n| <code>"status"</code> | Used to define a live region containing advisory information for the user that is not important enough to be an alert. |\n| <code>"alert"</code> | Used for important, and usually time-sensitive, information. |',
56
56
  },
57
57
  ],
58
- related: [],
58
+ related: [
59
+ {
60
+ subtitle: 'Utility',
61
+ name: 'StyleHelper',
62
+ url: '/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper',
63
+ type: 'utility',
64
+ },
65
+ ],
59
66
  };
60
67
 
61
68
  export default data;
@@ -44,7 +44,14 @@ const data: ReferenceEntityTemplateSchema = {
44
44
  '| Value | Description |\n| --- | --- |\n| <code>"main"</code> | Used to indicate the primary content. |\n| <code>"header"</code> | Used to indicate the component is a header. |\n| <code>"footer"</code> | Used to display information such as copyright information, navigation links, and privacy statements. |\n| <code>"section"</code> | Used to indicate a generic section. |\n| <code>"complementary"</code> | Used to designate a supporting section that relates to the main content. |\n| <code>"navigation"</code> | Used to identify major groups of links used for navigating. |\n| <code>"orderedList"</code> | Used to identify a list of ordered items. |\n| <code>"listItem"</code> | Used to identify an item inside a list of items. |\n| <code>"unorderedList"</code> | Used to identify a list of unordered items. |\n| <code>"separator"</code> | Used to indicates the component acts as a divider that separates and distinguishes sections of content. |\n| <code>"status"</code> | Used to define a live region containing advisory information for the user that is not important enough to be an alert. |\n| <code>"alert"</code> | Used for important, and usually time-sensitive, information. |',
45
45
  },
46
46
  ],
47
- related: [],
47
+ related: [
48
+ {
49
+ subtitle: 'Utility',
50
+ name: 'StyleHelper',
51
+ url: '/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper',
52
+ type: 'utility',
53
+ },
54
+ ],
48
55
  };
49
56
 
50
57
  export default data;
@@ -6,6 +6,7 @@ import type {
6
6
  BlockAlignment,
7
7
  BorderProps,
8
8
  CornerProps,
9
+ IdProps,
9
10
  InlineAlignment,
10
11
  SizingProps,
11
12
  Spacing,
@@ -17,6 +18,7 @@ export interface InlineStackProps
17
18
  extends Pick<BackgroundProps, 'background'>,
18
19
  BorderProps,
19
20
  CornerProps,
21
+ IdProps,
20
22
  SizingProps,
21
23
  SpacingProps {
22
24
  /**
@@ -60,10 +62,6 @@ export interface InlineStackProps
60
62
  * @defaultValue 'base'
61
63
  **/
62
64
  spacing?: MaybeResponsiveConditionalStyle<Spacing | [Spacing, Spacing]>;
63
- /**
64
- * A unique identifier for the component.
65
- */
66
- id?: string;
67
65
  /**
68
66
  * Sets the overflow behavior of the element.
69
67
  *
@@ -76,6 +74,19 @@ export interface InlineStackProps
76
74
  * @default 'visible'
77
75
  */
78
76
  overflow?: 'hidden' | 'visible';
77
+ /**
78
+ * Changes the display of the component.
79
+ *
80
+ *
81
+ * `auto` the component's initial value. The actual value depends on the component and context.
82
+ *
83
+ * `none` hides the component and removes it from the accessibility tree, making it invisible to screen readers.
84
+ *
85
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
86
+ *
87
+ * @defaultValue 'auto'
88
+ */
89
+ display?: MaybeResponsiveConditionalStyle<'auto' | 'none'>;
79
90
  }
80
91
 
81
92
  /**
@@ -15,7 +15,7 @@ export interface LinkProps
15
15
  */
16
16
  to?: string;
17
17
  /**
18
- * Open the link in a new window or tab
18
+ * Open the link in a new window or tab. If the link points to a domain other than your Storefront, it will always open in a new tab.
19
19
  */
20
20
  external?: boolean;
21
21
  /**
@@ -35,7 +35,14 @@ const data: ReferenceEntityTemplateSchema = {
35
35
  ],
36
36
  },
37
37
  },
38
- related: [],
38
+ related: [
39
+ {
40
+ subtitle: 'Utility',
41
+ name: 'StyleHelper',
42
+ url: '/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper',
43
+ type: 'utility',
44
+ },
45
+ ],
39
46
  };
40
47
 
41
48
  export default data;
@@ -14,29 +14,35 @@ import type {
14
14
  CornerProps,
15
15
  Opacity,
16
16
  BackgroundProps,
17
+ IdProps,
17
18
  } from '../shared';
18
19
 
19
20
  export interface PressableProps
20
21
  extends Pick<BackgroundProps, 'background'>,
21
22
  BorderProps,
22
23
  CornerProps,
24
+ IdProps,
23
25
  SizingProps,
24
26
  SpacingProps,
25
27
  OverlayActivatorProps,
26
28
  DisclosureActivatorProps {
27
29
  /**
28
- * Changes the display of the Pressable.
30
+ * Changes the display of the component.
29
31
  *
30
32
  *
31
- * `inline` follows the direction of words in a sentence based on the document’s writing mode.
33
+ * `inline` the component starts on the same line as preceding inline content and allows subsequent content to continue on the same line.
32
34
  *
33
- * `block` follows the direction of paragraphs based on the document’s writing mode.
35
+ * `block` the component starts on its own new line and fills its parent.
34
36
  *
37
+ * `auto` resets the component to its initial value. The actual value depends on the component and context.
35
38
  *
36
- * @defaultValue 'block'
39
+ * `none` hides the component and removes it from the accessibility tree, making it invisible to screen readers.
40
+ *
41
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
42
+ *
43
+ * @defaultValue 'auto'
37
44
  */
38
- display?: Display;
39
-
45
+ display?: MaybeResponsiveConditionalStyle<Display>;
40
46
  /**
41
47
  * A label that describes the purpose or contents of the element. When set,
42
48
  * it will be announced to buyers using assistive technologies and will
@@ -60,11 +66,6 @@ export interface PressableProps
60
66
  */
61
67
  disabled?: boolean;
62
68
 
63
- /**
64
- * A unique identifier for the Pressable.
65
- */
66
- id?: string;
67
-
68
69
  /**
69
70
  * Disables the button while loading. Unlike `Button`, no indicator is rendered while loading.
70
71
  */
@@ -0,0 +1,89 @@
1
+ import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2
+
3
+ import {getExample} from '../../helper.docs';
4
+
5
+ const data: ReferenceEntityTemplateSchema = {
6
+ name: 'Progress',
7
+ description: 'Use to visually represent the completion of a task or process.',
8
+ requires: '',
9
+ isVisualComponent: true,
10
+ thumbnail: 'progress-thumbnail.png',
11
+ type: '',
12
+ definitions: [
13
+ {
14
+ title: 'ProgressProps',
15
+ description: '',
16
+ type: 'ProgressProps',
17
+ },
18
+ ],
19
+ category: 'Components',
20
+ subCategory: 'Feedback',
21
+ defaultExample: {
22
+ image: 'progress-indeterminate.gif',
23
+ codeblock: {
24
+ title: 'Indeterminate state',
25
+ tabs: [
26
+ {
27
+ title: 'React',
28
+ code: '../../../../../../ui-extensions-react/src/surfaces/checkout/components/Progress/examples/basic-progress.example.tsx',
29
+ language: 'tsx',
30
+ },
31
+ {
32
+ title: 'JS',
33
+ code: './examples/basic-progress.example.ts',
34
+ language: 'js',
35
+ },
36
+ ],
37
+ },
38
+ },
39
+ subSections: [
40
+ {
41
+ type: 'Generic',
42
+ anchorLink: 'best-practices',
43
+ title: 'Best Practices',
44
+ sectionContent: `
45
+ Use components like [TextBlock](../titles-and-text/textblock) or [Text](../titles-and-text/text), along with the Progress component, to display text indicating the status of the progress bar.
46
+
47
+ ### Loading states
48
+
49
+ For loading states, add text to reassure the user that the progress bar is not frozen.
50
+
51
+ ![A progress bar with "Loading" text](/assets/templated-apis-screenshots/checkout-ui-extensions/unstable/progress-loading.png)
52
+
53
+ ### Error states
54
+
55
+ For error states, add text or a [Banner](./banner) to describe the error and next steps. Use the \`critical\` tone property to convey urgency.
56
+
57
+ ![A progress bar with error text that says "There was a problem with the file upload. Please try again."](/assets/templated-apis-screenshots/checkout-ui-extensions/unstable/progress-error.png)
58
+
59
+ ### Visualize a goal
60
+
61
+ Use the Progress component to visualize a goal that's valuable to the customer.
62
+
63
+ Here's an example of using a progress bar to show a customer's progress toward the next rewards tier:
64
+
65
+ ![A progress bar in customer accounts, showing that the customer is on their way to reaching the Botanical maven rewards tier.](/assets/templated-apis-screenshots/checkout-ui-extensions/unstable/progress-goal.png)
66
+
67
+ Here's an example of using a progress bar to show how much more a customer needs to spend to get free shipping:
68
+
69
+ ![A progress bar at checkout, showing that the customer is $43 away from free shipping.](/assets/templated-apis-screenshots/checkout-ui-extensions/unstable/progress-free-shipping.png)
70
+ `,
71
+ },
72
+ ],
73
+ examples: {
74
+ description: '',
75
+ examples: [
76
+ getExample('ui-components/progress-determinate-state', ['jsx', 'js']),
77
+ ],
78
+ },
79
+ related: [
80
+ {
81
+ name: 'Spinner',
82
+ subtitle: 'Component',
83
+ url: 'spinner',
84
+ type: 'Component',
85
+ },
86
+ ],
87
+ };
88
+
89
+ export default data;
@@ -0,0 +1,44 @@
1
+ import {createRemoteComponent} from '@remote-ui/core';
2
+
3
+ import type {IdProps} from '../shared';
4
+
5
+ type Tone = 'auto' | 'critical';
6
+
7
+ export interface ProgressProps extends IdProps {
8
+ /**
9
+ * Specify how much of the task that has been completed.
10
+ * It must be a valid floating point number between 0 and max, or between 0 and 1 if max is omitted.
11
+ * When undefined, the progress bar is indeterminate;
12
+ * this indicates that an activity is ongoing with no indication of how long it is expected to take.
13
+ *
14
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value
15
+ */
16
+ value?: number;
17
+
18
+ /**
19
+ * Define the maximum limit of the progress element.
20
+ * It must have a value greater than 0 and be a valid floating point number.
21
+ *
22
+ * @defaultValue 1
23
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max
24
+ */
25
+ max?: number;
26
+
27
+ /**
28
+ * Set the color of the progress bar.
29
+ *
30
+ * @defaultValue 'auto'
31
+ */
32
+ tone?: Tone;
33
+
34
+ /**
35
+ * A label to use for the Progress that will be used for buyers using assistive technologies like screen readers.
36
+ * It will also be used to replace the animated loading indicator when buyers prefer reduced motion.
37
+ *
38
+ */
39
+ accessibilityLabel?: string;
40
+ }
41
+
42
+ export const Progress = createRemoteComponent<'Progress', ProgressProps>(
43
+ 'Progress',
44
+ );
@@ -0,0 +1,9 @@
1
+ import {extension, Progress} from '@shopify/ui-extensions/checkout';
2
+
3
+ export default extension('purchase.checkout.block.render', (root) => {
4
+ const baseProgress = root.createComponent(Progress, {
5
+ accessibilityLabel: 'Loading',
6
+ });
7
+
8
+ root.appendChild(baseProgress);
9
+ });
@@ -35,7 +35,14 @@ const data: ReferenceEntityTemplateSchema = {
35
35
  ],
36
36
  },
37
37
  },
38
- related: [],
38
+ related: [
39
+ {
40
+ subtitle: 'Utility',
41
+ name: 'StyleHelper',
42
+ url: '/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper',
43
+ type: 'utility',
44
+ },
45
+ ],
39
46
  };
40
47
 
41
48
  export default data;
@@ -4,9 +4,11 @@ import type {
4
4
  BackgroundProps,
5
5
  BorderProps,
6
6
  CornerProps,
7
+ IdProps,
7
8
  SizingProps,
8
9
  SpacingProps,
9
10
  } from '../shared';
11
+ import type {MaybeResponsiveConditionalStyle} from '../../style/types';
10
12
 
11
13
  export interface ScrollViewEvent {
12
14
  /**
@@ -33,6 +35,7 @@ export interface ScrollViewProps
33
35
  extends Pick<BackgroundProps, 'background'>,
34
36
  BorderProps,
35
37
  CornerProps,
38
+ IdProps,
36
39
  SizingProps,
37
40
  SpacingProps {
38
41
  /**
@@ -56,7 +59,23 @@ export interface ScrollViewProps
56
59
  */
57
60
  direction?: 'block' | 'inline';
58
61
  /**
59
- * Scroll to a specific position or to an element.
62
+ * Scroll to a specific position or to an element when the component is first rendered.
63
+ *
64
+ * This property allows you to set an initial scroll position or scroll to a specific element
65
+ * when the `ScrollView` component mounts. Note that this action will only be performed once,
66
+ * during the initial render of the component.
67
+ *
68
+ * @example
69
+ * // Scroll to 100 pixels from the top on initial render
70
+ * <ScrollView scrollTo={100} />
71
+ *
72
+ * // Scroll to a specific element on initial render
73
+ * const elementRef = useRef(null);
74
+ * <ScrollView scrollTo={elementRef.current} />
75
+ *
76
+ * @note
77
+ * This property will only take effect on the first render. Subsequent updates to this property
78
+ * will not trigger additional scroll actions.
60
79
  */
61
80
  scrollTo?: number | HTMLElement;
62
81
  /**
@@ -74,9 +93,18 @@ export interface ScrollViewProps
74
93
  */
75
94
  onScrolledToEdge?: (args: ScrollViewEvent) => void;
76
95
  /**
77
- * A unique identifier for the component.
96
+ * Changes the display of the component.
97
+ *
98
+ *
99
+ * `auto` the component's initial value. The actual value depends on the component and context.
100
+ *
101
+ * `none` hides the component and removes it from the accessibility tree, making it invisible to screen readers.
102
+ *
103
+ * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
104
+ *
105
+ * @defaultValue 'auto'
78
106
  */
79
- id?: string;
107
+ display?: MaybeResponsiveConditionalStyle<'auto' | 'none'>;
80
108
  }
81
109
 
82
110
  /**
@@ -0,0 +1,69 @@
1
+ import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2
+
3
+ import {getExample} from '../../helper.docs';
4
+
5
+ const data: ReferenceEntityTemplateSchema = {
6
+ name: 'Sheet',
7
+ description:
8
+ 'The Sheet component displays essential information for customers at the bottom of the screen, appearing above other elements. Use it sparingly to avoid distracting customers during checkout. This component requires access to [Customer Privacy API](/docs/api/checkout-ui-extensions/unstable/configuration#collect-buyer-consent) to be rendered. \n\nThe library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.',
9
+ requires:
10
+ 'configuration of the [Customer Privacy](/docs/api/checkout-ui-extensions/unstable/configuration#collect-buyer-consent) capability to be rendered.',
11
+ thumbnail: 'sheet-thumbnail.png',
12
+ isVisualComponent: true,
13
+ type: '',
14
+ definitions: [
15
+ {
16
+ title: 'SheetProps',
17
+ description: '',
18
+ type: 'SheetProps',
19
+ },
20
+ ],
21
+ category: 'Components',
22
+ subCategory: 'Overlays',
23
+ defaultExample: {
24
+ image: 'sheet-default.png',
25
+ codeblock: {
26
+ title: 'Basic Sheet',
27
+ tabs: [
28
+ {
29
+ title: 'React',
30
+ code: '../../../../../../ui-extensions-react/src/surfaces/checkout/components/Sheet/examples/basic-sheet.example.tsx',
31
+ language: 'tsx',
32
+ },
33
+ {
34
+ title: 'JS',
35
+ code: './examples/basic-sheet.example.ts',
36
+ language: 'js',
37
+ },
38
+ ],
39
+ },
40
+ },
41
+ subSections: [
42
+ {
43
+ type: 'Generic',
44
+ anchorLink: 'shopify-controlled-surfaces',
45
+ title: 'Shopify-controlled surfaces',
46
+ sectionContent:
47
+ 'To prevent disruptions during checkout, we maintain strict design control over key areas of the Sheet component. These Shopify-controlled elements include: \n\n<h3>Locations of elements</h3>\n\nThe Sheet elements (header, content, action buttons, and dismiss button) are strategically positioned and sized to present vital information upfront.\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces1.png" />\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces2.png" />\n\n<br>\n\n<h3>Padding and spacing</h3>\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces3.png" />\n\n<br>\n\n<h3>Maximum height</h3>\n\nTo balance customer attention and task completion, a maximum height is set for the Sheet component.\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces4.png" />\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces5.png" />\n\nWhen content pushes the sheet to exceed this limit, the following UI behaviors are triggered:\n\n<br>\n\n<h3>Heading and content are scrollable</h3>\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces6.png" />\n\n<br>\n\n<h3>Expand pill appears to allow customers to view the entire content</h3>\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces7.png" />\n\n<br>\n\n<h3>Actions slot and dismiss button remain fixed</h3>\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-controlled-surfaces8.png" />',
48
+ },
49
+ {
50
+ type: 'Generic',
51
+ anchorLink: 'privacy-consent-requirements',
52
+ title: 'Privacy consent requirements',
53
+ sectionContent:
54
+ '<h3>Content</h3>\n\nFor the best customer experience, ensure content is brief and to the point.\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations1.png" />\n\nVarious strategies can be employed to avoid content scrolling.\n\n<br>\n\n<h4>Use short content</h4>\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations2.png" />\n\n<br>\n\n<h4>Use small text size</h4>\n\n <img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations3.png" />\n\n<br>\n\n<h4>Remove the header</h4>\n\n <img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations4.png" />\n\n<br>\n\n<h3>Actions slot</h3>\n\nThe actions slots allows customers to make decisions and is split into primary and secondary sections.\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations5.png" />\n\n<br>\n\n<h3>Primary section</h3>\n\n Contains primary actions for customer decisions on the sheet’s prompt. Up to two buttons are allowed. Keep the button’s content brief so that it doesn’t wrap to more than one line.\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations6.png" />\n\n<br>\n\n<h3>Secondary section</h3>\n\nContains action that is unrelated to the sheet’s prompt. Only one button is allowed. A modal can be activated when engaging with the secondary action. Keep the button’s content brief so that it doesn’t wrap to more than one line.\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations7.png" />\n\n<br>\n\n<h3>Consent, denial of consent, and sheet dismissal</h3>\n\n <h4>Consent</h4>\n\nWhen a customer expresses consent by pressing the acceptance button, cookies will load and the sheet should not re-appear on refresh.\n\n<br>\n\n<h4>Denial of consent</h4>\n\nWhen a customer expresses denial of consent by pressing the rejection button, cookies will not load and the sheet will not re-appear on refresh.\n\n<br>\n\n<h4>Sheet dismissal</h4>\n\nWhen a customer neither grants nor denies consent by pressing the dismiss button, cookies will not load and the sheet will re-appear on refresh.\n\n<img src="/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/sheet-content-recommendations8.png" />',
55
+ },
56
+ ],
57
+ examples: {
58
+ description: '',
59
+ examples: [
60
+ getExample('ui-components/sheet-consent', ['jsx', 'js']),
61
+ getExample('ui-components/sheet-description-preferences', ['jsx', 'js']),
62
+ getExample('ui-components/sheet-icon-button-preferences', ['jsx', 'js']),
63
+ getExample('ui-components/sheet-layout-content', ['jsx', 'js']),
64
+ ],
65
+ },
66
+ related: [],
67
+ };
68
+
69
+ export default data;