@shopify/ui-extensions 2025.7.1 → 2025.7.3

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 (343) hide show
  1. package/build/cjs/surfaces/point-of-sale/render/components/Badge/Badge.js +0 -7
  2. package/build/cjs/surfaces/point-of-sale/render/components/Banner/Banner.js +0 -9
  3. package/build/cjs/surfaces/point-of-sale/render/components/Button/Button.js +0 -8
  4. package/build/cjs/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.js +0 -6
  5. package/build/cjs/surfaces/point-of-sale/render/components/DatePicker/DatePicker.js +0 -8
  6. package/build/cjs/surfaces/point-of-sale/render/components/Dialog/Dialog.js +0 -12
  7. package/build/cjs/surfaces/point-of-sale/render/components/Image/Image.js +7 -2
  8. package/build/cjs/surfaces/point-of-sale/render/components/Navigator/Navigator.js +0 -4
  9. package/build/cjs/surfaces/point-of-sale/render/components/NumberField/NumberField.js +0 -6
  10. package/build/cjs/surfaces/point-of-sale/render/components/POSBlock/POSBlock.js +0 -6
  11. package/build/cjs/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.js +0 -4
  12. package/build/cjs/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.js +0 -5
  13. package/build/cjs/surfaces/point-of-sale/render/components/PinPad/PinPad.js +16 -20
  14. package/build/cjs/surfaces/point-of-sale/render/components/QRCode/QRCode.js +0 -5
  15. package/build/cjs/surfaces/point-of-sale/render/components/Screen/Screen.js +0 -22
  16. package/build/cjs/surfaces/point-of-sale/render/components/Section/Section.js +2 -8
  17. package/build/cjs/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.js +4 -0
  18. package/build/cjs/surfaces/point-of-sale/render/components/Stack/Stack.js +4 -0
  19. package/build/cjs/surfaces/point-of-sale/render/components/Text/Text.js +28 -0
  20. package/build/cjs/surfaces/point-of-sale/render/components/TextArea/TextArea.js +0 -6
  21. package/build/cjs/surfaces/point-of-sale/render/components/Tile/Tile.js +0 -10
  22. package/build/cjs/surfaces/point-of-sale/render/components/TimePicker/TimePicker.js +0 -9
  23. package/build/cjs/surfaces/point-of-sale/types/storage.js +3 -0
  24. package/build/esm/surfaces/point-of-sale/render/components/Badge/Badge.mjs +0 -7
  25. package/build/esm/surfaces/point-of-sale/render/components/Banner/Banner.mjs +0 -9
  26. package/build/esm/surfaces/point-of-sale/render/components/Button/Button.mjs +0 -8
  27. package/build/esm/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.mjs +0 -6
  28. package/build/esm/surfaces/point-of-sale/render/components/DatePicker/DatePicker.mjs +0 -8
  29. package/build/esm/surfaces/point-of-sale/render/components/Dialog/Dialog.mjs +0 -12
  30. package/build/esm/surfaces/point-of-sale/render/components/Image/Image.mjs +7 -2
  31. package/build/esm/surfaces/point-of-sale/render/components/Navigator/Navigator.mjs +0 -4
  32. package/build/esm/surfaces/point-of-sale/render/components/NumberField/NumberField.mjs +0 -6
  33. package/build/esm/surfaces/point-of-sale/render/components/POSBlock/POSBlock.mjs +0 -6
  34. package/build/esm/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.mjs +0 -4
  35. package/build/esm/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.mjs +0 -5
  36. package/build/esm/surfaces/point-of-sale/render/components/PinPad/PinPad.mjs +16 -20
  37. package/build/esm/surfaces/point-of-sale/render/components/QRCode/QRCode.mjs +0 -5
  38. package/build/esm/surfaces/point-of-sale/render/components/Screen/Screen.mjs +0 -22
  39. package/build/esm/surfaces/point-of-sale/render/components/Section/Section.mjs +2 -8
  40. package/build/esm/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.mjs +4 -0
  41. package/build/esm/surfaces/point-of-sale/render/components/Stack/Stack.mjs +4 -0
  42. package/build/esm/surfaces/point-of-sale/render/components/Text/Text.mjs +28 -0
  43. package/build/esm/surfaces/point-of-sale/render/components/TextArea/TextArea.mjs +0 -6
  44. package/build/esm/surfaces/point-of-sale/render/components/Tile/Tile.mjs +0 -10
  45. package/build/esm/surfaces/point-of-sale/render/components/TimePicker/TimePicker.mjs +0 -9
  46. package/build/esm/surfaces/point-of-sale/types/storage.mjs +3 -0
  47. package/build/esnext/surfaces/point-of-sale/render/components/Badge/Badge.esnext +0 -7
  48. package/build/esnext/surfaces/point-of-sale/render/components/Banner/Banner.esnext +0 -9
  49. package/build/esnext/surfaces/point-of-sale/render/components/Button/Button.esnext +0 -8
  50. package/build/esnext/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.esnext +0 -6
  51. package/build/esnext/surfaces/point-of-sale/render/components/DatePicker/DatePicker.esnext +0 -8
  52. package/build/esnext/surfaces/point-of-sale/render/components/Dialog/Dialog.esnext +0 -12
  53. package/build/esnext/surfaces/point-of-sale/render/components/Image/Image.esnext +7 -2
  54. package/build/esnext/surfaces/point-of-sale/render/components/Navigator/Navigator.esnext +0 -4
  55. package/build/esnext/surfaces/point-of-sale/render/components/NumberField/NumberField.esnext +0 -6
  56. package/build/esnext/surfaces/point-of-sale/render/components/POSBlock/POSBlock.esnext +0 -6
  57. package/build/esnext/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.esnext +0 -4
  58. package/build/esnext/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.esnext +0 -5
  59. package/build/esnext/surfaces/point-of-sale/render/components/PinPad/PinPad.esnext +16 -20
  60. package/build/esnext/surfaces/point-of-sale/render/components/QRCode/QRCode.esnext +0 -5
  61. package/build/esnext/surfaces/point-of-sale/render/components/Screen/Screen.esnext +0 -22
  62. package/build/esnext/surfaces/point-of-sale/render/components/Section/Section.esnext +2 -8
  63. package/build/esnext/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.esnext +4 -0
  64. package/build/esnext/surfaces/point-of-sale/render/components/Stack/Stack.esnext +4 -0
  65. package/build/esnext/surfaces/point-of-sale/render/components/Text/Text.esnext +28 -0
  66. package/build/esnext/surfaces/point-of-sale/render/components/TextArea/TextArea.esnext +0 -6
  67. package/build/esnext/surfaces/point-of-sale/render/components/Tile/Tile.esnext +0 -10
  68. package/build/esnext/surfaces/point-of-sale/render/components/TimePicker/TimePicker.esnext +0 -9
  69. package/build/esnext/surfaces/point-of-sale/types/storage.esnext +3 -0
  70. package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts +20 -6
  71. package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts.map +1 -1
  72. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +2 -2
  73. package/build/ts/surfaces/checkout/targets.d.ts +2 -2
  74. package/build/ts/surfaces/checkout/targets.d.ts.map +1 -1
  75. package/build/ts/surfaces/checkout.d.ts +1 -1
  76. package/build/ts/surfaces/checkout.d.ts.map +1 -1
  77. package/build/ts/surfaces/customer-account/api/announcement/announcement.d.ts +20 -6
  78. package/build/ts/surfaces/customer-account/api/announcement/announcement.d.ts.map +1 -1
  79. package/build/ts/surfaces/customer-account/api/docs.d.ts +2 -0
  80. package/build/ts/surfaces/customer-account/api/docs.d.ts.map +1 -1
  81. package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts +2 -0
  82. package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
  83. package/build/ts/surfaces/customer-account/api.d.ts +1 -0
  84. package/build/ts/surfaces/customer-account/api.d.ts.map +1 -1
  85. package/build/ts/surfaces/customer-account/targets.d.ts +4 -4
  86. package/build/ts/surfaces/customer-account/targets.d.ts.map +1 -1
  87. package/build/ts/surfaces/point-of-sale/api.d.ts +1 -1
  88. package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
  89. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +3 -0
  90. package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
  91. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +15 -0
  92. package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
  93. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +6 -0
  94. package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
  95. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +27 -0
  96. package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
  97. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +19 -0
  98. package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
  99. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +9 -0
  100. package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
  101. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +19 -0
  102. package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
  103. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +12 -0
  104. package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
  105. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +27 -0
  106. package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
  107. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +14 -0
  108. package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
  109. package/build/ts/surfaces/point-of-sale/render/api/action-api/action-api.d.ts +3 -5
  110. package/build/ts/surfaces/point-of-sale/render/api/action-api/action-api.d.ts.map +1 -1
  111. package/build/ts/surfaces/point-of-sale/render/api/cart-api/cart-api.d.ts +37 -31
  112. package/build/ts/surfaces/point-of-sale/render/api/cart-api/cart-api.d.ts.map +1 -1
  113. package/build/ts/surfaces/point-of-sale/render/api/cart-line-item-api/cart-line-item-api.d.ts +2 -2
  114. package/build/ts/surfaces/point-of-sale/render/api/connectivity-api/connectivity-api.d.ts +6 -4
  115. package/build/ts/surfaces/point-of-sale/render/api/connectivity-api/connectivity-api.d.ts.map +1 -1
  116. package/build/ts/surfaces/point-of-sale/render/api/customer-api/customer-api.d.ts +4 -1
  117. package/build/ts/surfaces/point-of-sale/render/api/customer-api/customer-api.d.ts.map +1 -1
  118. package/build/ts/surfaces/point-of-sale/render/api/device-api/device-api.d.ts +4 -4
  119. package/build/ts/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.d.ts +6 -3
  120. package/build/ts/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.d.ts.map +1 -1
  121. package/build/ts/surfaces/point-of-sale/render/api/locale-api/locale-api.d.ts +3 -4
  122. package/build/ts/surfaces/point-of-sale/render/api/locale-api/locale-api.d.ts.map +1 -1
  123. package/build/ts/surfaces/point-of-sale/render/api/navigation-api/navigation-api.d.ts +9 -7
  124. package/build/ts/surfaces/point-of-sale/render/api/navigation-api/navigation-api.d.ts.map +1 -1
  125. package/build/ts/surfaces/point-of-sale/render/api/order-api/order-api.d.ts +5 -5
  126. package/build/ts/surfaces/point-of-sale/render/api/print-api/print-api.d.ts +7 -12
  127. package/build/ts/surfaces/point-of-sale/render/api/print-api/print-api.d.ts.map +1 -1
  128. package/build/ts/surfaces/point-of-sale/render/api/product-api/product-api.d.ts +5 -2
  129. package/build/ts/surfaces/point-of-sale/render/api/product-api/product-api.d.ts.map +1 -1
  130. package/build/ts/surfaces/point-of-sale/render/api/product-search-api/product-search-api.d.ts +24 -10
  131. package/build/ts/surfaces/point-of-sale/render/api/product-search-api/product-search-api.d.ts.map +1 -1
  132. package/build/ts/surfaces/point-of-sale/render/api/scanner-api/scanner-api.d.ts +22 -10
  133. package/build/ts/surfaces/point-of-sale/render/api/scanner-api/scanner-api.d.ts.map +1 -1
  134. package/build/ts/surfaces/point-of-sale/render/api/session-api/session-api.d.ts +3 -6
  135. package/build/ts/surfaces/point-of-sale/render/api/session-api/session-api.d.ts.map +1 -1
  136. package/build/ts/surfaces/point-of-sale/render/api/storage-api/storage-api.d.ts +7 -0
  137. package/build/ts/surfaces/point-of-sale/render/api/storage-api/storage-api.d.ts.map +1 -1
  138. package/build/ts/surfaces/point-of-sale/render/api/toast-api/toast-api.d.ts +11 -1
  139. package/build/ts/surfaces/point-of-sale/render/api/toast-api/toast-api.d.ts.map +1 -1
  140. package/build/ts/surfaces/point-of-sale/render/components/Badge/Badge.d.ts +12 -9
  141. package/build/ts/surfaces/point-of-sale/render/components/Badge/Badge.d.ts.map +1 -1
  142. package/build/ts/surfaces/point-of-sale/render/components/Banner/Banner.d.ts +13 -14
  143. package/build/ts/surfaces/point-of-sale/render/components/Banner/Banner.d.ts.map +1 -1
  144. package/build/ts/surfaces/point-of-sale/render/components/Button/Button.d.ts +9 -15
  145. package/build/ts/surfaces/point-of-sale/render/components/Button/Button.d.ts.map +1 -1
  146. package/build/ts/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.d.ts +6 -8
  147. package/build/ts/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.d.ts.map +1 -1
  148. package/build/ts/surfaces/point-of-sale/render/components/DatePicker/DatePicker.d.ts +8 -11
  149. package/build/ts/surfaces/point-of-sale/render/components/DatePicker/DatePicker.d.ts.map +1 -1
  150. package/build/ts/surfaces/point-of-sale/render/components/Dialog/Dialog.d.ts +13 -20
  151. package/build/ts/surfaces/point-of-sale/render/components/Dialog/Dialog.d.ts.map +1 -1
  152. package/build/ts/surfaces/point-of-sale/render/components/Icon/Icon.d.ts +10 -8
  153. package/build/ts/surfaces/point-of-sale/render/components/Icon/Icon.d.ts.map +1 -1
  154. package/build/ts/surfaces/point-of-sale/render/components/Image/Image.d.ts +10 -5
  155. package/build/ts/surfaces/point-of-sale/render/components/Image/Image.d.ts.map +1 -1
  156. package/build/ts/surfaces/point-of-sale/render/components/List/List.d.ts +30 -25
  157. package/build/ts/surfaces/point-of-sale/render/components/List/List.d.ts.map +1 -1
  158. package/build/ts/surfaces/point-of-sale/render/components/Navigator/Navigator.d.ts +1 -4
  159. package/build/ts/surfaces/point-of-sale/render/components/Navigator/Navigator.d.ts.map +1 -1
  160. package/build/ts/surfaces/point-of-sale/render/components/NumberField/NumberField.d.ts +7 -7
  161. package/build/ts/surfaces/point-of-sale/render/components/NumberField/NumberField.d.ts.map +1 -1
  162. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlock.d.ts +8 -10
  163. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlock.d.ts.map +1 -1
  164. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.d.ts +1 -4
  165. package/build/ts/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.d.ts.map +1 -1
  166. package/build/ts/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.d.ts +0 -4
  167. package/build/ts/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.d.ts.map +1 -1
  168. package/build/ts/surfaces/point-of-sale/render/components/PinPad/PinPad.d.ts +25 -28
  169. package/build/ts/surfaces/point-of-sale/render/components/PinPad/PinPad.d.ts.map +1 -1
  170. package/build/ts/surfaces/point-of-sale/render/components/PrintPreview/PrintPreview.d.ts +1 -11
  171. package/build/ts/surfaces/point-of-sale/render/components/PrintPreview/PrintPreview.d.ts.map +1 -1
  172. package/build/ts/surfaces/point-of-sale/render/components/QRCode/QRCode.d.ts +1 -5
  173. package/build/ts/surfaces/point-of-sale/render/components/QRCode/QRCode.d.ts.map +1 -1
  174. package/build/ts/surfaces/point-of-sale/render/components/RadioButtonList/RadioButtonList.d.ts +7 -5
  175. package/build/ts/surfaces/point-of-sale/render/components/RadioButtonList/RadioButtonList.d.ts.map +1 -1
  176. package/build/ts/surfaces/point-of-sale/render/components/Screen/Screen.d.ts +13 -33
  177. package/build/ts/surfaces/point-of-sale/render/components/Screen/Screen.d.ts.map +1 -1
  178. package/build/ts/surfaces/point-of-sale/render/components/SearchBar/SearchBar.d.ts +7 -7
  179. package/build/ts/surfaces/point-of-sale/render/components/Section/Section.d.ts +6 -11
  180. package/build/ts/surfaces/point-of-sale/render/components/Section/Section.d.ts.map +1 -1
  181. package/build/ts/surfaces/point-of-sale/render/components/SectionHeader/SectionHeader.d.ts +9 -7
  182. package/build/ts/surfaces/point-of-sale/render/components/SectionHeader/SectionHeader.d.ts.map +1 -1
  183. package/build/ts/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.d.ts +9 -6
  184. package/build/ts/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.d.ts.map +1 -1
  185. package/build/ts/surfaces/point-of-sale/render/components/Selectable/Selectable.d.ts +2 -2
  186. package/build/ts/surfaces/point-of-sale/render/components/Stack/Stack.d.ts +22 -22
  187. package/build/ts/surfaces/point-of-sale/render/components/Stack/Stack.d.ts.map +1 -1
  188. package/build/ts/surfaces/point-of-sale/render/components/Stepper/Stepper.d.ts +8 -6
  189. package/build/ts/surfaces/point-of-sale/render/components/Stepper/Stepper.d.ts.map +1 -1
  190. package/build/ts/surfaces/point-of-sale/render/components/Text/Text.d.ts +28 -2
  191. package/build/ts/surfaces/point-of-sale/render/components/Text/Text.d.ts.map +1 -1
  192. package/build/ts/surfaces/point-of-sale/render/components/TextArea/TextArea.d.ts +1 -6
  193. package/build/ts/surfaces/point-of-sale/render/components/TextArea/TextArea.d.ts.map +1 -1
  194. package/build/ts/surfaces/point-of-sale/render/components/TextField/TextField.d.ts +30 -0
  195. package/build/ts/surfaces/point-of-sale/render/components/TextField/TextField.d.ts.map +1 -1
  196. package/build/ts/surfaces/point-of-sale/render/components/Tile/Tile.d.ts +6 -15
  197. package/build/ts/surfaces/point-of-sale/render/components/Tile/Tile.d.ts.map +1 -1
  198. package/build/ts/surfaces/point-of-sale/render/components/TimeField/TimeField.d.ts +2 -1
  199. package/build/ts/surfaces/point-of-sale/render/components/TimeField/TimeField.d.ts.map +1 -1
  200. package/build/ts/surfaces/point-of-sale/render/components/TimePicker/TimePicker.d.ts +10 -14
  201. package/build/ts/surfaces/point-of-sale/render/components/TimePicker/TimePicker.d.ts.map +1 -1
  202. package/build/ts/surfaces/point-of-sale/render/components/shared/BaseTextField.d.ts +6 -14
  203. package/build/ts/surfaces/point-of-sale/render/components/shared/BaseTextField.d.ts.map +1 -1
  204. package/build/ts/surfaces/point-of-sale/render/components/shared/InputField.d.ts +16 -37
  205. package/build/ts/surfaces/point-of-sale/render/components/shared/InputField.d.ts.map +1 -1
  206. package/build/ts/surfaces/point-of-sale/render/components/shared/box.d.ts +31 -42
  207. package/build/ts/surfaces/point-of-sale/render/components/shared/box.d.ts.map +1 -1
  208. package/build/ts/surfaces/point-of-sale/render/components/shared/deprecated-types.d.ts +12 -0
  209. package/build/ts/surfaces/point-of-sale/render/components/shared/deprecated-types.d.ts.map +1 -1
  210. package/build/ts/surfaces/point-of-sale/render/components/shared/inner-layouts.d.ts +13 -7
  211. package/build/ts/surfaces/point-of-sale/render/components/shared/inner-layouts.d.ts.map +1 -1
  212. package/build/ts/surfaces/point-of-sale/render/components/shared/sizes.d.ts +3 -1
  213. package/build/ts/surfaces/point-of-sale/render/components/shared/sizes.d.ts.map +1 -1
  214. package/build/ts/surfaces/point-of-sale/targets.d.ts +138 -0
  215. package/build/ts/surfaces/point-of-sale/targets.d.ts.map +1 -1
  216. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +39 -0
  217. package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
  218. package/build/ts/surfaces/point-of-sale/types/cart.d.ts +281 -10
  219. package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
  220. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +3 -0
  221. package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
  222. package/build/ts/surfaces/point-of-sale/types/device.d.ts +6 -3
  223. package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
  224. package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +3 -3
  225. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +11 -0
  226. package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -0
  227. package/build/ts/surfaces/point-of-sale/types/money.d.ts +22 -0
  228. package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
  229. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -2
  230. package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
  231. package/build/ts/surfaces/point-of-sale/types/order.d.ts +18 -0
  232. package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
  233. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +2 -3
  234. package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
  235. package/build/ts/surfaces/point-of-sale/types/payment.d.ts +15 -0
  236. package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
  237. package/build/ts/surfaces/point-of-sale/types/product.d.ts +172 -0
  238. package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
  239. package/build/ts/surfaces/point-of-sale/types/session.d.ts +7 -5
  240. package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
  241. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +32 -0
  242. package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
  243. package/build/ts/surfaces/point-of-sale/types/storage.d.ts +13 -11
  244. package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
  245. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +21 -0
  246. package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
  247. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +7 -0
  248. package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
  249. package/build/tsconfig.tsbuildinfo +1 -1
  250. package/package.json +6 -1
  251. package/src/surfaces/checkout/api/announcement/announcement.ts +20 -6
  252. package/src/surfaces/checkout/api/checkout/checkout.ts +2 -2
  253. package/src/surfaces/checkout/targets.ts +2 -2
  254. package/src/surfaces/checkout.ts +1 -1
  255. package/src/surfaces/customer-account/api/announcement/announcement.ts +20 -6
  256. package/src/surfaces/customer-account/api/docs.ts +3 -0
  257. package/src/surfaces/customer-account/api/standard-api/standard-api.ts +2 -0
  258. package/src/surfaces/customer-account/api.ts +2 -0
  259. package/src/surfaces/customer-account/targets.ts +5 -4
  260. package/src/surfaces/point-of-sale/api.ts +1 -0
  261. package/src/surfaces/point-of-sale/event/data/BaseApi.ts +3 -0
  262. package/src/surfaces/point-of-sale/event/data/BaseData.ts +15 -0
  263. package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +6 -0
  264. package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +27 -0
  265. package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +19 -0
  266. package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +9 -0
  267. package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +19 -0
  268. package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +12 -0
  269. package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +27 -0
  270. package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +14 -0
  271. package/src/surfaces/point-of-sale/render/api/action-api/action-api.ts +3 -5
  272. package/src/surfaces/point-of-sale/render/api/cart-api/cart-api.ts +37 -31
  273. package/src/surfaces/point-of-sale/render/api/cart-line-item-api/cart-line-item-api.ts +2 -2
  274. package/src/surfaces/point-of-sale/render/api/connectivity-api/connectivity-api.ts +6 -4
  275. package/src/surfaces/point-of-sale/render/api/customer-api/customer-api.ts +4 -1
  276. package/src/surfaces/point-of-sale/render/api/device-api/device-api.ts +4 -4
  277. package/src/surfaces/point-of-sale/render/api/draft-order-api/draft-order-api.ts +6 -3
  278. package/src/surfaces/point-of-sale/render/api/locale-api/locale-api.ts +3 -4
  279. package/src/surfaces/point-of-sale/render/api/navigation-api/navigation-api.ts +9 -7
  280. package/src/surfaces/point-of-sale/render/api/order-api/order-api.ts +5 -5
  281. package/src/surfaces/point-of-sale/render/api/print-api/print-api.ts +7 -12
  282. package/src/surfaces/point-of-sale/render/api/product-api/product-api.ts +5 -2
  283. package/src/surfaces/point-of-sale/render/api/product-search-api/product-search-api.ts +24 -10
  284. package/src/surfaces/point-of-sale/render/api/scanner-api/scanner-api.ts +22 -10
  285. package/src/surfaces/point-of-sale/render/api/session-api/session-api.ts +3 -6
  286. package/src/surfaces/point-of-sale/render/api/storage-api/storage-api.ts +7 -0
  287. package/src/surfaces/point-of-sale/render/api/toast-api/toast-api.ts +11 -1
  288. package/src/surfaces/point-of-sale/render/components/Badge/Badge.ts +12 -10
  289. package/src/surfaces/point-of-sale/render/components/Banner/Banner.ts +13 -14
  290. package/src/surfaces/point-of-sale/render/components/Button/Button.ts +9 -15
  291. package/src/surfaces/point-of-sale/render/components/CameraScanner/CameraScanner.ts +6 -8
  292. package/src/surfaces/point-of-sale/render/components/DatePicker/DatePicker.ts +8 -11
  293. package/src/surfaces/point-of-sale/render/components/Dialog/Dialog.ts +13 -20
  294. package/src/surfaces/point-of-sale/render/components/Icon/Icon.ts +254 -248
  295. package/src/surfaces/point-of-sale/render/components/Image/Image.ts +14 -5
  296. package/src/surfaces/point-of-sale/render/components/List/List.ts +30 -25
  297. package/src/surfaces/point-of-sale/render/components/Navigator/Navigator.ts +1 -4
  298. package/src/surfaces/point-of-sale/render/components/NumberField/NumberField.ts +7 -7
  299. package/src/surfaces/point-of-sale/render/components/POSBlock/POSBlock.ts +5 -9
  300. package/src/surfaces/point-of-sale/render/components/POSBlock/POSBlockRow.ts +1 -4
  301. package/src/surfaces/point-of-sale/render/components/POSReceiptBlock/POSReceiptBlock.ts +0 -4
  302. package/src/surfaces/point-of-sale/render/components/PinPad/PinPad.ts +25 -28
  303. package/src/surfaces/point-of-sale/render/components/PrintPreview/PrintPreview.ts +1 -11
  304. package/src/surfaces/point-of-sale/render/components/QRCode/QRCode.ts +1 -5
  305. package/src/surfaces/point-of-sale/render/components/RadioButtonList/RadioButtonList.ts +4 -4
  306. package/src/surfaces/point-of-sale/render/components/Screen/Screen.ts +13 -33
  307. package/src/surfaces/point-of-sale/render/components/SearchBar/SearchBar.ts +7 -7
  308. package/src/surfaces/point-of-sale/render/components/Section/Section.ts +6 -11
  309. package/src/surfaces/point-of-sale/render/components/SectionHeader/SectionHeader.ts +6 -6
  310. package/src/surfaces/point-of-sale/render/components/SegmentedControl/SegmentedControl.ts +9 -7
  311. package/src/surfaces/point-of-sale/render/components/Selectable/Selectable.ts +2 -2
  312. package/src/surfaces/point-of-sale/render/components/Stack/Stack.ts +27 -22
  313. package/src/surfaces/point-of-sale/render/components/Stepper/Stepper.ts +8 -6
  314. package/src/surfaces/point-of-sale/render/components/Text/Text.ts +28 -2
  315. package/src/surfaces/point-of-sale/render/components/TextArea/TextArea.ts +1 -6
  316. package/src/surfaces/point-of-sale/render/components/TextField/TextField.ts +30 -0
  317. package/src/surfaces/point-of-sale/render/components/Tile/Tile.ts +6 -15
  318. package/src/surfaces/point-of-sale/render/components/TimeField/TimeField.ts +2 -1
  319. package/src/surfaces/point-of-sale/render/components/TimePicker/TimePicker.ts +10 -14
  320. package/src/surfaces/point-of-sale/render/components/shared/BaseTextField.ts +6 -14
  321. package/src/surfaces/point-of-sale/render/components/shared/InputField.ts +16 -37
  322. package/src/surfaces/point-of-sale/render/components/shared/box.ts +33 -42
  323. package/src/surfaces/point-of-sale/render/components/shared/deprecated-types.ts +12 -0
  324. package/src/surfaces/point-of-sale/render/components/shared/inner-layouts.ts +14 -7
  325. package/src/surfaces/point-of-sale/render/components/shared/sizes.ts +3 -1
  326. package/src/surfaces/point-of-sale/targets.ts +139 -0
  327. package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +39 -0
  328. package/src/surfaces/point-of-sale/types/cart.ts +284 -10
  329. package/src/surfaces/point-of-sale/types/country-code.ts +3 -0
  330. package/src/surfaces/point-of-sale/types/device.ts +6 -3
  331. package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +3 -3
  332. package/src/surfaces/point-of-sale/types/discount-allocation.ts +11 -0
  333. package/src/surfaces/point-of-sale/types/money.ts +23 -0
  334. package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -2
  335. package/src/surfaces/point-of-sale/types/order.ts +18 -0
  336. package/src/surfaces/point-of-sale/types/paginated-result.ts +2 -3
  337. package/src/surfaces/point-of-sale/types/payment.ts +16 -0
  338. package/src/surfaces/point-of-sale/types/product.ts +172 -0
  339. package/src/surfaces/point-of-sale/types/session.ts +7 -5
  340. package/src/surfaces/point-of-sale/types/shipping-line.ts +32 -0
  341. package/src/surfaces/point-of-sale/types/storage.ts +13 -11
  342. package/src/surfaces/point-of-sale/types/tax-line.ts +21 -0
  343. package/src/surfaces/point-of-sale/types/transaction-type.ts +7 -0
