@shopify/ui-extensions 2023.4.2 → 2023.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 (251) hide show
  1. package/README.md +1 -1
  2. package/build/cjs/surfaces/admin/components/ResourceItem/ResourceItem.js +14 -0
  3. package/build/cjs/surfaces/admin/components/ResourceList/ResourceList.js +15 -0
  4. package/build/cjs/surfaces/admin/components/Thumbnail/Thumbnail.js +12 -0
  5. package/build/cjs/surfaces/admin.js +6 -0
  6. package/build/cjs/surfaces/checkout/extension.js +7 -28
  7. package/build/cjs/surfaces/checkout.js +0 -1
  8. package/build/esm/surfaces/admin/components/ResourceItem/ResourceItem.mjs +10 -0
  9. package/build/esm/surfaces/admin/components/ResourceList/ResourceList.mjs +11 -0
  10. package/build/esm/surfaces/admin/components/Thumbnail/Thumbnail.mjs +8 -0
  11. package/build/esm/surfaces/admin.mjs +3 -0
  12. package/build/esm/surfaces/checkout/extension.mjs +7 -27
  13. package/build/esm/surfaces/checkout.mjs +1 -1
  14. package/build/esnext/surfaces/admin/components/ResourceItem/ResourceItem.esnext +10 -0
  15. package/build/esnext/surfaces/admin/components/ResourceList/ResourceList.esnext +11 -0
  16. package/build/esnext/surfaces/admin/components/Thumbnail/Thumbnail.esnext +8 -0
  17. package/build/esnext/surfaces/admin.esnext +3 -0
  18. package/build/esnext/surfaces/checkout/extension.esnext +7 -27
  19. package/build/esnext/surfaces/checkout.esnext +1 -1
  20. package/build/ts/api.d.ts +0 -15
  21. package/build/ts/api.d.ts.map +1 -1
  22. package/build/ts/extension.d.ts +0 -3
  23. package/build/ts/extension.d.ts.map +1 -1
  24. package/build/ts/surfaces/admin/api/action/action.d.ts +5 -2
  25. package/build/ts/surfaces/admin/api/action/action.d.ts.map +1 -1
  26. package/build/ts/surfaces/admin/api/block/block.d.ts +10 -0
  27. package/build/ts/surfaces/admin/api/block/block.d.ts.map +1 -0
  28. package/build/ts/surfaces/admin/api/block/block.doc.d.ts +4 -0
  29. package/build/ts/surfaces/admin/api/block/block.doc.d.ts.map +1 -0
  30. package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts +45 -0
  31. package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts.map +1 -0
  32. package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts +46 -0
  33. package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts.map +1 -0
  34. package/build/ts/surfaces/admin/api/shared.d.ts +9 -0
  35. package/build/ts/surfaces/admin/api/shared.d.ts.map +1 -0
  36. package/build/ts/surfaces/admin/api/standard/standard.d.ts +18 -2
  37. package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
  38. package/build/ts/surfaces/admin/api.d.ts +4 -1
  39. package/build/ts/surfaces/admin/api.d.ts.map +1 -1
  40. package/build/ts/surfaces/admin/components/Checkbox/Checkbox.doc.d.ts.map +1 -1
  41. package/build/ts/surfaces/admin/components/Form/Form.d.ts +0 -10
  42. package/build/ts/surfaces/admin/components/Form/Form.d.ts.map +1 -1
  43. package/build/ts/surfaces/admin/components/Form/Form.doc.d.ts.map +1 -1
  44. package/build/ts/surfaces/admin/components/HeadingGroup/HeadingGroup.doc.d.ts.map +1 -1
  45. package/build/ts/surfaces/admin/components/ResourceItem/ResourceItem.d.ts +17 -0
  46. package/build/ts/surfaces/admin/components/ResourceItem/ResourceItem.d.ts.map +1 -0
  47. package/build/ts/surfaces/admin/components/ResourceList/ResourceList.d.ts +26 -0
  48. package/build/ts/surfaces/admin/components/ResourceList/ResourceList.d.ts.map +1 -0
  49. package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
  50. package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.d.ts +19 -0
  51. package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.d.ts.map +1 -0
  52. package/build/ts/surfaces/admin/components.d.ts +6 -0
  53. package/build/ts/surfaces/admin/components.d.ts.map +1 -1
  54. package/build/ts/surfaces/admin/extension-targets.d.ts +10 -4
  55. package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
  56. package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts +9 -0
  57. package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts.map +1 -0
  58. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +67 -1
  59. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
  60. package/build/ts/surfaces/checkout/api/{payment-method/render.d.ts → payment/payment-option-item.d.ts} +2 -2
  61. package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts.map +1 -0
  62. package/build/ts/surfaces/checkout/api/pickup/{pickup-points.d.ts → pickup-location-list.d.ts} +3 -3
  63. package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts.map +1 -0
  64. package/build/ts/surfaces/checkout/api/pickup/{pickup-locations.d.ts → pickup-point-list.d.ts} +3 -3
  65. package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts.map +1 -0
  66. package/build/ts/surfaces/checkout/api/redeemable/{render.d.ts → redeemable.d.ts} +2 -2
  67. package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts.map +1 -0
  68. package/build/ts/surfaces/checkout/api/shared.d.ts +91 -1
  69. package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
  70. package/build/ts/surfaces/checkout/api/shipping/{shipping-method-details.d.ts → shipping-option-item.d.ts} +4 -4
  71. package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -0
  72. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +171 -171
  73. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  74. package/build/ts/surfaces/checkout/api.d.ts +9 -9
  75. package/build/ts/surfaces/checkout/api.d.ts.map +1 -1
  76. package/build/ts/surfaces/checkout/components/PhoneField/PhoneField.d.ts +1 -1
  77. package/build/ts/surfaces/checkout/components/TextField/TextField.d.ts +1 -1
  78. package/build/ts/surfaces/checkout/components/shared.d.ts +11 -2
  79. package/build/ts/surfaces/checkout/components/shared.d.ts.map +1 -1
  80. package/build/ts/surfaces/checkout/extension.d.ts +7 -28
  81. package/build/ts/surfaces/checkout/extension.d.ts.map +1 -1
  82. package/build/ts/surfaces/checkout/globals.d.ts +2 -2
  83. package/build/ts/surfaces/checkout/globals.d.ts.map +1 -1
  84. package/build/ts/surfaces/checkout/targets.d.ts +411 -0
  85. package/build/ts/surfaces/checkout/targets.d.ts.map +1 -0
  86. package/build/ts/surfaces/checkout.d.ts +1 -1
  87. package/build/ts/surfaces/checkout.d.ts.map +1 -1
  88. package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts +9 -0
  89. package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts.map +1 -0
  90. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +1212 -0
  91. package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -0
  92. package/build/ts/surfaces/customer-account/api/shared.d.ts +126 -0
  93. package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -0
  94. package/build/ts/surfaces/customer-account/api.d.ts +4 -0
  95. package/build/ts/surfaces/customer-account/api.d.ts.map +1 -0
  96. package/build/ts/surfaces/customer-account/extension.d.ts +16 -0
  97. package/build/ts/surfaces/customer-account/extension.d.ts.map +1 -0
  98. package/build/ts/surfaces/customer-account/globals.d.ts +11 -0
  99. package/build/ts/surfaces/customer-account/globals.d.ts.map +1 -0
  100. package/build/ts/surfaces/customer-account/targets.d.ts +78 -0
  101. package/build/ts/surfaces/customer-account/targets.d.ts.map +1 -0
  102. package/build/ts/surfaces/customer-account.d.ts +8 -0
  103. package/build/ts/surfaces/customer-account.d.ts.map +1 -0
  104. package/build/ts/utilities/registration.d.ts +5 -5
  105. package/build/ts/utilities/registration.d.ts.map +1 -1
  106. package/build/tsconfig.tsbuildinfo +1 -1
  107. package/package.json +17 -8
  108. package/src/api.ts +0 -18
  109. package/src/extension.ts +0 -4
  110. package/src/surfaces/admin/api/action/action.ts +6 -4
  111. package/src/surfaces/admin/api/block/block.doc.ts +20 -0
  112. package/src/surfaces/admin/api/block/block.ts +11 -0
  113. package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts +49 -0
  114. package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts +50 -0
  115. package/src/surfaces/admin/api/shared.ts +6 -0
  116. package/src/surfaces/admin/api/standard/standard.ts +20 -8
  117. package/src/surfaces/admin/api.ts +4 -1
  118. package/src/surfaces/admin/components/Checkbox/Checkbox.doc.ts +1 -7
  119. package/src/surfaces/admin/components/Form/Form.doc.ts +0 -5
  120. package/src/surfaces/admin/components/Form/Form.ts +0 -12
  121. package/src/surfaces/admin/components/HeadingGroup/HeadingGroup.doc.ts +0 -7
  122. package/src/surfaces/admin/components/ResourceItem/ResourceItem.ts +19 -0
  123. package/src/surfaces/admin/components/ResourceItem/examples/basic-ResourceItem.example.ts +22 -0
  124. package/src/surfaces/admin/components/ResourceList/ResourceList.ts +30 -0
  125. package/src/surfaces/admin/components/ResourceList/examples/basic-ResourceList.example.ts +29 -0
  126. package/src/surfaces/admin/components/Select/Select.doc.ts +1 -7
  127. package/src/surfaces/admin/components/Thumbnail/Thumbnail.ts +31 -0
  128. package/src/surfaces/admin/components/Thumbnail/examples/basic-Thumbnail.example.ts +13 -0
  129. package/src/surfaces/admin/components.ts +6 -0
  130. package/src/surfaces/admin/extension-targets.ts +38 -3
  131. package/src/surfaces/checkout/api/cart-line/cart-line-item.ts +10 -0
  132. package/src/surfaces/checkout/api/checkout/checkout.ts +83 -1
  133. package/src/surfaces/checkout/api/{payment-method/render.ts → payment/payment-option-item.ts} +1 -1
  134. package/src/surfaces/checkout/api/pickup/{pickup-points.ts → pickup-location-list.ts} +2 -2
  135. package/src/surfaces/checkout/api/pickup/{pickup-locations.ts → pickup-point-list.ts} +2 -2
  136. package/src/surfaces/checkout/api/redeemable/{render.ts → redeemable.ts} +1 -1
  137. package/src/surfaces/checkout/api/shared.ts +103 -0
  138. package/src/surfaces/checkout/api/shipping/{shipping-method-details.ts → shipping-option-item.ts} +3 -3
  139. package/src/surfaces/checkout/api/standard/README.md +12 -10
  140. package/src/surfaces/checkout/api/standard/standard.ts +180 -187
  141. package/src/surfaces/checkout/api.ts +18 -10
  142. package/src/surfaces/checkout/components/Banner/examples/basic-banner.example.ts +1 -1
  143. package/src/surfaces/checkout/components/BlockLayout/examples/basic-blockLayout.example.ts +1 -1
  144. package/src/surfaces/checkout/components/BlockLayout/examples/basic-blocklayout.example.ts +1 -1
  145. package/src/surfaces/checkout/components/BlockSpacer/examples/basic-blockspacer.example.ts +1 -1
  146. package/src/surfaces/checkout/components/BlockStack/examples/basic-blockstack.example.ts +1 -1
  147. package/src/surfaces/checkout/components/Button/examples/basic-button.example.ts +1 -1
  148. package/src/surfaces/checkout/components/Checkbox/examples/basic-checkbox.example.ts +1 -1
  149. package/src/surfaces/checkout/components/Choice/examples/basic-choice.example.ts +1 -1
  150. package/src/surfaces/checkout/components/ChoiceList/examples/basic-choicelist.example.ts +1 -1
  151. package/src/surfaces/checkout/components/DateField/examples/basic-datefield.example.ts +1 -1
  152. package/src/surfaces/checkout/components/DatePicker/examples/basic-datepicker.example.ts +1 -1
  153. package/src/surfaces/checkout/components/Disclosure/examples/basic-disclosure.example.ts +1 -1
  154. package/src/surfaces/checkout/components/Divider/examples/basic-divider.example.ts +1 -1
  155. package/src/surfaces/checkout/components/Form/examples/basic-form.example.ts +1 -1
  156. package/src/surfaces/checkout/components/Grid/examples/basic-grid.example.ts +1 -1
  157. package/src/surfaces/checkout/components/GridItem/examples/basic-griditem.example.ts +1 -1
  158. package/src/surfaces/checkout/components/Heading/examples/basic-heading.example.ts +1 -1
  159. package/src/surfaces/checkout/components/HeadingGroup/examples/basic-headinggroup.example.ts +1 -1
  160. package/src/surfaces/checkout/components/Icon/examples/basic-icon.example.ts +1 -1
  161. package/src/surfaces/checkout/components/Image/examples/basic-image.example.ts +1 -1
  162. package/src/surfaces/checkout/components/InlineLayout/examples/basic-inlineLayout.example.ts +1 -1
  163. package/src/surfaces/checkout/components/InlineLayout/examples/basic-inlinelayout.example.ts +1 -1
  164. package/src/surfaces/checkout/components/InlineSpacer/examples/basic-inlinespacer.example.ts +1 -1
  165. package/src/surfaces/checkout/components/InlineStack/examples/basic-inlinestack.example.ts +1 -1
  166. package/src/surfaces/checkout/components/Link/examples/basic-link.example.ts +1 -1
  167. package/src/surfaces/checkout/components/List/examples/basic-list.example.ts +1 -1
  168. package/src/surfaces/checkout/components/ListItem/examples/basic-listitem.example.ts +1 -1
  169. package/src/surfaces/checkout/components/Modal/examples/basic-modal.example.ts +1 -1
  170. package/src/surfaces/checkout/components/PhoneField/PhoneField.ts +1 -1
  171. package/src/surfaces/checkout/components/PhoneField/examples/basic-phonefield.example.ts +1 -1
  172. package/src/surfaces/checkout/components/Popover/examples/basic-popover.example.ts +1 -1
  173. package/src/surfaces/checkout/components/Pressable/examples/basic-pressable.example.ts +1 -1
  174. package/src/surfaces/checkout/components/ScrollView/examples/basic-scrollview.example.ts +1 -1
  175. package/src/surfaces/checkout/components/Select/examples/basic-select.example.ts +1 -1
  176. package/src/surfaces/checkout/components/SkeletonImage/examples/basic-skeletonimage.example.ts +1 -1
  177. package/src/surfaces/checkout/components/SkeletonText/examples/basic-skeletontext.example.ts +1 -1
  178. package/src/surfaces/checkout/components/SkeletonTextBlock/examples/basic-skeletontextblock.example.ts +1 -1
  179. package/src/surfaces/checkout/components/Spinner/examples/basic-spinner.example.ts +1 -1
  180. package/src/surfaces/checkout/components/Stepper/examples/basic-stepper.example.ts +1 -1
  181. package/src/surfaces/checkout/components/Tag/examples/basic-tag.example.ts +1 -1
  182. package/src/surfaces/checkout/components/Text/examples/basic-text.example.ts +1 -1
  183. package/src/surfaces/checkout/components/TextBlock/examples/basic-textblock.example.ts +1 -1
  184. package/src/surfaces/checkout/components/TextField/TextField.ts +1 -1
  185. package/src/surfaces/checkout/components/TextField/examples/basic-textfield.example.ts +1 -1
  186. package/src/surfaces/checkout/components/Tooltip/examples/basic-tooltip.example.ts +1 -1
  187. package/src/surfaces/checkout/components/View/examples/basic-view.example.ts +1 -1
  188. package/src/surfaces/checkout/components/shared.ts +22 -5
  189. package/src/surfaces/checkout/extension.ts +10 -56
  190. package/src/surfaces/checkout/globals.ts +7 -4
  191. package/src/surfaces/checkout/style/examples/style.example.ts +1 -1
  192. package/src/surfaces/checkout/style/examples/style.example.tsx +8 -2
  193. package/src/surfaces/checkout/targets.ts +701 -0
  194. package/src/surfaces/checkout.ts +1 -1
  195. package/src/surfaces/customer-account/api/cart-line/cart-line-item.ts +10 -0
  196. package/src/surfaces/customer-account/api/order-status/order-status.ts +1414 -0
  197. package/src/surfaces/customer-account/api/shared.ts +953 -0
  198. package/src/surfaces/customer-account/api.ts +66 -0
  199. package/src/surfaces/customer-account/extension.ts +21 -0
  200. package/src/surfaces/customer-account/globals.ts +18 -0
  201. package/src/surfaces/customer-account/targets.ts +116 -0
  202. package/src/surfaces/customer-account.ts +8 -0
  203. package/src/utilities/registration.ts +13 -12
  204. package/build/ts/surfaces/checkout/api/cart-line/cart-line-details.d.ts +0 -9
  205. package/build/ts/surfaces/checkout/api/cart-line/cart-line-details.d.ts.map +0 -1
  206. package/build/ts/surfaces/checkout/api/payment-method/render.d.ts.map +0 -1
  207. package/build/ts/surfaces/checkout/api/pickup/pickup-locations.d.ts.map +0 -1
  208. package/build/ts/surfaces/checkout/api/pickup/pickup-points.d.ts.map +0 -1
  209. package/build/ts/surfaces/checkout/api/redeemable/render.d.ts.map +0 -1
  210. package/build/ts/surfaces/checkout/api/shipping/shipping-method-details.d.ts.map +0 -1
  211. package/build/ts/surfaces/checkout/extension-points.d.ts +0 -220
  212. package/build/ts/surfaces/checkout/extension-points.d.ts.map +0 -1
  213. package/src/surfaces/checkout/api/cart-line/cart-line-details.ts +0 -10
  214. package/src/surfaces/checkout/components/Banner/README.md +0 -14
  215. package/src/surfaces/checkout/components/BlockLayout/README.md +0 -101
  216. package/src/surfaces/checkout/components/BlockSpacer/README.md +0 -14
  217. package/src/surfaces/checkout/components/BlockStack/README.md +0 -77
  218. package/src/surfaces/checkout/components/Button/README.md +0 -22
  219. package/src/surfaces/checkout/components/Checkbox/README.md +0 -18
  220. package/src/surfaces/checkout/components/Choice/README.md +0 -14
  221. package/src/surfaces/checkout/components/ChoiceList/README.md +0 -14
  222. package/src/surfaces/checkout/components/Divider/README.md +0 -13
  223. package/src/surfaces/checkout/components/Form/README.md +0 -21
  224. package/src/surfaces/checkout/components/Grid/README.md +0 -105
  225. package/src/surfaces/checkout/components/GridItem/README.md +0 -72
  226. package/src/surfaces/checkout/components/Heading/README.md +0 -19
  227. package/src/surfaces/checkout/components/HeadingGroup/README.md +0 -7
  228. package/src/surfaces/checkout/components/Icon/README.md +0 -15
  229. package/src/surfaces/checkout/components/Image/README.md +0 -53
  230. package/src/surfaces/checkout/components/InlineLayout/README.md +0 -103
  231. package/src/surfaces/checkout/components/InlineSpacer/README.md +0 -14
  232. package/src/surfaces/checkout/components/InlineStack/README.md +0 -87
  233. package/src/surfaces/checkout/components/Link/README.md +0 -18
  234. package/src/surfaces/checkout/components/List/README.md +0 -19
  235. package/src/surfaces/checkout/components/ListItem/README.md +0 -5
  236. package/src/surfaces/checkout/components/PhoneField/README.md +0 -49
  237. package/src/surfaces/checkout/components/Pressable/README.md +0 -74
  238. package/src/surfaces/checkout/components/ScrollView/README.md +0 -62
  239. package/src/surfaces/checkout/components/Select/README.md +0 -41
  240. package/src/surfaces/checkout/components/SkeletonImage/README.md +0 -13
  241. package/src/surfaces/checkout/components/SkeletonText/README.md +0 -13
  242. package/src/surfaces/checkout/components/SkeletonTextBlock/README.md +0 -13
  243. package/src/surfaces/checkout/components/Spinner/README.md +0 -14
  244. package/src/surfaces/checkout/components/Stepper/README.md +0 -28
  245. package/src/surfaces/checkout/components/Tag/README.md +0 -14
  246. package/src/surfaces/checkout/components/Text/README.md +0 -17
  247. package/src/surfaces/checkout/components/TextBlock/README.md +0 -15
  248. package/src/surfaces/checkout/components/TextField/README.md +0 -49
  249. package/src/surfaces/checkout/components/Tooltip/README.md +0 -8
  250. package/src/surfaces/checkout/components/View/README.md +0 -97
  251. package/src/surfaces/checkout/extension-points.ts +0 -369
