@shopify/ui-extensions 2023.4.0 → 2023.4.1

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 (153) hide show
  1. package/build/cjs/surfaces/admin/components/Pressable/Pressable.js +9 -0
  2. package/build/cjs/surfaces/admin.js +2 -0
  3. package/build/esm/surfaces/admin/components/Pressable/Pressable.mjs +5 -0
  4. package/build/esm/surfaces/admin.mjs +1 -0
  5. package/build/esnext/surfaces/admin/components/Pressable/Pressable.esnext +5 -0
  6. package/build/esnext/surfaces/admin.esnext +1 -0
  7. package/build/ts/api.d.ts +12 -0
  8. package/build/ts/api.d.ts.map +1 -1
  9. package/build/ts/surfaces/admin/api/action/action.d.ts +3 -3
  10. package/build/ts/surfaces/admin/api/action/action.d.ts.map +1 -1
  11. package/build/ts/surfaces/admin/api/action/action.doc.d.ts.map +1 -1
  12. package/build/ts/surfaces/admin/api/customer-segmentation-template/customer-segmentation-template.d.ts +2 -2
  13. package/build/ts/surfaces/admin/api/customer-segmentation-template/customer-segmentation-template.d.ts.map +1 -1
  14. package/build/ts/surfaces/admin/api/extension-targets/extension-targets.doc.d.ts.map +1 -1
  15. package/build/ts/surfaces/admin/api/standard/standard.d.ts +16 -6
  16. package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
  17. package/build/ts/surfaces/admin/api/standard/standard.doc.d.ts.map +1 -1
  18. package/build/ts/surfaces/admin/components/AdminAction/AdminAction.d.ts +0 -1
  19. package/build/ts/surfaces/admin/components/AdminAction/AdminAction.d.ts.map +1 -1
  20. package/build/ts/surfaces/admin/components/AdminAction/AdminAction.doc.d.ts.map +1 -1
  21. package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.d.ts +0 -1
  22. package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.d.ts.map +1 -1
  23. package/build/ts/surfaces/admin/components/AdminBlock/AdminBlock.doc.d.ts.map +1 -1
  24. package/build/ts/surfaces/admin/components/BlockStack/BlockStack.d.ts +13 -1
  25. package/build/ts/surfaces/admin/components/BlockStack/BlockStack.d.ts.map +1 -1
  26. package/build/ts/surfaces/admin/components/BlockStack/BlockStack.doc.d.ts.map +1 -1
  27. package/build/ts/surfaces/admin/components/Box/Box.doc.d.ts.map +1 -1
  28. package/build/ts/surfaces/admin/components/Button/Button.doc.d.ts.map +1 -1
  29. package/build/ts/surfaces/admin/components/Checkbox/Checkbox.doc.d.ts.map +1 -1
  30. package/build/ts/surfaces/admin/components/Divider/Divider.d.ts +3 -2
  31. package/build/ts/surfaces/admin/components/Divider/Divider.d.ts.map +1 -1
  32. package/build/ts/surfaces/admin/components/Divider/Divider.doc.d.ts.map +1 -1
  33. package/build/ts/surfaces/admin/components/EmailField/EmailField.doc.d.ts.map +1 -1
  34. package/build/ts/surfaces/admin/components/Form/Form.d.ts +3 -3
  35. package/build/ts/surfaces/admin/components/Form/Form.d.ts.map +1 -1
  36. package/build/ts/surfaces/admin/components/Form/Form.doc.d.ts.map +1 -1
  37. package/build/ts/surfaces/admin/components/Heading/Heading.doc.d.ts.map +1 -1
  38. package/build/ts/surfaces/admin/components/HeadingGroup/HeadingGroup.doc.d.ts.map +1 -1
  39. package/build/ts/surfaces/admin/components/Icon/Icon.d.ts +3 -1
  40. package/build/ts/surfaces/admin/components/Icon/Icon.d.ts.map +1 -1
  41. package/build/ts/surfaces/admin/components/Icon/Icon.doc.d.ts.map +1 -1
  42. package/build/ts/surfaces/admin/components/Icon/IconName.d.ts +2 -0
  43. package/build/ts/surfaces/admin/components/Icon/IconName.d.ts.map +1 -0
  44. package/build/ts/surfaces/admin/components/Image/Image.d.ts +3 -2
  45. package/build/ts/surfaces/admin/components/Image/Image.d.ts.map +1 -1
  46. package/build/ts/surfaces/admin/components/Image/Image.doc.d.ts.map +1 -1
  47. package/build/ts/surfaces/admin/components/InlineStack/InlineStack.d.ts +13 -1
  48. package/build/ts/surfaces/admin/components/InlineStack/InlineStack.d.ts.map +1 -1
  49. package/build/ts/surfaces/admin/components/InlineStack/InlineStack.doc.d.ts.map +1 -1
  50. package/build/ts/surfaces/admin/components/Link/Link.doc.d.ts.map +1 -1
  51. package/build/ts/surfaces/admin/components/NumberField/NumberField.doc.d.ts.map +1 -1
  52. package/build/ts/surfaces/admin/components/PasswordField/PasswordField.doc.d.ts.map +1 -1
  53. package/build/ts/surfaces/admin/components/Pressable/Pressable.d.ts +10 -0
  54. package/build/ts/surfaces/admin/components/Pressable/Pressable.d.ts.map +1 -0
  55. package/build/ts/surfaces/admin/components/Pressable/Pressable.doc.d.ts +4 -0
  56. package/build/ts/surfaces/admin/components/Pressable/Pressable.doc.d.ts.map +1 -0
  57. package/build/ts/surfaces/admin/components/Select/Select.doc.d.ts.map +1 -1
  58. package/build/ts/surfaces/admin/components/Text/Text.d.ts +1 -1
  59. package/build/ts/surfaces/admin/components/Text/Text.d.ts.map +1 -1
  60. package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map +1 -1
  61. package/build/ts/surfaces/admin/components/TextArea/TextArea.doc.d.ts.map +1 -1
  62. package/build/ts/surfaces/admin/components/TextField/TextField.doc.d.ts.map +1 -1
  63. package/build/ts/surfaces/admin/components/URLField/URLField.doc.d.ts.map +1 -1
  64. package/build/ts/surfaces/admin/components/shared/index.d.ts +4 -4
  65. package/build/ts/surfaces/admin/components/shared/index.d.ts.map +1 -1
  66. package/build/ts/surfaces/admin/components.d.ts +2 -0
  67. package/build/ts/surfaces/admin/components.d.ts.map +1 -1
  68. package/build/ts/surfaces/admin/{extension-points.d.ts → extension-targets.d.ts} +62 -20
  69. package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -0
  70. package/build/ts/surfaces/admin/extension.d.ts +3 -3
  71. package/build/ts/surfaces/admin/extension.d.ts.map +1 -1
  72. package/build/ts/surfaces/admin/globals.d.ts +2 -2
  73. package/build/ts/surfaces/admin/globals.d.ts.map +1 -1
  74. package/build/ts/surfaces/admin.d.ts +1 -1
  75. package/build/ts/surfaces/admin.d.ts.map +1 -1
  76. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +45 -5
  77. package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
  78. package/build/ts/surfaces/checkout/api/shipping/shipping-method-details.d.ts +1 -1
  79. package/build/ts/surfaces/checkout/api/shipping/shipping-method-details.d.ts.map +1 -1
  80. package/build/ts/surfaces/checkout/api/standard/standard.d.ts +5 -3
  81. package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
  82. package/build/ts/surfaces/checkout/api.d.ts +1 -1
  83. package/build/ts/surfaces/checkout/api.d.ts.map +1 -1
  84. package/build/ts/surfaces/checkout/extension-points.d.ts +12 -0
  85. package/build/ts/surfaces/checkout/extension-points.d.ts.map +1 -1
  86. package/build/tsconfig.tsbuildinfo +1 -1
  87. package/package.json +2 -1
  88. package/src/api.ts +14 -0
  89. package/src/surfaces/admin/api/action/action.doc.ts +1 -0
  90. package/src/surfaces/admin/api/action/action.ts +4 -4
  91. package/src/surfaces/admin/api/customer-segmentation-template/customer-segmentation-template.ts +3 -3
  92. package/src/surfaces/admin/api/extension-targets/extension-targets.doc.ts +3 -2
  93. package/src/surfaces/admin/api/standard/standard.doc.ts +1 -0
  94. package/src/surfaces/admin/api/standard/standard.ts +21 -6
  95. package/src/surfaces/admin/components/AdminAction/AdminAction.doc.ts +10 -3
  96. package/src/surfaces/admin/components/AdminAction/AdminAction.ts +0 -2
  97. package/src/surfaces/admin/components/AdminAction/examples/basic-adminaction.example.ts +12 -6
  98. package/src/surfaces/admin/components/AdminBlock/AdminBlock.doc.ts +10 -3
  99. package/src/surfaces/admin/components/AdminBlock/AdminBlock.ts +0 -2
  100. package/src/surfaces/admin/components/BlockStack/BlockStack.doc.ts +8 -1
  101. package/src/surfaces/admin/components/BlockStack/BlockStack.ts +16 -0
  102. package/src/surfaces/admin/components/BlockStack/examples/basic-blockstack.example.ts +1 -1
  103. package/src/surfaces/admin/components/Box/Box.doc.ts +1 -0
  104. package/src/surfaces/admin/components/Box/examples/basic-box.example.ts +1 -1
  105. package/src/surfaces/admin/components/Button/Button.doc.ts +13 -1
  106. package/src/surfaces/admin/components/Checkbox/Checkbox.doc.ts +8 -1
  107. package/src/surfaces/admin/components/Divider/Divider.doc.ts +2 -1
  108. package/src/surfaces/admin/components/Divider/Divider.ts +3 -2
  109. package/src/surfaces/admin/components/Divider/examples/basic-divider.example.ts +2 -2
  110. package/src/surfaces/admin/components/EmailField/EmailField.doc.ts +14 -3
  111. package/src/surfaces/admin/components/Form/Form.doc.ts +23 -1
  112. package/src/surfaces/admin/components/Form/Form.ts +3 -3
  113. package/src/surfaces/admin/components/Form/examples/basic-form.example.ts +8 -6
  114. package/src/surfaces/admin/components/Heading/Heading.doc.ts +14 -2
  115. package/src/surfaces/admin/components/HeadingGroup/HeadingGroup.doc.ts +9 -2
  116. package/src/surfaces/admin/components/HeadingGroup/examples/basic-headinggroup.example.ts +1 -1
  117. package/src/surfaces/admin/components/Icon/Icon.doc.ts +35 -3
  118. package/src/surfaces/admin/components/Icon/Icon.ts +3 -1
  119. package/src/surfaces/admin/components/Icon/IconName.ts +567 -0
  120. package/src/surfaces/admin/components/Image/Image.doc.ts +9 -2
  121. package/src/surfaces/admin/components/Image/Image.ts +38 -35
  122. package/src/surfaces/admin/components/Image/examples/basic-image.example.ts +2 -2
  123. package/src/surfaces/admin/components/InlineStack/InlineStack.doc.ts +8 -1
  124. package/src/surfaces/admin/components/InlineStack/InlineStack.ts +16 -0
  125. package/src/surfaces/admin/components/InlineStack/examples/basic-inlinestack.example.ts +1 -1
  126. package/src/surfaces/admin/components/Link/Link.doc.ts +15 -8
  127. package/src/surfaces/admin/components/NumberField/NumberField.doc.ts +9 -2
  128. package/src/surfaces/admin/components/PasswordField/PasswordField.doc.ts +14 -2
  129. package/src/surfaces/admin/components/PasswordField/examples/basic-passwordfield.example.ts +10 -9
  130. package/src/surfaces/admin/components/Pressable/Pressable.doc.ts +49 -0
  131. package/src/surfaces/admin/components/Pressable/Pressable.ts +9 -0
  132. package/src/surfaces/admin/components/Pressable/examples/basic-pressable.example.ts +25 -0
  133. package/src/surfaces/admin/components/Select/Select.doc.ts +9 -2
  134. package/src/surfaces/admin/components/Text/Text.doc.ts +9 -2
  135. package/src/surfaces/admin/components/Text/Text.ts +1 -3
  136. package/src/surfaces/admin/components/Text/examples/basic-text.example.ts +3 -7
  137. package/src/surfaces/admin/components/TextArea/TextArea.doc.ts +9 -2
  138. package/src/surfaces/admin/components/TextField/TextField.doc.ts +19 -2
  139. package/src/surfaces/admin/components/URLField/URLField.doc.ts +9 -3
  140. package/src/surfaces/admin/components/shared/index.ts +4 -4
  141. package/src/surfaces/admin/components.ts +2 -0
  142. package/src/surfaces/admin/{extension-points.ts → extension-targets.ts} +75 -22
  143. package/src/surfaces/admin/extension.ts +3 -2
  144. package/src/surfaces/admin/globals.ts +4 -4
  145. package/src/surfaces/admin.ts +1 -1
  146. package/src/surfaces/checkout/api/checkout/checkout.ts +57 -5
  147. package/src/surfaces/checkout/api/shipping/shipping-method-details.ts +1 -1
  148. package/src/surfaces/checkout/api/standard/README.md +3 -3
  149. package/src/surfaces/checkout/api/standard/standard.ts +13 -3
  150. package/src/surfaces/checkout/api.ts +2 -0
  151. package/src/surfaces/checkout/extension-points.ts +12 -0
  152. package/src/surfaces/checkout/style/examples/style.example.tsx +1 -1
  153. package/build/ts/surfaces/admin/extension-points.d.ts.map +0 -1