@@ -4,274 +4,280 @@ import {createRemoteComponent} from '@remote-ui/core';
4
4
  * @deprecated Use `IconName` instead. These deprecated icon names will be removed in 2025-10.
5
5
  */
6
6
  export type DeprecatedIconName =
7
- | 'add-customer'
8
- | 'analytics'
9
- | 'apps'
10
- | 'arrow'
11
- | 'arrow-left'
12
- | 'backspace'
13
- | 'card-reader'
14
- | 'call'
15
- | 'cancel'
16
- | 'not-stocked'
17
- | 'cash'
18
- | 'checkmark'
19
- | 'caret-down'
20
- | 'checkmark-active'
21
- | 'checkmark-inactive'
22
- | 'chevron-up'
23
- | 'chevron-right'
24
- | 'chevron-down'
25
- | 'circle-alert'
26
- | 'circle-cancel'
27
- | 'circle-checkmark'
28
- | 'circle-disconnected'
29
- | 'circle-info'
30
- | 'circle-outline'
31
- | 'clock'
32
- | 'collections'
33
- | 'copy'
34
- | 'credit-card'
35
- | 'custom-payment'
36
- | 'custom-sale'
37
- | 'discount'
38
- | 'external-link'
39
- | 'flag'
40
- | 'flip-camera'
41
- | 'gallery-view'
42
- | 'gift-card'
43
- | 'help'
44
- | 'hide-keyboard'
45
- | 'home'
46
- | 'horizontal-dots'
47
- | 'keypad'
48
- | 'lightning'
49
- | 'link'
50
- | 'list'
51
- | 'list-view'
52
- | 'lock'
53
- | 'mail'
54
- | 'available-at-other-locations'
55
- | 'menu'
56
- | 'minus'
57
- | 'mobile'
58
- | 'note-report'
59
- | 'drawer'
60
- | 'orders'
61
- | 'shopify-payments'
62
- | 'play-button'
63
- | 'plus'
64
- | 'products'
65
- | 'radio-active'
66
- | 'radio-inactive'
67
- | 'rearrange'
68
- | 'receipt'
69
- | 'refresh'
70
- | 'register'
71
- | 'retrieve-cart'
72
- | 'image-placeholder'
73
- | 'save-cart'
74
- | 'scan-barcode'
75
- | 'search'
76
- | 'send'
77
- | 'settings'
78
- | 'shipment'
79
- | 'split-payment'
80
- | 'sort'
81
- | 'staff'
82
- | 'star'
83
- | 'unordered-list'
84
- | 'connectivity-warning'
85
- | 'internet'
86
- | 'delivery'
87
- | 'shop-pay';
7
+ | 'add-customer' /** Add customer symbol. Use for creating new customer accounts. Removed in version 2025-10. Use `'customer-outlined'` instead. */
8
+ | 'analytics' /** Analytics symbol. Use for data analysis and reports. Removed in version 2025-10. Use `'analytics'` from `IconName` instead. */
9
+ | 'apps' /** Applications symbol. Use for app launchers. Removed in version 2025-10. Use `'apps'` from `IconName` instead. */
10
+ | 'arrow' /** A generic arrow symbol. Removed in version 2025-10. Use specific directional arrows instead (`'arrow-up'`, `'arrow-down'`, `'arrow-left'`, `'arrow-right'`). */
11
+ | 'arrow-left' /** Left arrow symbol. Removed in version 2025-10. Use `'arrow-left'` from `IconName` instead. */
12
+ | 'backspace' /** A backspace symbol. Removed in version 2025-10. Use `'backspace'` from `IconName` instead. */
13
+ | 'card-reader' /** Card reader device symbol. Removed in version 2025-10. Use `'card-reader'` from `IconName` instead. */
14
+ | 'call' /** A phone call symbol. Removed in version 2025-10. Use `'call'` from `IconName` instead. */
15
+ | 'cancel' /** A cancel symbol. Removed in version 2025-10. Use `'cancel'` from `IconName` instead. */
16
+ | 'not-stocked' /** Not stocked symbol. Removed in version 2025-10. Use `'not-stocked'` from `IconName` instead. */
17
+ | 'cash' /** A cash symbol. Removed in version 2025-10. Use `'cash'` from `IconName` instead. */
18
+ | 'checkmark' /** A checkmark symbol. Removed in version 2025-10. Use `'checkmark'` from `IconName` instead. */
19
+ | 'caret-down' /** Small downward caret. Removed in version 2025-10. Use `'caret-down'` from `IconName` instead. */
20
+ | 'checkmark-active' /** Active checkmark symbol. Removed in version 2025-10. Use `'checkmark-active'` from `IconName` instead. */
21
+ | 'checkmark-inactive' /** Inactive checkmark symbol. Removed in version 2025-10. Use `'checkmark-inactive'` from `IconName` instead. */
22
+ | 'chevron-up' /** Upward chevron. Removed in version 2025-10. Use `'chevron-up'` from `IconName` instead. */
23
+ | 'chevron-right' /** Rightward chevron. Removed in version 2025-10. Use `'chevron-right'` from `IconName` instead. */
24
+ | 'chevron-down' /** Downward chevron. Removed in version 2025-10. Use `'chevron-down'` from `IconName` instead. */
25
+ | 'circle-alert' /** Alert symbol in circle. Removed in version 2025-10. Use `'circle-alert'` from `IconName` instead. */
26
+ | 'circle-cancel' /** Cancel symbol in circle. Removed in version 2025-10. Use `'circle-cancel'` from `IconName` instead. */
27
+ | 'circle-checkmark' /** Checkmark in circle. Removed in version 2025-10. Use `'circle-checkmark'` from `IconName` instead. */
28
+ | 'circle-disconnected' /** Disconnected circle symbol. Removed in version 2025-10. Use `'circle-disconnected'` from `IconName` instead. */
29
+ | 'circle-info' /** Information symbol in circle. Removed in version 2025-10. Use `'circle-info'` from `IconName` instead. */
30
+ | 'circle-outline' /** Simple circle outline. Removed in version 2025-10. Use `'circle-outline'` from `IconName` instead. */
31
+ | 'clock' /** Clock or time symbol. Removed in version 2025-10. Use `'clock'` from `IconName` instead. */
32
+ | 'collections' /** Product collections symbol. Removed in version 2025-10. Use `'collection'` from `IconName` instead. */
33
+ | 'copy' /** Copy or duplicate symbol. Removed in version 2025-10. Use `'copy'` from `IconName` instead. */
34
+ | 'credit-card' /** Credit card symbol. Removed in version 2025-10. Use `'credit-card'` from `IconName` instead. */
35
+ | 'custom-payment' /** Custom payment method symbol. Removed in version 2025-10. Use `'custom-payment'` from `IconName` instead. */
36
+ | 'custom-sale' /** Custom sale symbol. Removed in version 2025-10. Use `'custom-sale'` from `IconName` instead. */
37
+ | 'discount' /** Discount or sale symbol. Removed in version 2025-10. Use `'discount'` from `IconName` instead. */
38
+ | 'external-link' /** External link symbol. Removed in version 2025-10. Use `'external-link'` from `IconName` instead. */
39
+ | 'flag' /** Flag or marker symbol. Removed in version 2025-10. Use `'flag'` from `IconName` instead. */
40
+ | 'flip-camera' /** Camera rotation or flip symbol. Removed in version 2025-10. Use `'flip-camera'` from `IconName` instead. */
41
+ | 'gallery-view' /** Gallery view symbol. Removed in version 2025-10. Use `'gallery-view'` from `IconName` instead. */
42
+ | 'gift-card' /** Gift card symbol. Removed in version 2025-10. Use `'gift-card'` from `IconName` instead. */
43
+ | 'help' /** Help symbol. Removed in version 2025-10. Use `'help'` from `IconName` instead. */
44
+ | 'hide-keyboard' /** Hide keyboard symbol. Removed in version 2025-10. Use `'hide-keyboard'` from `IconName` instead. */
45
+ | 'home' /** Home symbol. Removed in version 2025-10. Use `'home-filled'` or `'home-outlined'` from `IconName` instead. */
46
+ | 'horizontal-dots' /** Horizontal dots or more options symbol. Removed in version 2025-10. Use `'horizontal-dots'` from `IconName` instead. */
47
+ | 'keypad' /** Numeric keypad symbol. Removed in version 2025-10. Use `'keypad'` from `IconName` instead. */
48
+ | 'lightning' /** Lightning bolt symbol. Removed in version 2025-10. Use `'lightning'` from `IconName` instead. */
49
+ | 'link' /** Link or chain symbol. Removed in version 2025-10. Use `'link'` from `IconName` instead. */
50
+ | 'list' /** List symbol. Removed in version 2025-10. Use `'list'` from `IconName` instead. */
51
+ | 'list-view' /** List view layout symbol. Removed in version 2025-10. Use `'list-view'` from `IconName` instead. */
52
+ | 'lock' /** Lock or security symbol. Removed in version 2025-10. Use `'lock'` from `IconName` instead. */
53
+ | 'mail' /** Email or message symbol. Removed in version 2025-10. Use `'mail'` from `IconName` instead. */
54
+ | 'available-at-other-locations' /** Available at other locations symbol. Removed in version 2025-10. Use appropriate `IconName` alternative. */
55
+ | 'menu' /** Menu symbol. Removed in version 2025-10. Use `'horizontal-dots'` or other `IconName` alternative. */
56
+ | 'minus' /** Minus or subtract symbol. Removed in version 2025-10. Use `'minus'` from `IconName` instead. */
57
+ | 'mobile' /** Mobile phone symbol. Removed in version 2025-10. Use `'mobile'` from `IconName` instead. */
58
+ | 'note-report' /** Note or report symbol. Removed in version 2025-10. Use `'note-report'` from `IconName` instead. */
59
+ | 'drawer' /** Cash drawer symbol. Removed in version 2025-10. Use `'drawer'` from `IconName` instead. */
60
+ | 'orders' /** Orders symbol. Removed in version 2025-10. Use `'orders-filled'` or `'orders-outlined'` from `IconName` instead. */
61
+ | 'shopify-payments' /** Shopify payments symbol. Removed in version 2025-10. Use `'shopify-payments'` from `IconName` instead. */
62
+ | 'play-button' /** Play button symbol. Removed in version 2025-10. Use `'play-button'` from `IconName` instead. */
63
+ | 'plus' /** Plus or add symbol. Removed in version 2025-10. Use `'plus'` from `IconName` instead. */
64
+ | 'products' /** Products symbol. Removed in version 2025-10. Use `'products-filled'` or `'products-outlined'` from `IconName` instead. */
65
+ | 'radio-active' /** Active radio button symbol. Removed in version 2025-10. Use `'radio-active'` from `IconName` instead. */
66
+ | 'radio-inactive' /** Inactive radio button symbol. Removed in version 2025-10. Use `'radio-inactive'` from `IconName` instead. */
67
+ | 'rearrange' /** Rearrange or reorder symbol. Removed in version 2025-10. Use `'rearrange'` from `IconName` instead. */
68
+ | 'receipt' /** Receipt symbol. Removed in version 2025-10. Use `'receipt'` from `IconName` instead. */
69
+ | 'refresh' /** Refresh or reload symbol. Removed in version 2025-10. Use `'refresh'` from `IconName` instead. */
70
+ | 'register' /** Cash register symbol. Removed in version 2025-10. Use `'register'` from `IconName` instead. */
71
+ | 'retrieve-cart' /** Retrieve cart symbol. Removed in version 2025-10. Use `'retrieve-cart'` from `IconName` instead. */
72
+ | 'image-placeholder' /** Image placeholder symbol. Removed in version 2025-10. Use `'image'` from `IconName` instead. */
73
+ | 'save-cart' /** Save cart symbol. Removed in version 2025-10. Use `'save-cart'` from `IconName` instead. */
74
+ | 'scan-barcode' /** Barcode scanning symbol. Removed in version 2025-10. Use `'scan-barcode'` from `IconName` instead. */
75
+ | 'search' /** Search or magnifying glass symbol. Removed in version 2025-10. Use `'search'` from `IconName` instead. */
76
+ | 'send' /** Send or submit symbol. Removed in version 2025-10. Use `'send'` from `IconName` instead. */
77
+ | 'settings' /** Settings or gear symbol. Removed in version 2025-10. Use `'settings'` from `IconName` instead. */
78
+ | 'shipment' /** Shipment symbol. Removed in version 2025-10. Use `'fulfillment-shipment'` from `IconName` instead. */
79
+ | 'split-payment' /** Split payment symbol. Removed in version 2025-10. Use `'split-payment'` from `IconName` instead. */
80
+ | 'sort' /** Sort or arrange symbol. Removed in version 2025-10. Use `'sort'` from `IconName` instead. */
81
+ | 'staff' /** Staff or employee symbol. Removed in version 2025-10. Use `'staff'` from `IconName` instead. */
82
+ | 'star' /** Star symbol. Removed in version 2025-10. Use `'star'` from `IconName` instead. */
83
+ | 'unordered-list' /** Unordered list symbol. Removed in version 2025-10. Use `'unordered-list'` from `IconName` instead. */
84
+ | 'connectivity-warning' /** Connectivity warning symbol. Removed in version 2025-10. Use `'connectivity-issue'` from `IconName` instead. */
85
+ | 'internet' /** Internet connectivity symbol. Removed in version 2025-10. Use `'connectivity'` or `'no-internet'` from `IconName` instead. */
86
+ | 'delivery' /** Delivery symbol. Removed in version 2025-10. Use `'fulfillment-delivery'` from `IconName` instead. */
87
+ | 'shop-pay' /** Shop Pay symbol. Removed in version 2025-10. Use `'shop-pay'` from `IconName` instead. */;
88
88
 