@@ -1,72 +0,0 @@
1
- # GridItem
2
-
3
- GridItem can be used as children of Grid.
4
-
5
- It offers a way to span the element across a number of columns and rows.
6
-
7
- ## Props
8
-
9
- optional = ?
10
-
11
- | Name | Type | Description |
12
- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | columnSpan? | <code>number &#124; ConditionalStyle<<wbr>number, AcceptedConditions<wbr>></code> | Number of columns the item will span across |
14
- | rowSpan? | <code>number &#124; ConditionalStyle<<wbr>number, AcceptedConditions<wbr>></code> | Number of rows the item will span across |
15
- | accessibilityRole? | <code><a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a> &#124; [<a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>, <a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>]</code> | Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.<br /><br />For example:<br /><br />- In an HTML host a `['listItem', 'separator']` tuple will render: &lt;li role='separator'&gt;<br /><br />- In an HTML host a `listItem` string will render: &lt;li&gt; |
16
- | border? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border style.<br /><br />To shorten the code, it is possible to specify all the border style properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border styles are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border styles are `base`, inlineStart and inlineEnd border styles are `none`<br /><br />- `['base', 'none', 'dotted', 'base']` means blockStart border style is `base`, inlineEnd border style is `none`, blockEnd border style is `dotted` and blockStart border style is `base` |
17
- | borderWidth? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border width.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border widths are `base`<br /><br />- `['base', 'medium']` means blockStart and blockEnd border widths are `base`, inlineStart and inlineEnd border widths are `medium`<br /><br />- `['base', 'medium', 'medium', 'base']` means blockStart border width is `base`, inlineEnd border width is `medium`, blockEnd border width is `medium` and blockStart border width is `base` |
18
- | borderRadius? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border radius.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border radii are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border radii are `base`, inlineStart and inlineEnd border radii are `none`<br /><br />- `['base', 'none', 'tight', 'base']` means blockStart border radius is `base`, inlineEnd border radius is `none`, blockEnd border radius is `tight` and blockStart border radius is `base` |
19
- | maxBlockSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the maximum block size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
20
- | maxInlineSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the maximum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
21
- | minInlineSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the minimum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
22
- | minBlockSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the block size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
23
- | padding? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the padding.<br /><br />To shorten the code, it is possible to specify all the padding properties in one property.<br /><br />Examples:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart paddings are `base`<br /><br />- [`base`, `none`] means blockStart and blockEnd paddings are `base`, inlineStart and inlineEnd paddings are `none`<br /><br />- [`base`, `none`, `loose`, `tight`] means blockStart padding is `base`, inlineEnd padding is `none`, blockEnd padding is `loose` and blockStart padding is `tight` |
24
-
25
- <a name="Spacing"></a>
26
-
27
- ### Spacing
28
-
29
- <code>"none" &#124; "extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose"</code>
30
- <a name="BorderRadius"></a>
31
-
32
- ### BorderRadius
33
-
34
- <code>"base" &#124; "tight" &#124; "loose" &#124; "fullyRounded" &#124; "none"</code>
35
- <a name="BorderWidth"></a>
36
-
37
- ### BorderWidth
38
-
39
- <code>"base" &#124; "medium"</code>
40
- <a name="MaybeShorthandProperty"></a>
41
-
42
- ### MaybeShorthandProperty
43
-
44
- <code>T &#124; <a href="#shorthandproperty">ShorthandProperty</a><<wbr>T<wbr>></code>
45
- <a name="ShorthandProperty"></a>
46
-
47
- ### ShorthandProperty
48
-
49
- <code>[T, T] &#124; [T, T, T, T]</code>
50
- <a name="BorderStyle"></a>
51
-
52
- ### BorderStyle
53
-
54
- <code>"base" &#124; "dotted" &#124; "none"</code>
55
- <a name="NonPresentationalAccessibilityRole"></a>
56
-
57
- ### NonPresentationalAccessibilityRole
58
-
59
- | Value | Description |
60
- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
61
- | <code>"main"</code> | Used to indicate the primary content. |
62
- | <code>"header"</code> | Used to indicate the component is a header. |
63
- | <code>"footer"</code> | Used to display information such as copyright information, navigation links, and privacy statements. |
64
- | <code>"section"</code> | Used to indicate a generic section. |
65
- | <code>"complementary"</code> | Used to designate a supporting section that relates to the main content. |
66
- | <code>"navigation"</code> | Used to identify major groups of links used for navigating. |
67
- | <code>"orderedList"</code> | Used to identify a list of ordered items. |
68
- | <code>"listItem"</code> | Used to identify an item inside a list of items. |
69
- | <code>"unorderedList"</code> | Used to identify a list of unordered items. |
70
- | <code>"separator"</code> | Used to indicates the component acts as a divider that separates and distinguishes sections of content. |
71
- | <code>"status"</code> | Used to define a live region containing advisory information for the user that is not important enough to be an alert. |
72
- | <code>"alert"</code> | Used for important, and usually time-sensitive, information. |
@@ -1,19 +0,0 @@
1
- # Heading
2
-
3
- Headings control the visual style of headings. Use headings to introduce major
4
- sections, like Contact information, Shipping address, or Shipping method.
5
-
6
- Unlike HTML headings, you don’t explicitly specify the position of the heading in the
7
- document outline. Nest headings within the heading group component to control
8
- the document outline structure used by assistive technologies.
9
-
10
- ## Props
11
-
12
- optional = ?
13
-
14
- | Name | Type | Description |
15
- | ------------------ | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | id? | <code>string</code> | Unique identifier. Typically used to make the heading a target that another component can refer to in order to provide an alternative accessibility label. |
17
- | level? | <code>1 &#124; 2 &#124; 3</code> | The visual level of the heading. When not set, the heading will use its “automatic” heading level, which is determined by the level of nesting within ancestor `HeadingGroup`s. No matter what value you provide here, the semantic level (e.g., how the heading contributes to the document outline) is determined exclusively by the “automatic” heading level. |
18
- | accessibilityRole? | <code>"presentation"</code> | Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.<br /><br /><code>"presentation"</code>: Used to strip the semantic meaning of an element, but leave the visual styling intact. |
19
- | inlineAlignment? | <code>"start" &#124; "center" &#124; "end"</code> | Align text along the main axis. |
@@ -1,7 +0,0 @@
1
- # HeadingGroup
2
-
3
- Heading group controls the heading level of headings nested within it, like H1, H2, H3.
4
-
5
- Use a heading group whenever you use a heading to ensure the experience is the same
6
- for screen reader users. When using a heading, any children related to that
7
- heading should be nested within the same heading group.
@@ -1,15 +0,0 @@
1
- # Icon
2
-
3
- Icons are pictograms or graphic symbols.
4
- They can act as wayfinding tools or as a means of communicating functionality.
5
-
6
- ## Props
7
-
8
- optional = ?
9
-
10
- | Name | Type | Description |
11
- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
12
- | accessibilityLabel? | <code>string</code> | A label that describes the purpose or contents of the icon. When set, it will be announced to buyers using assistive technologies and will provide them with more context. |
13
- | appearance? | <code>"accent" &#124; "interactive" &#124; "subdued" &#124; "info" &#124; "success" &#124; "warning" &#124; "critical" &#124; "monochrome"</code> | Sets the appearance (color) of the icon.<br /><br />By default the icon will inherit the color of its parent.<br /><br /><code>"accent"</code>: Use to convey emphasis and draw attention to the icon.<br /><br /><code>"interactive"</code>: Use to convey that the icon is pressable, hoverable or otherwise interactive.<br /><br /><code>"subdued"</code>: Use to convey a subdued or disabled state for the icon.<br /><br /><code>"info"</code>: Use to convey icon is informative or has information.<br /><br /><code>"success"</code>: Use to convey a successful interaction.<br /><br /><code>"warning"</code>: Use to convey something needs attention or an action needs to be taken.<br /><br /><code>"critical"</code>: Use to convey a problem has arisen.<br /><br /><code>"monochrome"</code>: Will take the color of its parent<br /><br />Default value: <code>'monochrome'</code> |
14
- | size? | <code>"extraSmall" &#124; "small" &#124; "base" &#124; "large" &#124; "fill"</code> | Adjusts the size of the icon.<br /><br />Default value: <code>'base'</code> |
15
- | source | <code>"arrowLeft" &#124; "arrowRight" &#124; "arrowUp" &#124; "arrowUpRight" &#124; "arrowDown" &#124; "bag" &#124; "calendar" &#124; "camera" &#124; "caretDown" &#124; "cart" &#124; "checkmark" &#124; "chevronDown" &#124; "chevronUp" &#124; "chevronRight" &#124; "chevronLeft" &#124; "close" &#124; "critical" &#124; "discount" &#124; "delivered" &#124; "delivery" &#124; "disabled" &#124; "email" &#124; "errorFill" &#124; "geolocation" &#124; "grid" &#124; "hamburger" &#124; "horizontalDots" &#124; "info" &#124; "infoFill" &#124; "list" &#124; "lock" &#124; "magnify" &#124; "map" &#124; "marker" &#124; "minus" &#124; "mobile" &#124; "note" &#124; "pen" &#124; "verticalDots" &#124; "plus" &#124; "questionFill" &#124; "reorder" &#124; "store" &#124; "success" &#124; "truck" &#124; "warning" &#124; "warningFill" &#124; "giftFill" &#124; "external" &#124; "profile"</code> | Specifies which icon to display |
@@ -1,53 +0,0 @@
1
- # Image
2
-
3
- Image is used for large format, responsive images.
4
-
5
- ## Props
6
-
7
- optional = ?
8
-
9
- | Name | Type | Description |
10
- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | source | <code>Required<<wbr>string &#124; ConditionalStyle<<wbr>string, AcceptedConditions<wbr>><wbr>></code> | The URL or path to the image. Supports the `resolution` and `viewportInlineSize` conditional styles only. |
12
- | accessibilityDescription? | <code>string</code> | An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both buyers using assistive technology and sighted buyers. A well written `description` provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `Image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `description` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://ux.shopify.com/considerations-when-writing-alt-text-a9c1985a8204) to learn more.<br /><br />Default value: <code>''</code> |
13
- | loading? | <code>"eager" &#124; "lazy"</code> | Indicates how the browser should load the image, either eager or lazy.<br /><br />Uses native browser behavior and is not supported by all browsers. If no value is provided then the image is loaded immediately, regardless of whether or not the image is currently within the visible viewport.<br /><br /><code>"eager"</code>: Image is loaded immediately, regardless of whether or not the image is currently within the visible viewport.<br /><br /><code>"lazy"</code>: Image is loaded when it’s within the visible viewport. |
14
- | aspectRatio? | <code>number</code> | Displays the image at the specified aspect ratio (fills the width of the parent container and sets the height accordingly) and creates an invisible placeholder to prevent content jumping when the image loads. Use along with `fit` if the specified aspect ratio does not match the intrinsic aspect ratio to prevent the image from stretching. |
15
- | fit? | <code><a href="#fit">Fit</a> &#124; ConditionalStyle<<wbr><a href="#fit">Fit</a>, AcceptedConditions<wbr>></code> | Indicates how the image fits in its frame. Use if the image is not displayed at its intrinsic size to maintain the aspect ratio. |
16
- | accessibilityRole? | <code>"decorative"</code> | Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.<br /><br /><code>"decorative"</code>: Used to indicate that an image is decorative and should be hidden from assistive technologies. |
17
- | border? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border style.<br /><br />To shorten the code, it is possible to specify all the border style properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border styles are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border styles are `base`, inlineStart and inlineEnd border styles are `none`<br /><br />- `['base', 'none', 'dotted', 'base']` means blockStart border style is `base`, inlineEnd border style is `none`, blockEnd border style is `dotted` and blockStart border style is `base` |
18
- | borderWidth? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border width.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border widths are `base`<br /><br />- `['base', 'medium']` means blockStart and blockEnd border widths are `base`, inlineStart and inlineEnd border widths are `medium`<br /><br />- `['base', 'medium', 'medium', 'base']` means blockStart border width is `base`, inlineEnd border width is `medium`, blockEnd border width is `medium` and blockStart border width is `base` |
19
- | borderRadius? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border radius.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border radii are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border radii are `base`, inlineStart and inlineEnd border radii are `none`<br /><br />- `['base', 'none', 'tight', 'base']` means blockStart border radius is `base`, inlineEnd border radius is `none`, blockEnd border radius is `tight` and blockStart border radius is `base` |
20
-
21
- <a name="BorderRadius"></a>
22
-
23
- ### BorderRadius
24
-
25
- <code>"base" &#124; "tight" &#124; "loose" &#124; "fullyRounded" &#124; "none"</code>
26
- <a name="BorderWidth"></a>
27
-
28
- ### BorderWidth
29
-
30
- <code>"base" &#124; "medium"</code>
31
- <a name="MaybeShorthandProperty"></a>
32
-
33
- ### MaybeShorthandProperty
34
-
35
- <code>T &#124; <a href="#shorthandproperty">ShorthandProperty</a><<wbr>T<wbr>></code>
36
- <a name="ShorthandProperty"></a>
37
-
38
- ### ShorthandProperty
39
-
40
- <code>[T, T] &#124; [T, T, T, T]</code>
41
- <a name="BorderStyle"></a>
42
-
43
- ### BorderStyle
44
-
45
- <code>"base" &#124; "dotted" &#124; "none"</code>
46
- <a name="Fit"></a>
47
-
48
- ### Fit
49
-
50
- | Value | Description |
51
- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------- |
52
- | <code>"cover"</code> | Image maintains its aspect ratio while fitting within the frame. |
53
- | <code>"contain"</code> | Image maintains its aspect ratio while filling the frame. If the image is larger than the frame, then it will be cropped. |
@@ -1,103 +0,0 @@
1
- # InlineLayout
2
-
3
- InlineLayout is used to lay out content over multiple columns.
4
-
5
- By default, all columns are of equal size and fill the available inline space.
6
- Content does not wrap on new rows when not enough columns have been explicitly set,
7
- instead they are added as new column and fill the remaining inline space.
8
-
9
- ## Props
10
-
11
- optional = ?
12
-
13
- | Name | Type | Description |
14
- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
- | columns? | <code><a href="#columns">Columns</a> &#124; ConditionalStyle<<wbr><a href="#columns">Columns</a>, AcceptedConditions<wbr>></code> | Sizes for each column of the layout.<br /><br />`auto`: intrinsic size of the element.<br /><br />`fill`: fills the remaining available space. When multiple elements are set to `fill`, the remaining space is shared equally.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`` `${number}fr` ``: size in fractions.<br /><br />`number`: size in pixels.<br /><br />- When the sum of the defined sizes is larger than the available space, elements will shrink to avoid overflow.<br /><br />- When the size of an element is not explicitly set, it will fill the remaining space available.<br /><br />- When only one size is set and outside of an array, all elements of the layout will take that size.<br /><br />Default value: <code>'fill'</code> |
16
- | spacing? | <code><a href="#spacing">Spacing</a> &#124; [<a href="#spacing">Spacing</a>, <a href="#spacing">Spacing</a>] &#124; ConditionalStyle<<wbr><a href="#spacing">Spacing</a> &#124; [<a href="#spacing">Spacing</a>, <a href="#spacing">Spacing</a>], AcceptedConditions<wbr>></code> | Adjust spacing between children.<br /><br />- `base` means the space between rows and columns is `base`.<br /><br />- [`base`, `none`] means the space between rows is `base`, space between columns is `none`.<br /><br />Default value: <code>'none'</code> |
17
- | blockAlignment? | <code><a href="#blockalignment">BlockAlignment</a> &#124; ConditionalStyle<<wbr><a href="#blockalignment">BlockAlignment</a>, AcceptedConditions<wbr>></code> | Position children along the cross axis. |
18
- | inlineAlignment? | <code><a href="#inlinealignment">InlineAlignment</a> &#124; ConditionalStyle<<wbr><a href="#inlinealignment">InlineAlignment</a>, AcceptedConditions<wbr>></code> | Position children along the main axis. |
19
- | accessibilityRole? | <code><a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a> &#124; [<a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>, <a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>]</code> | Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.<br /><br />For example:<br /><br />- In an HTML host a `['listItem', 'separator']` tuple will render: &lt;li role='separator'&gt;<br /><br />- In an HTML host a `listItem` string will render: &lt;li&gt; |
20
- | accessibilityLabel? | <code>string</code> | A label that describes the purpose or contents of the element. When set, it will be announced to buyers using assistive technologies and will provide them with more context. |
21
- | border? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border style.<br /><br />To shorten the code, it is possible to specify all the border style properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border styles are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border styles are `base`, inlineStart and inlineEnd border styles are `none`<br /><br />- `['base', 'none', 'dotted', 'base']` means blockStart border style is `base`, inlineEnd border style is `none`, blockEnd border style is `dotted` and blockStart border style is `base` |
22
- | borderWidth? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border width.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border widths are `base`<br /><br />- `['base', 'medium']` means blockStart and blockEnd border widths are `base`, inlineStart and inlineEnd border widths are `medium`<br /><br />- `['base', 'medium', 'medium', 'base']` means blockStart border width is `base`, inlineEnd border width is `medium`, blockEnd border width is `medium` and blockStart border width is `base` |
23
- | borderRadius? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border radius.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border radii are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border radii are `base`, inlineStart and inlineEnd border radii are `none`<br /><br />- `['base', 'none', 'tight', 'base']` means blockStart border radius is `base`, inlineEnd border radius is `none`, blockEnd border radius is `tight` and blockStart border radius is `base` |
24
- | maxBlockSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the maximum block size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
25
- | maxInlineSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the maximum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
26
- | minInlineSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the minimum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
27
- | minBlockSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the block size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
28
- | padding? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the padding.<br /><br />To shorten the code, it is possible to specify all the padding properties in one property.<br /><br />Examples:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart paddings are `base`<br /><br />- [`base`, `none`] means blockStart and blockEnd paddings are `base`, inlineStart and inlineEnd paddings are `none`<br /><br />- [`base`, `none`, `loose`, `tight`] means blockStart padding is `base`, inlineEnd padding is `none`, blockEnd padding is `loose` and blockStart padding is `tight` |
29
-
30
- <a name="BorderRadius"></a>
31
-
32
- ### BorderRadius
33
-
34
- <code>"base" &#124; "tight" &#124; "loose" &#124; "fullyRounded" &#124; "none"</code>
35
- <a name="BorderWidth"></a>
36
-
37
- ### BorderWidth
38
-
39
- <code>"base" &#124; "medium"</code>
40
- <a name="MaybeShorthandProperty"></a>
41
-
42
- ### MaybeShorthandProperty
43
-
44
- <code>T &#124; <a href="#shorthandproperty">ShorthandProperty</a><<wbr>T<wbr>></code>
45
- <a name="ShorthandProperty"></a>
46
-
47
- ### ShorthandProperty
48
-
49
- <code>[T, T] &#124; [T, T, T, T]</code>
50
- <a name="BorderStyle"></a>
51
-
52
- ### BorderStyle
53
-
54
- <code>"base" &#124; "dotted" &#124; "none"</code>
55
- <a name="NonPresentationalAccessibilityRole"></a>
56
-
57
- ### NonPresentationalAccessibilityRole
58
-
59
- | Value | Description |
60
- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
61
- | <code>"main"</code> | Used to indicate the primary content. |
62
- | <code>"header"</code> | Used to indicate the component is a header. |
63
- | <code>"footer"</code> | Used to display information such as copyright information, navigation links, and privacy statements. |
64
- | <code>"section"</code> | Used to indicate a generic section. |
65
- | <code>"complementary"</code> | Used to designate a supporting section that relates to the main content. |
66
- | <code>"navigation"</code> | Used to identify major groups of links used for navigating. |
67
- | <code>"orderedList"</code> | Used to identify a list of ordered items. |
68
- | <code>"listItem"</code> | Used to identify an item inside a list of items. |
69
- | <code>"unorderedList"</code> | Used to identify a list of unordered items. |
70
- | <code>"separator"</code> | Used to indicates the component acts as a divider that separates and distinguishes sections of content. |
71
- | <code>"status"</code> | Used to define a live region containing advisory information for the user that is not important enough to be an alert. |
72
- | <code>"alert"</code> | Used for important, and usually time-sensitive, information. |
73
-
74
- <a name="InlineAlignment"></a>
75
-
76
- ### InlineAlignment
77
-
78
- <code>"start" &#124; "center" &#124; "end"</code>
79
- <a name="BlockAlignment"></a>
80
-
81
- ### BlockAlignment
82
-
83
- <code><a href="#alignment">Alignment</a> &#124; "baseline"</code>
84
- <a name="Alignment"></a>
85
-
86
- ### Alignment
87
-
88
- <code>"start" &#124; "center" &#124; "end"</code>
89
- <a name="Spacing"></a>
90
-
91
- ### Spacing
92
-
93
- <code>"none" &#124; "extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose"</code>
94
- <a name="Columns"></a>
95
-
96
- ### Columns
97
-
98
- <code><a href="#griditemsize">GridItemSize</a>[] &#124; <a href="#griditemsize">GridItemSize</a></code>
99
- <a name="GridItemSize"></a>
100
-
101
- ### GridItemSize
102
-
103
- <code>"auto" &#124; "fill" &#124; number &#124; &#96;&dollar;{number}fr&#96; &#124; &#96;&dollar;{number}%&#96;</code>
@@ -1,14 +0,0 @@
1
- # InlineSpacer
2
-
3
- InlineSpacer is used to create empty inline space, typically when variable spacing
4
- is needed between multiple elements.
5
-
6
- Note that you should favor InlineStack when spacing between all elements is the same.
7
-
8
- ## Props
9
-
10
- optional = ?
11
-
12
- | Name | Type | Description |
13
- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
14
- | spacing? | <code>"extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose" &#124; ConditionalStyle<<wbr>"extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose", AcceptedConditions<wbr>></code> | Adjust size of the spacer<br /><br />Default value: <code>'base'</code> |
@@ -1,87 +0,0 @@
1
- # InlineStack
2
-
3
- InlineStack is used to lay out a horizontal row of elements. Elements always wrap.
4
-
5
- ## Props
6
-
7
- optional = ?
8
-
9
- | Name | Type | Description |
10
- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | accessibilityRole? | <code><a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a> &#124; [<a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>, <a href="#nonpresentationalaccessibilityrole">NonPresentationalAccessibilityRole</a>]</code> | Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.<br /><br />For example:<br /><br />- In an HTML host a `'listItem'` string will render: `&lt;li&gt;`<br /><br />- In an HTML host a `['listItem', 'separator']` tuple will render: `&lt;li role='separator'&gt;` |
12
- | accessibilityLabel? | <code>string</code> | A label that describes the purpose or contents of the element. When set, it will be announced to buyers using assistive technologies and will provide them with more context. |
13
- | blockAlignment? | <code><a href="#blockalignment">BlockAlignment</a> &#124; ConditionalStyle<<wbr><a href="#blockalignment">BlockAlignment</a>, AcceptedConditions<wbr>></code> | Position children along the cross axis<br /><br />Default value: <code>'start'</code> |
14
- | inlineAlignment? | <code><a href="#inlinealignment">InlineAlignment</a> &#124; ConditionalStyle<<wbr><a href="#inlinealignment">InlineAlignment</a>, AcceptedConditions<wbr>></code> | Position children along the main axis<br /><br />Default value: <code>'start'</code> |
15
- | spacing? | <code><a href="#spacing">Spacing</a> &#124; ConditionalStyle<<wbr><a href="#spacing">Spacing</a>, AcceptedConditions<wbr>></code> | Adjust spacing between children<br /><br />Default value: <code>'base'</code> |
16
- | border? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderstyle">BorderStyle</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border style.<br /><br />To shorten the code, it is possible to specify all the border style properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border styles are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border styles are `base`, inlineStart and inlineEnd border styles are `none`<br /><br />- `['base', 'none', 'dotted', 'base']` means blockStart border style is `base`, inlineEnd border style is `none`, blockEnd border style is `dotted` and blockStart border style is `base` |
17
- | borderWidth? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderwidth">BorderWidth</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border width.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border widths are `base`<br /><br />- `['base', 'medium']` means blockStart and blockEnd border widths are `base`, inlineStart and inlineEnd border widths are `medium`<br /><br />- `['base', 'medium', 'medium', 'base']` means blockStart border width is `base`, inlineEnd border width is `medium`, blockEnd border width is `medium` and blockStart border width is `base` |
18
- | borderRadius? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#borderradius">BorderRadius</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the border radius.<br /><br />To shorten the code, it is possible to specify all the border width properties in one property.<br /><br />For example:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart border radii are `base`<br /><br />- `['base', 'none']` means blockStart and blockEnd border radii are `base`, inlineStart and inlineEnd border radii are `none`<br /><br />- `['base', 'none', 'tight', 'base']` means blockStart border radius is `base`, inlineEnd border radius is `none`, blockEnd border radius is `tight` and blockStart border radius is `base` |
19
- | maxBlockSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the maximum block size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
20
- | maxInlineSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the maximum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
21
- | minInlineSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the minimum inline size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
22
- | minBlockSize? | <code>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill" &#124; ConditionalStyle<<wbr>number &#124; &#96;&dollar;{number}%&#96; &#124; "fill", AcceptedConditions<wbr>></code> | Adjust the block size.<br /><br />`number`: size in pixels.<br /><br />`` `${number}%` ``: size in percentages.<br /><br />`fill`: takes all the available space. |
23
- | padding? | <code><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>> &#124; ConditionalStyle<<wbr><a href="#maybeshorthandproperty">MaybeShorthandProperty</a><<wbr><a href="#spacing">Spacing</a><wbr>>, AcceptedConditions<wbr>></code> | Adjust the padding.<br /><br />To shorten the code, it is possible to specify all the padding properties in one property.<br /><br />Examples:<br /><br />- `base` means blockStart, inlineEnd, blockEnd and inlineStart paddings are `base`<br /><br />- [`base`, `none`] means blockStart and blockEnd paddings are `base`, inlineStart and inlineEnd paddings are `none`<br /><br />- [`base`, `none`, `loose`, `tight`] means blockStart padding is `base`, inlineEnd padding is `none`, blockEnd padding is `loose` and blockStart padding is `tight` |
24
-
25
- <a name="BorderRadius"></a>
26
-
27
- ### BorderRadius
28
-
29
- <code>"base" &#124; "tight" &#124; "loose" &#124; "fullyRounded" &#124; "none"</code>
30
- <a name="BorderWidth"></a>
31
-
32
- ### BorderWidth
33
-
34
- <code>"base" &#124; "medium"</code>
35
- <a name="MaybeShorthandProperty"></a>
36
-
37
- ### MaybeShorthandProperty
38
-
39
- <code>T &#124; <a href="#shorthandproperty">ShorthandProperty</a><<wbr>T<wbr>></code>
40
- <a name="ShorthandProperty"></a>
41
-
42
- ### ShorthandProperty
43
-
44
- <code>[T, T] &#124; [T, T, T, T]</code>
45
- <a name="BorderStyle"></a>
46
-
47
- ### BorderStyle
48
-
49
- <code>"base" &#124; "dotted" &#124; "none"</code>
50
- <a name="Spacing"></a>
51
-
52
- ### Spacing
53
-
54
- <code>"none" &#124; "extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose"</code>
55
- <a name="InlineAlignment"></a>
56
-
57
- ### InlineAlignment
58
-
59
- <code>"start" &#124; "center" &#124; "end"</code>
60
- <a name="BlockAlignment"></a>
61
-
62
- ### BlockAlignment
63
-
64
- <code><a href="#alignment">Alignment</a> &#124; "baseline"</code>
65
- <a name="Alignment"></a>
66
-
67
- ### Alignment
68
-
69
- <code>"start" &#124; "center" &#124; "end"</code>
70
- <a name="NonPresentationalAccessibilityRole"></a>
71
-
72
- ### NonPresentationalAccessibilityRole
73
-
74
- | Value | Description |
75
- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
76
- | <code>"main"</code> | Used to indicate the primary content. |
77
- | <code>"header"</code> | Used to indicate the component is a header. |
78
- | <code>"footer"</code> | Used to display information such as copyright information, navigation links, and privacy statements. |
79
- | <code>"section"</code> | Used to indicate a generic section. |
80
- | <code>"complementary"</code> | Used to designate a supporting section that relates to the main content. |
81
- | <code>"navigation"</code> | Used to identify major groups of links used for navigating. |
82
- | <code>"orderedList"</code> | Used to identify a list of ordered items. |
83
- | <code>"listItem"</code> | Used to identify an item inside a list of items. |
84
- | <code>"unorderedList"</code> | Used to identify a list of unordered items. |
85
- | <code>"separator"</code> | Used to indicates the component acts as a divider that separates and distinguishes sections of content. |
86
- | <code>"status"</code> | Used to define a live region containing advisory information for the user that is not important enough to be an alert. |
87
- | <code>"alert"</code> | Used for important, and usually time-sensitive, information. |
@@ -1,18 +0,0 @@
1
- # Link
2
-
3
- Link makes text interactive so customers can perform an action, such as navigating to another location.
4
-
5
- ## Props
6
-
7
- optional = ?
8
-
9
- | Name | Type | Description |
10
- | ------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
11
- | to? | <code>string</code> | Destination to navigate to. You must provide either this property, `onPress`, or both. |
12
- | external? | <code>boolean</code> | Open the link in a new window or tab |
13
- | id? | <code>string</code> | Unique identifier.<br /><br />Typically used as a target for another component’s controls to associate an accessible label with an action. |
14
- | language? | <code>string</code> | Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (&#34;subtag&#34; label) |
15
- | accessibilityLabel? | <code>string</code> | A label used for buyers using assistive technologies. When set, any 'children' supplied to this component are hidden from being seen for accessibility purposes to prevent duplicate content from being read. |
16
- | appearance? | <code>"monochrome"</code> | Specify the color of the link. `monochrome` will take the color of its parent.<br /><br /><code>"monochrome"</code>: Will take the color of its parent |
17
- | onPress? | <code>() => void</code> | Callback when pressed. If `to` is set, it will execute the callback and then navigate to the location specified by `to`. |
18
- | overlay? | <code>RemoteFragment</code> | An overlay component to render when the user interacts with the component. |
@@ -1,19 +0,0 @@
1
- # List
2
-
3
- Lists display a set of related content. Each list item usually begins with a bullet or a number.
4
-
5
- ## Props
6
-
7
- optional = ?
8
-
9
- | Name | Type | Description |
10
- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | spacing? | <code><a href="#spacing">Spacing</a> &#124; ConditionalStyle<<wbr><a href="#spacing">Spacing</a>, AcceptedConditions<wbr>></code> | Adjust spacing between list items<br /><br />Default value: <code>'base'</code> |
12
- | marker? | <code>"none" &#124; "bullet" &#124; "number"</code> | Type of marker to display<br /><br />Default value: <code>'bullet'</code> |
13
- | accessibilityLabel? | <code>string</code> | A label that describes the purpose or contents of the list. When set, it will be announced to buyers using assistive technologies and will provide them with more context. |
14
-
15
- <a name="Spacing"></a>
16
-
17
- ### Spacing
18
-
19
- <code>"none" &#124; "extraTight" &#124; "tight" &#124; "base" &#124; "loose" &#124; "extraLoose"</code>
@@ -1,5 +0,0 @@
1
- # ListItem
2
-
3
- List items are used as children of the `List` component.
4
-
5
- They usually begins with a bullet or a number.