@@ -0,0 +1,567 @@
1
+ export type IconName =
2
+ | 'AbandonedCartFilledMajor'
3
+ | 'AbandonedCartMajor'
4
+ | 'AccessibilityMajor'
5
+ | 'ActivitiesMajor'
6
+ | 'AddCodeMajor'
7
+ | 'AddImageMajor'
8
+ | 'AddMajor'
9
+ | 'AddNoteMajor'
10
+ | 'AddProductMajor'
11
+ | 'AdjustMinor'
12
+ | 'AffiliateMajor'
13
+ | 'AlertMinor'
14
+ | 'AnalyticsBarHorizontalMinor'
15
+ | 'AnalyticsBarStackedMinor'
16
+ | 'AnalyticsCohortMinor'
17
+ | 'AnalyticsDonutMinor'
18
+ | 'AnalyticsFilledMinor'
19
+ | 'AnalyticsFunnelMinor'
20
+ | 'AnalyticsLineMinor'
21
+ | 'AnalyticsMajor'
22
+ | 'AnalyticsMinor'
23
+ | 'AnalyticsTableMinor'
24
+ | 'AnyClickModelMinor'
25
+ | 'AppExtensionMinor'
26
+ | 'AppsFilledMajor'
27
+ | 'AppsMajor'
28
+ | 'AppsMinor'
29
+ | 'ArchiveMajor'
30
+ | 'ArchiveMinor'
31
+ | 'ArrowDownMinor'
32
+ | 'ArrowLeftMinor'
33
+ | 'ArrowRightMinor'
34
+ | 'ArrowUpMinor'
35
+ | 'AttachmentFilledMajor'
36
+ | 'AttachmentMajor'
37
+ | 'AutomationFilledMajor'
38
+ | 'AutomationMajor'
39
+ | 'BackspaceMajor'
40
+ | 'BalanceFilledMajor'
41
+ | 'BalanceMajor'
42
+ | 'BankFilledMajor'
43
+ | 'BankMajor'
44
+ | 'BarcodeMajor'
45
+ | 'BehaviorFilledMajor'
46
+ | 'BehaviorMajor'
47
+ | 'BehaviorMinor'
48
+ | 'BillingStatementDollarFilledMajor'
49
+ | 'BillingStatementDollarMajor'
50
+ | 'BillingStatementEuroFilledMajor'
51
+ | 'BillingStatementEuroMajor'
52
+ | 'BillingStatementPoundFilledMajor'
53
+ | 'BillingStatementPoundMajor'
54
+ | 'BillingStatementRupeeFilledMajor'
55
+ | 'BillingStatementRupeeMajor'
56
+ | 'BillingStatementYenFilledMajor'
57
+ | 'BillingStatementYenMajor'
58
+ | 'BlockMinor'
59
+ | 'BlockquoteMajor'
60
+ | 'BlogMajor'
61
+ | 'BoldMajor'
62
+ | 'BoldMinor'
63
+ | 'BugMajor'
64
+ | 'ButtonCornerPillMajor'
65
+ | 'ButtonCornerRoundedMajor'
66
+ | 'ButtonCornerSquareMajor'
67
+ | 'ButtonMinor'
68
+ | 'BuyButtonButtonLayoutMajor'
69
+ | 'BuyButtonHorizontalLayoutMajor'
70
+ | 'BuyButtonMajor'
71
+ | 'BuyButtonVerticalLayoutMajor'
72
+ | 'CalendarMajor'
73
+ | 'CalendarMinor'
74
+ | 'CalendarTickMajor'
75
+ | 'CalendarTimeMinor'
76
+ | 'CameraMajor'
77
+ | 'CancelMajor'
78
+ | 'CancelMinor'
79
+ | 'CancelSmallMinor'
80
+ | 'CapitalFilledMajor'
81
+ | 'CapitalMajor'
82
+ | 'CapturePaymentMinor'
83
+ | 'CardReaderChipMajor'
84
+ | 'CardReaderMajor'
85
+ | 'CardReaderTapMajor'
86
+ | 'CaretDownMinor'
87
+ | 'CaretUpMinor'
88
+ | 'CartDownFilledMajor'
89
+ | 'CartDownMajor'
90
+ | 'CartFilledMajor'
91
+ | 'CartMajor'
92
+ | 'CartUpMajor'
93
+ | 'CashDollarFilledMajor'
94
+ | 'CashDollarMajor'
95
+ | 'CashDollarMinor'
96
+ | 'CashEuroMajor'
97
+ | 'CashPoundMajor'
98
+ | 'CashRupeeMajor'
99
+ | 'CashYenMajor'
100
+ | 'CategoriesMajor'
101
+ | 'ChannelsMajor'
102
+ | 'ChatMajor'
103
+ | 'ChecklistAlternateMajor'
104
+ | 'ChecklistMajor'
105
+ | 'CheckoutMajor'
106
+ | 'ChevronDownMinor'
107
+ | 'ChevronLeftMinor'
108
+ | 'ChevronRightMinor'
109
+ | 'ChevronUpMinor'
110
+ | 'CircleAlertMajor'
111
+ | 'CircleCancelMajor'
112
+ | 'CircleCancelMinor'
113
+ | 'CircleChevronDownMinor'
114
+ | 'CircleChevronLeftMinor'
115
+ | 'CircleChevronRightMinor'
116
+ | 'CircleChevronUpMinor'
117
+ | 'CircleDisableMinor'
118
+ | 'CircleDisabledMajor'
119
+ | 'CircleDotsMajor'
120
+ | 'CircleDownMajor'
121
+ | 'CircleInformationMajor'
122
+ | 'CircleLeftMajor'
123
+ | 'CircleMinusMajor'
124
+ | 'CircleMinusMinor'
125
+ | 'CircleMinusOutlineMinor'
126
+ | 'CirclePlusMajor'
127
+ | 'CirclePlusMinor'
128
+ | 'CirclePlusOutlineMinor'
129
+ | 'CircleRightMajor'
130
+ | 'CircleTickMajor'
131
+ | 'CircleTickMinor'
132
+ | 'CircleTickOutlineMinor'
133
+ | 'CircleUpMajor'
134
+ | 'ClipboardMinor'
135
+ | 'ClockMajor'
136
+ | 'ClockMinor'
137
+ | 'CodeMajor'
138
+ | 'CodeMinor'
139
+ | 'CollectionReferenceMinor'
140
+ | 'CollectionsFilledMajor'
141
+ | 'CollectionsMajor'
142
+ | 'ColorNoneMinor'
143
+ | 'ColorsMajor'
144
+ | 'Column1Major'
145
+ | 'ColumnWithTextMajor'
146
+ | 'Columns2Major'
147
+ | 'Columns3Major'
148
+ | 'Columns3Minor'
149
+ | 'ComposeMajor'
150
+ | 'ConfettiMajor'
151
+ | 'ConnectMinor'
152
+ | 'ContentFilledMinor'
153
+ | 'ContentMinor'
154
+ | 'ConversationMinor'
155
+ | 'CreditCardCancelMajor'
156
+ | 'CreditCardMajor'
157
+ | 'CreditCardPercentMajor'
158
+ | 'CreditCardSecureMajor'
159
+ | 'CurrencyConvertMinor'
160
+ | 'CustomerMinusMajor'
161
+ | 'CustomerPlusMajor'
162
+ | 'CustomersFilledMinor'
163
+ | 'CustomersMajor'
164
+ | 'CustomersMinor'
165
+ | 'DataDrivenModelMinor'
166
+ | 'DataVisualizationMajor'
167
+ | 'DecimalMinor'
168
+ | 'DeleteMajor'
169
+ | 'DeleteMinor'
170
+ | 'DesktopMajor'
171
+ | 'DetailedPopUpMajor'
172
+ | 'DiamondAlertMajor'
173
+ | 'DiamondAlertMinor'
174
+ | 'DigitalMediaReceiverMajor'
175
+ | 'DiscountAutomaticMajor'
176
+ | 'DiscountCodeMajor'
177
+ | 'DiscountsFilledMinor'
178
+ | 'DiscountsMajor'
179
+ | 'DiscountsMinor'
180
+ | 'DisputeMinor'
181
+ | 'DnsSettingsMajor'
182
+ | 'DockFloatingMajor'
183
+ | 'DockSideMajor'
184
+ | 'DomainNewMajor'
185
+ | 'DomainRedirectMinor'
186
+ | 'DomainsFilledMajor'
187
+ | 'DomainsMajor'
188
+ | 'DraftOrdersFilledMajor'
189
+ | 'DraftOrdersMajor'
190
+ | 'DragDropMajor'
191
+ | 'DragHandleMinor'
192
+ | 'DropdownMinor'
193
+ | 'DuplicateMinor'
194
+ | 'DynamicSourceMajor'
195
+ | 'DynamicSourceMinor'
196
+ | 'EditMajor'
197
+ | 'EditMinor'
198
+ | 'EmailMajor'
199
+ | 'EmailNewsletterMajor'
200
+ | 'EmbedMinor'
201
+ | 'EnableSelectionMinor'
202
+ | 'EnterMajor'
203
+ | 'EnvelopeMajor'
204
+ | 'ExchangeMajor'
205
+ | 'ExistingInventoryMajor'
206
+ | 'ExitMajor'
207
+ | 'ExploreImagesMajor'
208
+ | 'ExportMinor'
209
+ | 'ExtendMajor'
210
+ | 'ExtendMinor'
211
+ | 'ExternalMinor'
212
+ | 'ExternalSmallMinor'
213
+ | 'EyeDropperMinor'
214
+ | 'FaviconMajor'
215
+ | 'FavoriteMajor'
216
+ | 'FeaturedCollectionMajor'
217
+ | 'FeaturedContentMajor'
218
+ | 'FileFilledMinor'
219
+ | 'FileMinor'
220
+ | 'FilterMajor'
221
+ | 'FilterMinor'
222
+ | 'FinancesMajor'
223
+ | 'FinancesMinor'
224
+ | 'FirstClickModelMinor'
225
+ | 'FirstOrderMajor'
226
+ | 'FirstVisitMajor'
227
+ | 'FlagMajor'
228
+ | 'FlipCameraMajor'
229
+ | 'FolderDownMajor'
230
+ | 'FolderMajor'
231
+ | 'FolderMinusMajor'
232
+ | 'FolderPlusMajor'
233
+ | 'FolderUpMajor'
234
+ | 'FollowUpEmailMajor'
235
+ | 'FoodMajor'
236
+ | 'FooterMajor'
237
+ | 'FormsMajor'
238
+ | 'FraudProtectMajor'
239
+ | 'FraudProtectMinor'
240
+ | 'FraudProtectPendingMajor'
241
+ | 'FraudProtectPendingMinor'
242
+ | 'FraudProtectUnprotectedMajor'
243
+ | 'FraudProtectUnprotectedMinor'
244
+ | 'FulfillmentFulfilledMajor'
245
+ | 'FulfillmentOnHoldMajor'
246
+ | 'GamesConsoleMajor'
247
+ | 'GaugeMajor'
248
+ | 'GaugeMinor'
249
+ | 'GiftCardFilledMinor'
250
+ | 'GiftCardMajor'
251
+ | 'GiftCardMinor'
252
+ | 'GlobeMajor'
253
+ | 'GlobeMinor'
254
+ | 'GrammarMajor'
255
+ | 'HashtagMajor'
256
+ | 'HashtagMinor'
257
+ | 'HeaderMajor'
258
+ | 'HeartMajor'
259
+ | 'HideKeyboardMajor'
260
+ | 'HideMinor'
261
+ | 'HintMajor'
262
+ | 'HomeFilledMinor'
263
+ | 'HomeMajor'
264
+ | 'HomeMinor'
265
+ | 'HorizontalDotsMinor'
266
+ | 'IconNameSet'
267
+ | 'IconsFilledMajor'
268
+ | 'IconsMajor'
269
+ | 'IdentityCardFilledMajor'
270
+ | 'IdentityCardMajor'
271
+ | 'IllustrationMajor'
272
+ | 'ImageAltMajor'
273
+ | 'ImageAltMinor'
274
+ | 'ImageMajor'
275
+ | 'ImageWithTextMajor'
276
+ | 'ImageWithTextOverlayMajor'
277
+ | 'ImagesMajor'
278
+ | 'ImportMinor'
279
+ | 'ImportStoreMajor'
280
+ | 'InactiveLocationMajor'
281
+ | 'InactiveLocationMinor'
282
+ | 'IncomingMajor'
283
+ | 'IndentMajor'
284
+ | 'IndentMinor'
285
+ | 'InfoMinor'
286
+ | 'InsertDynamicSourceMajor'
287
+ | 'InsertDynamicSourceMinor'
288
+ | 'InstallMinor'
289
+ | 'InventoryFilledMajor'
290
+ | 'InventoryMajor'
291
+ | 'InviteMinor'
292
+ | 'IqMajor'
293
+ | 'ItalicMajor'
294
+ | 'ItalicMinor'
295
+ | 'JobsFilledMajor'
296
+ | 'JobsMajor'
297
+ | 'KeyMajor'
298
+ | 'KeyboardMajor'
299
+ | 'KeyboardMinor'
300
+ | 'LabelPrinterMajor'
301
+ | 'LandingPageMajor'
302
+ | 'LanguageFilledMinor'
303
+ | 'LanguageMinor'
304
+ | 'LastClickModelMinor'
305
+ | 'LastNonDirectClickModelMinor'
306
+ | 'LegalFilledMajor'
307
+ | 'LegalMajor'
308
+ | 'LinearModelMinor'
309
+ | 'LinkMinor'
310
+ | 'ListFilledMajor'
311
+ | 'ListMajor'
312
+ | 'ListMinor'
313
+ | 'LiveViewFilledMajor'
314
+ | 'LiveViewMajor'
315
+ | 'LocationFilledMajor'
316
+ | 'LocationMajor'
317
+ | 'LocationsMinor'
318
+ | 'LockFilledMajor'
319
+ | 'LockMajor'
320
+ | 'LockMinor'
321
+ | 'LogOutMinor'
322
+ | 'LogoBlockMajor'
323
+ | 'MagicMajor'
324
+ | 'MagicMinor'
325
+ | 'ManagedStoreMajor'
326
+ | 'MarkFulfilledMinor'
327
+ | 'MarkPaidMinor'
328
+ | 'MarketingFilledMinor'
329
+ | 'MarketingMajor'
330
+ | 'MarketingMinor'
331
+ | 'MarketsFilledMajor'
332
+ | 'MarketsMajor'
333
+ | 'MaximizeMajor'
334
+ | 'MaximizeMinor'
335
+ | 'MeasurementMinor'
336
+ | 'MentionMajor'
337
+ | 'MergeMinor'
338
+ | 'MetafieldsFilledMinor'
339
+ | 'MetafieldsMajor'
340
+ | 'MetafieldsMinor'
341
+ | 'MetaobjectMinor'
342
+ | 'MetaobjectReferenceMinor'
343
+ | 'MicrophoneMajor'
344
+ | 'MinimizeMajor'
345
+ | 'MinimizeMinor'
346
+ | 'MinusMajor'
347
+ | 'MinusMinor'
348
+ | 'MobileAcceptMajor'
349
+ | 'MobileBackArrowMajor'
350
+ | 'MobileCancelMajor'
351
+ | 'MobileChevronMajor'
352
+ | 'MobileHamburgerMajor'
353
+ | 'MobileHorizontalDotsMajor'
354
+ | 'MobileMajor'
355
+ | 'MobilePlusMajor'
356
+ | 'MobileVerticalDotsMajor'
357
+ | 'MonerisMajor'
358
+ | 'MoneyFilledMinor'
359
+ | 'MoneyMinor'
360
+ | 'NatureMajor'
361
+ | 'NavigationMajor'
362
+ | 'NoteMajor'
363
+ | 'NoteMinor'
364
+ | 'NotificationFilledMajor'
365
+ | 'NotificationMajor'
366
+ | 'OnlineStoreMajor'
367
+ | 'OnlineStoreMinor'
368
+ | 'OrderStatusMinor'
369
+ | 'OrderedListMajor'
370
+ | 'OrderedListMinor'
371
+ | 'OrdersFilledMinor'
372
+ | 'OrdersMajor'
373
+ | 'OrdersMinor'
374
+ | 'OrganizationMajor'
375
+ | 'OutdentMajor'
376
+ | 'OutdentMinor'
377
+ | 'OutgoingMajor'
378
+ | 'PackageFilledMajor'
379
+ | 'PackageMajor'
380
+ | 'PageDownMajor'
381
+ | 'PageMajor'
382
+ | 'PageMinusMajor'
383
+ | 'PagePlusMajor'
384
+ | 'PageReferenceMinor'
385
+ | 'PageUpMajor'
386
+ | 'PaginationEndMinor'
387
+ | 'PaginationStartMinor'
388
+ | 'PaintBrushMajor'
389
+ | 'PaperCheckMajor'
390
+ | 'PaperCheckMinor'
391
+ | 'PasskeyFilledMinor'
392
+ | 'PasskeyMajor'
393
+ | 'PasskeyMinor'
394
+ | 'PauseCircleMajor'
395
+ | 'PauseMajor'
396
+ | 'PauseMinor'
397
+ | 'PaymentsFilledMajor'
398
+ | 'PaymentsMajor'
399
+ | 'PersonalizedTextMajor'
400
+ | 'PhoneInMajor'
401
+ | 'PhoneMajor'
402
+ | 'PhoneOutMajor'
403
+ | 'PinMajor'
404
+ | 'PinMinor'
405
+ | 'PinUnfilledMajor'
406
+ | 'PinUnfilledMinor'
407
+ | 'PlanFilledMinor'
408
+ | 'PlanMajor'
409
+ | 'PlanMinor'
410
+ | 'PlayCircleMajor'
411
+ | 'PlayMajor'
412
+ | 'PlayMinor'
413
+ | 'PlusMinor'
414
+ | 'PointOfSaleMajor'
415
+ | 'PopularMajor'
416
+ | 'PositionBasedModelMinor'
417
+ | 'PriceLookupMinor'
418
+ | 'PrintMajor'
419
+ | 'PrintMinor'
420
+ | 'ProductCostMajor'
421
+ | 'ProductReferenceMinor'
422
+ | 'ProductReturnsMinor'
423
+ | 'ProductsFilledMinor'
424
+ | 'ProductsMajor'
425
+ | 'ProductsMinor'
426
+ | 'ProfileMajor'
427
+ | 'ProfileMinor'
428
+ | 'PromoteFilledMinor'
429
+ | 'PromoteMinor'
430
+ | 'QuestionMarkInverseMajor'
431
+ | 'QuestionMarkInverseMinor'
432
+ | 'QuestionMarkMajor'
433
+ | 'QuestionMarkMinor'
434
+ | 'QuickSaleMajor'
435
+ | 'ReadTimeMinor'
436
+ | 'ReceiptMajor'
437
+ | 'RecentSearchesMajor'
438
+ | 'RedoMajor'
439
+ | 'ReferralCodeMajor'
440
+ | 'ReferralMajor'
441
+ | 'RefreshMajor'
442
+ | 'RefreshMinor'
443
+ | 'RefundMajor'
444
+ | 'RefundMinor'
445
+ | 'RemoveProductMajor'
446
+ | 'RepeatOrderMajor'
447
+ | 'ReplaceMajor'
448
+ | 'ReplayMinor'
449
+ | 'ReportFilledMinor'
450
+ | 'ReportMinor'
451
+ | 'ReportsMajor'
452
+ | 'ResetMinor'
453
+ | 'ResourcesMajor'
454
+ | 'ReturnMinor'
455
+ | 'ReturnsMajor'
456
+ | 'RichTextMinor'
457
+ | 'RiskMajor'
458
+ | 'RiskMinor'
459
+ | 'Rows2Major'
460
+ | 'SandboxMajor'
461
+ | 'SaveMinor'
462
+ | 'SearchMajor'
463
+ | 'SearchMinor'
464
+ | 'SectionMajor'
465
+ | 'SecureMajor'
466
+ | 'SelectMinor'
467
+ | 'SendMajor'
468
+ | 'SettingsFilledMinor'
469
+ | 'SettingsMajor'
470
+ | 'SettingsMinor'
471
+ | 'ShareIosMinor'
472
+ | 'ShareMinor'
473
+ | 'ShipmentFilledMajor'
474
+ | 'ShipmentMajor'
475
+ | 'ShopcodesMajor'
476
+ | 'SidebarLeftMajor'
477
+ | 'SidebarRightMajor'
478
+ | 'SimplifyMajor'
479
+ | 'SimplifyMinor'
480
+ | 'SlideshowMajor'
481
+ | 'SmileyHappyMajor'
482
+ | 'SmileyJoyMajor'
483
+ | 'SmileyNeutralMajor'
484
+ | 'SmileySadMajor'
485
+ | 'SocialAdMajor'
486
+ | 'SocialPostMajor'
487
+ | 'SoftPackMajor'
488
+ | 'SortAscendingMajor'
489
+ | 'SortDescendingMajor'
490
+ | 'SortMinor'
491
+ | 'SoundMajor'
492
+ | 'StarFilledMinor'
493
+ | 'StarOutlineMinor'
494
+ | 'StatusActiveMajor'
495
+ | 'StopMajor'
496
+ | 'StoreDetailsFilledMinor'
497
+ | 'StoreDetailsMinor'
498
+ | 'StoreFilledMinor'
499
+ | 'StoreMajor'
500
+ | 'StoreMinor'
501
+ | 'StoreStatusMajor'
502
+ | 'TabletMajor'
503
+ | 'TapChipMajor'
504
+ | 'TaxFilledMajor'
505
+ | 'TaxMajor'
506
+ | 'TeamMajor'
507
+ | 'TemplateMajor'
508
+ | 'TemplateMinor'
509
+ | 'TextAlignmentCenterMajor'
510
+ | 'TextAlignmentLeftMajor'
511
+ | 'TextAlignmentRightMajor'
512
+ | 'TextBlockMajor'
513
+ | 'TextColorMajor'
514
+ | 'TextColorMinor'
515
+ | 'TextMajor'
516
+ | 'ThemeEditMajor'
517
+ | 'ThemeStoreMajor'
518
+ | 'ThemesMajor'
519
+ | 'ThumbsDownMajor'
520
+ | 'ThumbsDownMinor'
521
+ | 'ThumbsUpMajor'
522
+ | 'ThumbsUpMinor'
523
+ | 'TickMinor'
524
+ | 'TickSmallMinor'
525
+ | 'TimeDecayModelMinor'
526
+ | 'TimelineAttachmentMajor'
527
+ | 'TipsMajor'
528
+ | 'TitleMinor'
529
+ | 'ToggleMinor'
530
+ | 'ToolsMajor'
531
+ | 'TransactionFeeDollarMajor'
532
+ | 'TransactionFeeEuroMajor'
533
+ | 'TransactionFeePoundMajor'
534
+ | 'TransactionFeeRupeeMajor'
535
+ | 'TransactionFeeYenMajor'
536
+ | 'TransactionMajor'
537
+ | 'TransferFilledMajor'
538
+ | 'TransferInMajor'
539
+ | 'TransferMajor'
540
+ | 'TransferOutMajor'
541
+ | 'TransferWithinShopifyMajor'
542
+ | 'TransportMajor'
543
+ | 'TroubleshootMajor'
544
+ | 'TypeMajor'
545
+ | 'TypeMinor'
546
+ | 'UnderlineMajor'
547
+ | 'UnderlineMinor'
548
+ | 'UndoMajor'
549
+ | 'UnfulfilledMajor'
550
+ | 'UnknownDeviceMajor'
551
+ | 'UpdateInventoryMajor'
552
+ | 'UploadMajor'
553
+ | 'VariantMajor'
554
+ | 'ViewMajor'
555
+ | 'ViewMinor'
556
+ | 'ViewportNarrowMajor'
557
+ | 'ViewportShortMajor'
558
+ | 'ViewportTallMajor'
559
+ | 'ViewportWideMajor'
560
+ | 'VocabularyMajor'
561
+ | 'VolumeMinor'
562
+ | 'WandMajor'
563
+ | 'WandMinor'
564
+ | 'WearableMajor'
565
+ | 'WeightMinor'
566
+ | 'WholesaleMajor'
567
+ | 'WifiMajor';
@@ -2,6 +2,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
2
2
 