89
89
  /**
90
90
  * @deprecated Use `IconSize` instead. These deprecated icon sizes will be removed in 2025-10.
91
91
  */
92
92
  export type DeprecatedIconSize =
93
- | 'minor'
94
- | 'major'
95
- | 'spot'
96
- | 'caption'
97
- | 'badge';
93
+ | 'minor' /** A minor size for small elements. Removed in version 2025-10. Use `'s'` or `'m'` size instead. */
94
+ | 'major' /** A major size for prominent elements. Removed in version 2025-10. Use `'l'` or `'xl'` size instead. */
95
+ | 'spot' /** A spot size for specific use cases. Removed in version 2025-10. Use `'m'` or `'l'` size instead. */
96
+ | 'caption' /** A caption size for small text accompaniment. Removed in version 2025-10. Use `'s'` size instead. */
97
+ | 'badge' /** A badge size for small indicators. Removed in version 2025-10. Use `'s'` size instead. */;
98
98
 
99
99
  export type IconName =
100
- | 'add-customer'
101
- | 'activity'
102
- | 'analytics'
103
- | 'apps'
104
- | 'arrow-down'
105
- | 'arrow-left'
106
- | 'arrow-right'
107
- | 'arrow-up'
108
- | 'backspace'
109
- | 'call'
110
- | 'cancel-fulfillment'
111
- | 'cancel'
112
- | 'card-reader'
113
- | 'caret-down'
114
- | 'caret-up'
115
- | 'cart-filled'
116
- | 'cart-outlined'
117
- | 'cash'
118
- | 'checklist'
119
- | 'checkmark'
120
- | 'checkmark-active'
121
- | 'checkmark-inactive'
122
- | 'chevron-down'
123
- | 'chevron-left'
124
- | 'chevron-right'
125
- | 'chevron-up'
126
- | 'circle-alert'
127
- | 'circle-cancel'
128
- | 'circle-checkmark'
129
- | 'circle-disconnected'
130
- | 'circle-info'
131
- | 'circle-outline'
132
- | 'clock'
133
- | 'collection'
134
- | 'connectivity'
135
- | 'connectivity-issue'
136
- | 'connectivity-critical-issue'
137
- | 'copy'
138
- | 'credit-card'
139
- | 'custom-payment'
140
- | 'custom-sale'
141
- | 'customer-filled'
142
- | 'customer-outlined'
143
- | 'delete'
144
- | 'desktop'
145
- | 'discount'
146
- | 'discount-automatic'
147
- | 'discount-code'
148
- | 'discount-custom'
149
- | 'discount-remove'
150
- | 'dockside'
151
- | 'draft-orders'
152
- | 'drawer'
153
- | 'exchange'
154
- | 'external-link'
155
- | 'fees'
156
- | 'flag'
157
- | 'flip-camera'
158
- | 'fulfillment-delivery'
159
- | 'fulfillment-shipment'
160
- | 'gallery-view'
161
- | 'gift-card'
162
- | 'help'
163
- | 'hide'
164
- | 'hide-keyboard'
165
- | 'home-filled'
166
- | 'home-outlined'
167
- | 'horizontal-dots'
168
- | 'image'
169
- | 'images'
170
- | 'inventory-adjustments'
171
- | 'inventory-counts'
172
- | 'inventory-po'
173
- | 'inventory-transfer'
174
- | 'keypad'
175
- | 'learn'
176
- | 'lightning'
177
- | 'link'
178
- | 'list'
179
- | 'list-view'
180
- | 'location'
181
- | 'lock'
182
- | 'low-battery'
183
- | 'mail'
184
- | 'maximize'
185
- | 'minimize'
186
- | 'minus'
187
- | 'mobile'
188
- | 'more-filled'
189
- | 'more-outlined'
190
- | 'no-internet'
191
- | 'note-report'
192
- | 'not-stocked'
193
- | 'orders-filled'
194
- | 'orders-outlined'
195
- | 'pencil'
196
- | 'play-button'
197
- | 'plus'
198
- | 'point-of-sale'
199
- | 'print'
200
- | 'pro'
201
- | 'products-filled'
202
- | 'products-outlined'
203
- | 'radio-active'
204
- | 'radio-inactive'
205
- | 'reassign-fulfillment'
206
- | 'rearrange'
207
- | 'receipt'
208
- | 'refresh'
209
- | 'register'
210
- | 'return'
211
- | 'retrieve-cart'
212
- | 'save-cart'
213
- | 'scan-barcode'
214
- | 'scan-qr-code'
215
- | 'search'
216
- | 'send'
217
- | 'send-cart'
218
- | 'settings'
219
- | 'shop-app'
220
- | 'shop-pay'
221
- | 'shopify-payments'
222
- | 'sort'
223
- | 'split-payment'
224
- | 'staff'
225
- | 'star'
226
- | 'store'
227
- | 'tablet-l'
228
- | 'tablet-s'
229
- | 'tap-to-pay'
230
- | 'unlock'
231
- | 'unordered-list'
232
- | 'variant'
233
- | 'view'
234
- | 'void-shipping-label';
100
+ | 'add-customer' /** Add customer symbol. Use for creating new customer accounts. Removed in version 2025-10. Use `IconName` equivalent instead. */
101
+ | 'activity' /** An activity or action indicator. Use for activity feeds, action logs, or recent activity displays. */
102
+ | 'analytics' /** Analytics symbol. Use for data analysis and reports. Removed in version 2025-10. Use `IconName` equivalent instead. */
103
+ | 'apps' /** Applications symbol. Use for app launchers. Removed in version 2025-10. Use `IconName` equivalent instead. */
104
+ | 'arrow-down' /** A downward pointing arrow. Use for dropdown menus, collapsing content, downloading actions, or indicating downward movement. */
105
+ | 'arrow-left' /** A left arrow symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
106
+ | 'arrow-right' /** A rightward pointing arrow. Use for forward navigation, next actions, or indicating rightward movement and progression. */
107
+ | 'arrow-up' /** An upward pointing arrow. Use for expanding content, uploading actions, or indicating upward movement and elevation. */
108
+ | 'backspace' /** A backspace symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
109
+ | 'call' /** A phone call symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
110
+ | 'cancel-fulfillment' /** A cancel fulfillment symbol. Use for stopping order fulfillment, canceling shipments, or fulfillment management. */
111
+ | 'cancel' /** A cancel symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
112
+ | 'card-reader' /** A card reader symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
113
+ | 'caret-down' /** A small downward caret. Use for dropdown indicators, collapsible sections, or subtle directional cues. */
114
+ | 'caret-up' /** A small upward caret. Use for expandable sections, sort indicators, or subtle upward directional cues. */
115
+ | 'cart-filled' /** A filled shopping cart. Use to indicate items in cart, active shopping session, or cart with contents. */
116
+ | 'cart-outlined' /** A shopping cart outline. Use for shopping functionality, adding items to cart, or e-commerce actions. */
117
+ | 'cash' /** A cash symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
118
+ | 'checklist' /** A checklist symbol. Use for tasks, order fulfillment, inventory checks, or process completion. */
119
+ | 'checkmark' /** A checkmark symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
120
+ | 'checkmark-active' /** Active checkmark symbol. Use for selected items, active confirmations, or enabled states. */
121
+ | 'checkmark-inactive' /** An inactive checkmark symbol. Use for unselected items, disabled confirmations, or inactive states. */
122
+ | 'chevron-down' /** A downward chevron. Use for dropdown menus, expandable content, or indicating downward navigation. */
123
+ | 'chevron-left' /** A leftward chevron. Use for back navigation, previous items, or leftward movement in carousels and lists. */
124
+ | 'chevron-right' /** A rightward chevron. Use for forward navigation, next items, or rightward movement and progression. */
125
+ | 'chevron-up' /** An upward chevron. Use for collapsible content, scroll to top, or indicating upward navigation. */
126
+ | 'circle-alert' /** Alert symbol in circle. Use for system alerts, validation errors, or important notifications that require attention. */
127
+ | 'circle-cancel' /** A cancel symbol in circle. Use for cancellation actions, error states, or removing items with emphasis. */
128
+ | 'circle-checkmark' /** A checkmark in circle. Use for completed tasks, successful operations, or positive confirmation states. */
129
+ | 'circle-disconnected' /** A disconnected circle symbol. Use for offline states, connection issues, or unavailable services. */
130
+ | 'circle-info' /** An information symbol in circle. Use for help content, additional details, or informational messages. */
131
+ | 'circle-outline' /** A simple circle outline. Use for radio buttons, status indicators, or basic geometric markers. */
132
+ | 'clock' /** A clock or time symbol. Use for scheduling, time tracking, business hours, or temporal information. */
133
+ | 'collection' /** A product collection or group symbol. Use for product categories, grouped items, or collection management. */
134
+ | 'connectivity' /** A connectivity indicator. Use for network status, connection quality, or connectivity features. */
135
+ | 'connectivity-issue' /** A connectivity problem indicator. Use for network issues, connection warnings, or connectivity troubleshooting. */
136
+ | 'connectivity-critical-issue' /** A critical connectivity problem. Use for severe network failures, critical connection errors, or urgent connectivity issues. */
137
+ | 'copy' /** A copy or duplicate symbol. Use for copying items, duplicating records, or replication actions. */
138
+ | 'credit-card' /** A credit card symbol. Use for payment methods, card transactions, or financial operations. */
139
+ | 'custom-payment' /** A custom payment method symbol. Use for alternative payment options, custom payment processing, or specialized payment types. */
140
+ | 'custom-sale' /** A custom sale symbol. Use for special sales, custom pricing, or non-standard sale transactions. */
141
+ | 'customer-filled' /** A filled customer symbol. Use for active customers, selected customer profiles, or customer highlights. */
142
+ | 'customer-outlined' /** A customer outline symbol. Use for customer accounts, customer profiles, or customer-related features. */
143
+ | 'delete' /** A delete or trash symbol. Use for removing items, deleting records, or destructive actions. */
144
+ | 'desktop' /** A desktop computer symbol. Use for device types, platform indicators, or desktop-specific features. */
145
+ | 'discount' /** A discount or sale symbol. Use for promotions, price reductions, or special offers. */
146
+ | 'discount-automatic' /** Automatic discount symbol. Use for system-applied discounts, automatic promotions, or rule-based reductions. */
147
+ | 'discount-code' /** A discount code symbol. Use for coupon codes, promotional codes, or manual discount entry. */
148
+ | 'discount-custom' /** A custom discount symbol. Use for manual discounts, custom pricing adjustments, or personalized promotions. */
149
+ | 'discount-remove' /** A remove discount symbol. Use for removing applied discounts, canceling promotions, or undoing price reductions. */
150
+ | 'dockside' /** A dockside or shipping dock symbol. Use for shipping operations, dock management, or logistics features. */
151
+ | 'draft-orders' /** A draft orders symbol. Use for incomplete orders, order drafts, or pending order creation. */
152
+ | 'drawer' /** A cash drawer symbol. Use for cash register operations, drawer opening, or cash management. */
153
+ | 'exchange' /** An exchange or swap symbol. Use for product exchanges, return processing, or item swapping. */
154
+ | 'external-link' /** An external link symbol. Use for links that open in new windows, external resources, or outside navigation. */
155
+ | 'fees' /** A fees symbol. Use for transaction fees, additional charges, or fee management. */
156
+ | 'flag' /** A flag or marker symbol. Use for flagging items, marking important content, or status indicators. */
157
+ | 'flip-camera' /** A camera rotation or flip symbol. Use for switching camera views, rotating images, or camera-related controls. */
158
+ | 'fulfillment-delivery' /** A delivery fulfillment symbol. Use for delivery options, shipping fulfillment, or delivery tracking. */
159
+ | 'fulfillment-shipment' /** A shipment fulfillment symbol. Use for shipping operations, package fulfillment, or shipment tracking. */
160
+ | 'gallery-view' /** A gallery view symbol. Use for image galleries, grid layouts, or visual content displays. */
161
+ | 'gift-card' /** A gift card symbol. Use for gift card sales, redemption, or gift card management features. */
162
+ | 'help' /** A help symbol. Use for help features, support, or informational assistance. */
163
+ | 'hide' /** A hide or visibility off symbol. Use for hiding content, privacy controls, or visibility toggles. */
164
+ | 'hide-keyboard' /** A hide keyboard symbol. Use for dismissing on-screen keyboards or input controls. */
165
+ | 'home-filled' /** A filled home symbol. Use for active home state, main navigation, or primary dashboard indicator. */
166
+ | 'home-outlined' /** A home outline symbol. Use for home navigation, main dashboard, or returning to start screen. */
167
+ | 'horizontal-dots' /** A horizontal dots or more options symbol. Use for additional actions, overflow menus, or more options. */
168
+ | 'image' /** A single image symbol. Use for image upload, photo features, or visual content indicators. */
169
+ | 'images' /** A multiple images symbol. Use for image galleries, bulk photo operations, or media collections. */
170
+ | 'inventory-adjustments' /** An inventory adjustments symbol. Use for stock adjustments, inventory corrections, or quantity modifications. */
171
+ | 'inventory-counts' /** An inventory counts symbol. Use for stock counting, inventory audits, or quantity verification. */
172
+ | 'inventory-po' /** A purchase order inventory symbol. Use for purchase orders, inventory procurement, or stock ordering. */
173
+ | 'inventory-transfer' /** An inventory transfer symbol. Use for moving stock between locations, transfers, or redistribution. */
174
+ | 'keypad' /** A numeric keypad symbol. Use for number entry, PIN input, or calculator functions. */
175
+ | 'learn' /** A learning or education symbol. Use for training, tutorials, or educational features. */
176
+ | 'lightning' /** A lightning bolt symbol. Use for power, energy, fast actions, or high-priority features. */
177
+ | 'link' /** A link or chain symbol. Use for hyperlinks, connections, or linking functionality. */
178
+ | 'list' /** A list symbol. Use for list views, itemized content, or list formatting. */
179
+ | 'list-view' /** A list view layout symbol. Use for switching to list layout, organizing content, or list-based displays. */
180
+ | 'location' /** A location or map pin symbol. Use for store locations, addresses, or geographic features. */
181
+ | 'lock' /** A lock or security symbol. Use for secure features, locked content, or security settings. */
182
+ | 'low-battery' /** A low battery indicator. Use for device status, power warnings, or battery-related notifications. */
183
+ | 'mail' /** An email or message symbol. Use for email functionality, messaging, or communication features. */
184
+ | 'maximize' /** A maximize or expand symbol. Use for fullscreen mode, expanding windows, or enlarging content. */
185
+ | 'minimize' /** A minimize or collapse symbol. Use for reducing windows, collapsing content, or minimizing interfaces. */
186
+ | 'minus' /** A minus or subtract symbol. Use for decreasing quantities, removing items, or subtraction operations. */
187
+ | 'mobile' /** A mobile phone symbol. Use for mobile features, device types, or mobile-specific functionality. */
188
+ | 'more-filled' /** A filled more options symbol. Use for active additional actions, prominent overflow menus, or emphasized options. */
189
+ | 'more-outlined' /** An outlined more options symbol. Use for additional actions, overflow menus, or more options. */
190
+ | 'no-internet' /** A no internet connection symbol. Use for offline states, connection failures, or network unavailability. */
191
+ | 'note-report' /** A note or report symbol. Use for notes, documentation, reports, or text content features. */
192
+ | 'not-stocked' /** A not stocked symbol. Removed in version 2025-10. Use `IconName` equivalent instead. */
193
+ | 'orders-filled' /** A filled orders symbol. Use for completed orders, active order states, or order fulfillment. */
194
+ | 'orders-outlined' /** An orders outline symbol. Use for order management, order history, or order-related functions. */
195
+ | 'pencil' /** A pencil or edit symbol. Use for editing content, modifying records, or entering edit mode. */
196
+ | 'play-button' /** A play button symbol. Use for starting processes, playing media, or initiating actions. */
197
+ | 'plus' /** A plus or add symbol. Use for adding items, creating new content, or addition operations. */
198
+ | 'point-of-sale' /** A point of sale system symbol. Use for POS features, retail operations, or sales terminals. */
199
+ | 'print' /** A print symbol. Use for printing receipts, documents, or print-related functionality. */
200
+ | 'pro' /** A pro or premium symbol. Use for professional features, premium content, or advanced functionality. */
201
+ | 'products-filled' /** A filled products symbol. Use for active products, selected items, or product highlights. */
202
+ | 'products-outlined' /** A products outline symbol. Use for product management, catalog features, or product-related functions. */
203
+ | 'radio-active' /** Active radio button symbol. Use for selected radio options, active choices, or enabled selections. */
204
+ | 'radio-inactive' /** An inactive radio button symbol. Use for unselected radio options, inactive choices, or disabled selections. */
205
+ | 'reassign-fulfillment' /** A reassign fulfillment symbol. Use for changing fulfillment locations, reassigning orders, or fulfillment redirection. */
206
+ | 'rearrange' /** A rearrange or reorder symbol. Use for reordering lists, organizing content, or arrangement controls. */
207
+ | 'receipt' /** A receipt symbol. Use for transaction receipts, purchase confirmations, or receipt management. */
208
+ | 'refresh' /** A refresh or reload symbol. Use for updating content, refreshing data, or reload operations. */
209
+ | 'register' /** A cash register symbol. Use for register operations, cash handling, or traditional POS functions. */
210
+ | 'return' /** A return symbol. Use for product returns, refund processing, or return management. */
211
+ | 'retrieve-cart' /** A retrieve cart symbol. Use for recovering saved carts, loading previous carts, or cart restoration. */
212
+ | 'save-cart' /** A save cart symbol. Use for saving current cart, cart preservation, or cart storage. */
213
+ | 'scan-barcode' /** A barcode scanning symbol. Use for product scanning, inventory management, or barcode-related functionality. */
214
+ | 'scan-qr-code' /** A QR code scanning symbol. Use for QR code features, digital scanning, or code-based interactions. */
215
+ | 'search' /** A search or magnifying glass symbol. Use for search functionality, finding content, or lookup features. */
216
+ | 'send' /** A send or submit symbol. Use for sending messages, submitting forms, or transmission actions. */
217
+ | 'send-cart' /** A send cart symbol. Use for sharing cart contents, sending cart to another device, or cart transfer actions. */
218
+ | 'settings' /** A settings or gear symbol. Use for configuration, preferences, or system settings. */
219
+ | 'shop-app' /** A shop app symbol. Use for shopping app features, mobile commerce, or app-specific functionality. */
220
+ | 'shop-pay' /** A shop pay symbol. Use for Shop Pay payment method, express checkout, or Shopify payment features. */
221
+ | 'shopify-payments' /** A shopify payments symbol. Use for Shopify payment processing, payment gateway features, or payment management. */
222
+ | 'sort' /** A sort or arrange symbol. Use for sorting lists, organizing content, or arrangement controls. */
223
+ | 'split-payment' /** A split payment symbol. Use for divided payments, partial payments, or payment splitting features. */
224
+ | 'staff' /** A staff or employee symbol. Use for staff management, employee features, or personnel-related functions. */
225
+ | 'star' /** A star symbol. Use for ratings, favorites, or highlighting important content. */
226
+ | 'store' /** A store or shop symbol. Use for store information, retail locations, or shop-related features. */
227
+ | 'tablet-l' /** A large tablet device symbol. Use for large tablet features, device types, or tablet-specific functionality. */
228
+ | 'tablet-s' /** A small tablet device symbol. Use for small tablet features, compact devices, or mini tablet functionality. */
229
+ | 'tap-to-pay' /** A tap to pay symbol. Use for contactless payments, NFC transactions, or tap payment features. */
230
+ | 'unlock' /** An unlock symbol. Use for unlocking features, accessing content, or security controls. */
231
+ | 'unordered-list' /** An unordered list symbol. Use for bulleted lists, itemized content, or list formatting. */
232
+ | 'variant' /** A product variant symbol. Use for product variations, different options, or variant management. */
233
+ | 'view' /** A view or eye symbol. Use for viewing content, visibility controls, or display options. */
234
+ | 'void-shipping-label' /** A void shipping label symbol. Use for canceling shipping labels, voiding shipments, or shipping corrections. */;
235
235
 
236
- export type IconSize = 's' | 'm' | 'l' | 'xl';
236
+ export type IconSize =
237
+ | 's' /** A small icon size. Use for compact spaces, inline text accompaniment, or when minimal visual weight is needed. */
238
+ | 'm' /** A medium icon size. Use for secondary navigation, list items, or compact interface elements. */
239
+ | 'l' /** A large icon size (default). Provides optimal visibility and balance for most interface elements, primary actions, and standard components. */
240
+ | 'xl' /** An extra large icon size. Use for prominent actions, headers, or when icons need maximum visibility and impact. */;
237
241
 
238
242
  export type IconTone =
239
- | 'icon-primary'
240
- | 'icon-inverse'
241
- | 'icon-subdued'
242
- | 'icon-disabled'
243
- | 'icon-warning'
244
- | 'icon-critical'
245
- | 'icon-success'
246
- | 'icon-interactive'
247
- | 'icon-highlight'
248
- | 'icon-shoppay'
249
- | 'icon-static-light'
250
- | 'icon-static-dark'
251
- | 'icon-inactive'
252
- | 'icon-badge-neutral'
253
- | 'icon-search'
254
- | 'icon-tile-default'
255
- | 'icon-tile-stack'
256
- | 'icon-tile-disabled'
257
- | 'icon-tile-pink'
258
- | 'icon-tile-purple'
259
- | 'icon-tile-orange'
260
- | 'icon-subnavigation-inactive'
261
- | 'icon-primary-pressed';
243
+ | 'icon-primary' /** Primary icon color. Use for main content and standard icon displays with default contrast. */
244
+ | 'icon-inverse' /** Inverse icon color. Use for icons on dark backgrounds or to create contrast in inverse color schemes. */
245
+ | 'icon-subdued' /** Subdued icon color. Use for secondary icons, less prominent content, or when reduced visual emphasis is needed. */
246
+ | 'icon-disabled' /** Disabled icon color. Use for inactive or unavailable icons that users cannot interact with. */
247
+ | 'icon-warning' /** Warning icon color. Use for caution states, important notices, or situations requiring attention. */
248
+ | 'icon-critical' /** Critical icon color. Use for errors, urgent issues, or destructive actions requiring immediate attention. */
249
+ | 'icon-success' /** Success icon color. Use for positive outcomes, confirmations, or completed actions. */
250
+ | 'icon-interactive' /** Interactive icon color. Use for clickable icons, links, or interactive elements to indicate interactivity. */
251
+ | 'icon-highlight' /** Highlight icon color. Use for emphasized content, featured items, or icons requiring special attention. */
252
+ | 'icon-shoppay' /** Shop Pay brand color. Use specifically for Shop Pay related features and branding. */
253
+ | 'icon-static-light' /** Static light icon color. Use for icons on light backgrounds with fixed, non-adaptive coloring. */
254
+ | 'icon-static-dark' /** Static dark icon color. Use for icons on dark backgrounds with fixed, non-adaptive coloring. */
255
+ | 'icon-inactive' /** Inactive icon color. Use for temporarily disabled or inactive interface elements. */
256
+ | 'icon-badge-neutral' /** Neutral badge icon color. Use for general badge icons without specific semantic meaning. */
257
+ | 'icon-search' /** Search icon color. Use specifically for search-related icons and search interface elements. */
258
+ | 'icon-tile-default' /** Default tile icon color. Use for standard tile icons in grid or tile-based layouts. */
259
+ | 'icon-tile-stack' /** Stack tile icon color. Use for grouped or stacked tile icons in organizational views. */
260
+ | 'icon-tile-disabled' /** Disabled tile icon color. Use for inactive or unavailable tile icons in grid layouts. */
261
+ | 'icon-tile-pink' /** Pink tile icon color. Use for color-coded pink category tiles or themed content. */
262
+ | 'icon-tile-purple' /** Purple tile icon color. Use for color-coded purple category tiles or themed content. */
263
+ | 'icon-tile-orange' /** Orange tile icon color. Use for color-coded orange category tiles or themed content. */
264
+ | 'icon-subnavigation-inactive' /** Inactive sub-navigation icon color. Use for unselected items in secondary navigation menus. */
265
+ | 'icon-primary-pressed' /** Pressed primary icon color. Use for the pressed state of primary interactive icons. */;
262
266
 