3
3
  const data: ReferenceEntityTemplateSchema = {
4
4
  name: 'Image',
5
+ featureFlag: 'admin_extensibility',
5
6
  description: 'Use this when you want to display an image.',
6
7
  requires: '',
7
8
  thumbnail: 'image-thumbnail.png',
@@ -19,7 +20,7 @@ const data: ReferenceEntityTemplateSchema = {
19
20
  defaultExample: {
20
21
  image: 'image-default.png',
21
22
  codeblock: {
22
- title: 'TODO: add example title',
23
+ title: 'Simple Image example',
23
24
  tabs: [
24
25
  {
25
26
  title: 'React',
@@ -35,7 +36,13 @@ const data: ReferenceEntityTemplateSchema = {
35
36
  },
36
37
  },
37
38
 
38
- related: [],
39
+ related: [
40
+ {
41
+ type: 'component',
42
+ name: 'Icon',
43
+ url: '/docs/api/admin-extensions/components/media/icon',
44
+ },
45
+ ],
39
46
  };
40
47
 
41
48
  export default data;
@@ -2,45 +2,48 @@ import {createRemoteComponent} from '@remote-ui/core';
2
2
  import type {AccessibilityRole} from '../shared';
3
3
 
4
4
  export type ImageProps = (ImageAccessibilityLabelProp | ImageAltProp) &
5
- (ImageSourceProp | ImageSrcProp) & {
6
- /**
7
- * Sets the semantic meaning of the component’s content. When set,
8
- * the role will be used by assistive technologies to help users
9
- * navigate the page.
10
- */
11
- accessibilityRole?: Extract<AccessibilityRole, 'decorative'>;
5
+ (ImageSourceProp | ImageSrcProp) &
6
+ ImageBaseProps;
12
7
 
13
- /**
14
- * Defines a unique identifier which must be unique in the whole document.
15
- *
16
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id
17
- */
18
- id?: string;
8
+ interface ImageBaseProps {
9
+ /**
10
+ * Sets the semantic meaning of the component’s content. When set,
11
+ * the role will be used by assistive technologies to help users
12
+ * navigate the page.
13
+ */
14
+ accessibilityRole?: Extract<AccessibilityRole, 'decorative'>;
15
+
16
+ /**
17
+ * Defines a unique identifier which must be unique in the whole document.
18
+ *
19
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id
20
+ */
21
+ id?: string;
19
22
 
20
- /**
21
- * Determines the loading behavior of the image:
22
- * - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
23
- * - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
24
- *
25
- * @defaultValue `eager`
26
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
27
- */
28
- loading?: 'eager' | 'lazy';
23
+ /**
24
+ * Determines the loading behavior of the image:
25
+ * - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
26
+ * - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
27
+ *
28
+ * @defaultValue `eager`
29
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
30
+ */
31
+ loading?: 'eager' | 'lazy';
29
32
 
30
- /**
31
- * Invoked when load completes successfully.
32
- *
33
- * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
34
- */
35
- onLoad?(): void;
33
+ /**
34
+ * Invoked when load completes successfully.
35
+ *
36
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
37
+ */
38
+ onLoad?(): void;
36
39
 
37
- /**
38
- * Invoked on load error.
39
- *
40
- * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
41
- */
42
- onError?(): void;
43
- };
40
+ /**
41
+ * Invoked on load error.
42
+ *
43
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
44
+ */
45
+ onError?(): void;
46
+ }
44
47
 
45
48
  interface ImageAccessibilityLabelProp {
46
49
  /**
@@ -2,8 +2,8 @@ import {extend, Image} from '@shopify/ui-extensions/admin';
2
2
 
3
3
  extend('Playground', (root) => {
4
4
  const image = root.createComponent(Image, {
5
- source:
6
- 'https://shopify.dev/assets/api/ui-extensions/admin/components/image-example-code.png',
5
+ alt: 'Pickaxe',
6
+ source: 'https://shopify.dev/assets/icons/64/pickaxe-1.png',
7
7
  });
8
8
 
9
9
  root.appendChild(image);