263
267
  export interface IconProps {
264
268
  /**
265
- * A name used to render the icon.
269
+ * A name used to render the icon. Choose from the available icon set including commerce-specific symbols like `'cart'`, `'payment'`, `'search'`, navigation arrows, and system indicators.
266
270
  */
267
271
  name: IconName | DeprecatedIconName;
268
272
  /**
269
- * Size of the icon.
273
+ * The size of the icon. Use `'s'` for small icons, `'m'` for medium, `'l'` for large (default), or `'xl'` for extra large.
274
+ *
270
275
  * @defaultValue 'l'
271
276
  */
272
277
  size?: IconSize | DeprecatedIconSize;
273
278
  /**
274
- * Color of the icon.
279
+ * The color of the icon. Use semantic tones like `'icon-critical'` for errors, `'icon-warning'` for cautions, `'icon-success'` for confirmations, or contextual tones like `'icon-subdued'` for secondary elements and `'icon-interactive'` for clickable elements.
280
+ *
275
281
  * @defaultValue 'icon-primary'
276
282
  */
277
283
  tone?: IconTone;
@@ -1,11 +1,20 @@
1
1
  import {createRemoteComponent} from '@remote-ui/core';
2
2
 
3
- export type ImageSize = 's' | 'm' | 'l' | 'xl';
3
+ export type ImageSize =
4
+ | 's' /** A small image size. Use for thumbnails, compact layouts, or when minimal space is available for image display. */
5
+ | 'm' /** A medium image size. Use for secondary content, list items, or compact interface elements where space is moderately constrained. */
6
+ | 'l' /** A large image size (default). Provides optimal visibility and balance for most interface elements, product displays, and standard image content. */
7
+ | 'xl' /** An extra large image size. Use for hero images, featured content, or when maximum visual impact and detail visibility are needed. */;
4
8
 
5
9
  /**
6
- * FillResizeMode will apply formatting to the image to fill the container.
10
+ * Defines how images are resized and positioned within their containers. Controls image scaling, cropping, and aspect ratio handling.
7
11
  *
8
- * https://reactnative.dev/docs/image#resizemode
12
+ * Available resize modes:
13
+ * - `center`: Centers the image within its container without scaling. The image maintains its original size and is positioned in the center, potentially leaving empty space or being cropped if the container is smaller.
14
+ * - `contain`: Scales the image to fit entirely within the container while maintaining aspect ratio. The entire image will be visible, but there may be empty space if the aspect ratios don't match.
15
+ * - `cover`: Scales the image to fill the entire container while maintaining aspect ratio. Parts of the image may be cropped if the aspect ratios don't match, but the container will be completely filled.
16
+ * - `repeat`: Repeats the image to fill the container. The image maintains its original size and is tiled both horizontally and vertically to cover the entire container area.
17
+ * - `stretch`: Stretches the image to fill the container completely, potentially distorting the aspect ratio. The image will fill the entire container but may appear stretched or compressed.
9
18
  */
10
19
  export type FillResizeMode =
11
20
  | 'cover'
@@ -16,12 +25,12 @@ export type FillResizeMode =
16
25
 
17
26
  export interface ImageProps {
18
27
  /**
19
- * The source of the image to be displayed.
28
+ * The source of the image to be displayed. Provide a valid URL to a remote image or a local file resource. When no `src` is provided or the image is loading, a placeholder will be rendered.
20
29
  */
21
30
  src?: string;
22
31
 
23
32
  /**
24
- * The size or fill size of the image.
33
+ * The size or fill behavior of the image. Use `ImageSize` values (`'s'`, `'m'`, `'l'`, `'xl'`) for fixed dimensions, or `FillResizeMode` values (`'cover'`, `'contain'`, `'stretch'`, `'repeat'`, `'center'`) to control how the image fills its container.
25
34
  *
26
35
  * @default 'l'
27
36
  */