@shopify/ui-extensions 2026.7.0-rc.6 → 2026.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.
- package/build/cjs/surfaces/checkout/preact/buyer-journey.js +3 -0
- package/build/cjs/surfaces/point-of-sale/events.js +1 -1
- package/build/esm/surfaces/checkout/preact/buyer-journey.mjs +3 -0
- package/build/esm/surfaces/point-of-sale/events.mjs +1 -1
- package/build/esnext/surfaces/checkout/preact/buyer-journey.esnext +3 -0
- package/build/esnext/surfaces/point-of-sale/events.esnext +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +21 -0
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/intents/intents.d.ts +11 -4
- package/build/ts/surfaces/admin/api/intents/intents.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Badge.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Button.d.ts +1 -1
- package/build/ts/surfaces/admin/components/Clickable.d.ts +7 -7
- package/build/ts/surfaces/admin/components/Grid.d.ts +12 -12
- package/build/ts/surfaces/admin/components/GridItem.d.ts +7 -7
- package/build/ts/surfaces/admin/components/Image.d.ts +7 -7
- package/build/ts/surfaces/admin/components/Stack.d.ts +11 -11
- package/build/ts/surfaces/admin/components/TextField.d.ts +1 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts +5 -0
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +3 -3
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Chat.d.ts +101 -3
- package/build/ts/surfaces/checkout/components/Section.d.ts +1 -1
- package/build/ts/surfaces/checkout/components/components.d.ts +1 -1
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Chat.d.ts +101 -3
- package/build/ts/surfaces/customer-account/components/Section.d.ts +1 -1
- package/build/ts/surfaces/customer-account/components/components.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +5 -2
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/docs.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/api/docs.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/printing-api/printing-api.d.ts +100 -0
- package/build/ts/surfaces/point-of-sale/api/printing-api/printing-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +2 -1
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api.d.ts +3 -1
- package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +2 -1
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +2 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +2 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +2 -1
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +2 -18
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data.d.ts +1 -3
- package/build/ts/surfaces/point-of-sale/event/data.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/events/cash-tracking-session-events.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/events/cash-tracking-session-events.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/events/transaction-complete-event.d.ts +1 -1
- package/build/ts/surfaces/point-of-sale/events/transaction-complete-event.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/events.d.ts +7 -1
- package/build/ts/surfaces/point-of-sale/events.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +17 -49
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.cart.line-item-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.customer-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.draft-order-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.exchange.post.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.home.modal.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.order-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.product-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.purchase.post.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.register-details.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.return.post.action.render.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +2 -1
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts +14 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +22 -0
- package/src/surfaces/admin/api/intents/intents.ts +11 -3
- package/src/surfaces/admin/components/Badge.d.ts +1 -1
- package/src/surfaces/admin/components/Button.d.ts +1 -1
- package/src/surfaces/admin/components/Clickable.d.ts +7 -7
- package/src/surfaces/admin/components/Grid.d.ts +12 -12
- package/src/surfaces/admin/components/GridItem.d.ts +7 -7
- package/src/surfaces/admin/components/Image.d.ts +7 -7
- package/src/surfaces/admin/components/Stack.d.ts +11 -11
- package/src/surfaces/admin/components/TextField.d.ts +1 -1
- package/src/surfaces/admin/components.d.ts +22 -22
- package/src/surfaces/checkout/api/shipping/shipping-option-item.ts +5 -0
- package/src/surfaces/checkout/api/standard/standard.ts +3 -3
- package/src/surfaces/checkout/components/Chat.d.ts +101 -3
- package/src/surfaces/checkout/components/Section.d.ts +1 -1
- package/src/surfaces/checkout/components/components.d.ts +1 -1
- package/src/surfaces/checkout/preact/buyer-journey.ts +3 -0
- package/src/surfaces/checkout/preact/shipping-option-target.ts +3 -0
- package/src/surfaces/customer-account/components/Section.d.ts +13 -0
- package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +9 -1
- package/src/surfaces/point-of-sale/api/docs.ts +11 -0
- package/src/surfaces/point-of-sale/api/print-api/print-api.ts +4 -0
- package/src/surfaces/point-of-sale/api/printing-api/printing-api.ts +105 -0
- package/src/surfaces/point-of-sale/api/standard/standard-api.ts +4 -0
- package/src/surfaces/point-of-sale/api.ts +10 -0
- package/src/surfaces/point-of-sale/components/QrCode.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/components-shared.d.ts +1 -1
- package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +1 -1
- package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +0 -2
- package/src/surfaces/point-of-sale/components.d.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +2 -1
- package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +2 -22
- package/src/surfaces/point-of-sale/event/data.ts +1 -11
- package/src/surfaces/point-of-sale/events/cash-tracking-session-events.ts +1 -1
- package/src/surfaces/point-of-sale/events/transaction-complete-event.ts +1 -1
- package/src/surfaces/point-of-sale/events.ts +7 -1
- package/src/surfaces/point-of-sale/extension-targets.ts +16 -68
- package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +2 -1
- package/src/surfaces/point-of-sale/types/cart.ts +15 -0
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +0 -16
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +0 -1
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +0 -51
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +0 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.cart-update.event.observe.d.ts +0 -8
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-complete.event.observe.d.ts +0 -8
- package/build/ts/surfaces/point-of-sale/targets/pos.cash-tracking-session-start.event.observe.d.ts +0 -8
- package/build/ts/surfaces/point-of-sale/targets/pos.transaction-complete.event.observe.d.ts +0 -8
- package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +0 -16
- package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +0 -52
|
@@ -41,6 +41,9 @@ function useBuyerJourneyCompleted() {
|
|
|
41
41
|
*
|
|
42
42
|
* It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension
|
|
43
43
|
* to block checkout progress.
|
|
44
|
+
*
|
|
45
|
+
* @deprecated Use a cart and checkout validation function instead. The buyer
|
|
46
|
+
* journey intercept will be removed in a future version of the API.
|
|
44
47
|
* @publicDocs
|
|
45
48
|
*/
|
|
46
49
|
function useBuyerJourneyIntercept(interceptor) {
|
|
@@ -15,7 +15,7 @@ const POS_EVENT_NAMES = {
|
|
|
15
15
|
};
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* Maps Shopify POS event names to their corresponding
|
|
18
|
+
* Maps Shopify POS event names to their corresponding payload types.
|
|
19
19
|
*
|
|
20
20
|
* Used as the generic type parameter for `shopify.addEventListener` and
|
|
21
21
|
* `shopify.removeEventListener`.
|
|
@@ -37,6 +37,9 @@ function useBuyerJourneyCompleted() {
|
|
|
37
37
|
*
|
|
38
38
|
* It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension
|
|
39
39
|
* to block checkout progress.
|
|
40
|
+
*
|
|
41
|
+
* @deprecated Use a cart and checkout validation function instead. The buyer
|
|
42
|
+
* journey intercept will be removed in a future version of the API.
|
|
40
43
|
* @publicDocs
|
|
41
44
|
*/
|
|
42
45
|
function useBuyerJourneyIntercept(interceptor) {
|
|
@@ -11,7 +11,7 @@ const POS_EVENT_NAMES = {
|
|
|
11
11
|
};
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
* Maps Shopify POS event names to their corresponding
|
|
14
|
+
* Maps Shopify POS event names to their corresponding payload types.
|
|
15
15
|
*
|
|
16
16
|
* Used as the generic type parameter for `shopify.addEventListener` and
|
|
17
17
|
* `shopify.removeEventListener`.
|
|
@@ -37,6 +37,9 @@ function useBuyerJourneyCompleted() {
|
|
|
37
37
|
*
|
|
38
38
|
* It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension
|
|
39
39
|
* to block checkout progress.
|
|
40
|
+
*
|
|
41
|
+
* @deprecated Use a cart and checkout validation function instead. The buyer
|
|
42
|
+
* journey intercept will be removed in a future version of the API.
|
|
40
43
|
* @publicDocs
|
|
41
44
|
*/
|
|
42
45
|
function useBuyerJourneyIntercept(interceptor) {
|
|
@@ -11,7 +11,7 @@ const POS_EVENT_NAMES = {
|
|
|
11
11
|
};
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
* Maps Shopify POS event names to their corresponding
|
|
14
|
+
* Maps Shopify POS event names to their corresponding payload types.
|
|
15
15
|
*
|
|
16
16
|
* Used as the generic type parameter for `shopify.addEventListener` and
|
|
17
17
|
* `shopify.removeEventListener`.
|
|
@@ -27,6 +27,11 @@ export type DiscountClass = 'product' | 'order' | 'shipping';
|
|
|
27
27
|
* @publicDocs
|
|
28
28
|
*/
|
|
29
29
|
export type DiscountMethod = 'automatic' | 'code';
|
|
30
|
+
/**
|
|
31
|
+
* The purchase type that determines which purchases the discount applies to. Use `'one_time_purchase'` for one-time purchases only, `'subscription'` for subscription purchases only, or `'both'` for both.
|
|
32
|
+
* @publicDocs
|
|
33
|
+
*/
|
|
34
|
+
export type PurchaseType = 'one_time_purchase' | 'subscription' | 'both';
|
|
30
35
|
/**
|
|
31
36
|
* The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.
|
|
32
37
|
* @publicDocs
|
|
@@ -54,5 +59,21 @@ export interface DiscountsApi {
|
|
|
54
59
|
* A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code.
|
|
55
60
|
*/
|
|
56
61
|
discountMethod: ReadonlySignalLike<DiscountMethod>;
|
|
62
|
+
/**
|
|
63
|
+
* A signal that contains the purchase type. Read this to determine whether the discount applies to one-time purchases, subscriptions, or both.
|
|
64
|
+
*/
|
|
65
|
+
purchaseType: ReadonlySignalLike<PurchaseType>;
|
|
66
|
+
/**
|
|
67
|
+
* A function that updates the purchase type to change which types of purchases the discount applies to. Call this with a `PurchaseType` value (`'one_time_purchase'`, `'subscription'`, or `'both'`).
|
|
68
|
+
*/
|
|
69
|
+
updatePurchaseType: UpdateSignalFunction<PurchaseType>;
|
|
70
|
+
/**
|
|
71
|
+
* A signal that contains the recurring cycle limit for subscription purchases. A positive integer limits how many billing cycles the discount applies for. Both `0` and `null` mean unlimited (no limit). `null` is the default when no value has been explicitly set.
|
|
72
|
+
*/
|
|
73
|
+
recurringCycleLimit: ReadonlySignalLike<number | null>;
|
|
74
|
+
/**
|
|
75
|
+
* A function that updates the recurring cycle limit for subscription purchases. Pass a positive integer to limit the number of billing cycles, `0` or `null` to remove the limit.
|
|
76
|
+
*/
|
|
77
|
+
updateRecurringCycleLimit: UpdateSignalFunction<number | null>;
|
|
57
78
|
}
|
|
58
79
|
//# sourceMappingURL=launch-options.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"launch-options.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/launch-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAE5B;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,qKAAqK;IACrK,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mIAAmI;IACnI,EAAE,EAAE,MAAM,CAAC;IACX,2JAA2J;IAC3J,SAAS,EAAE,MAAM,CAAC;IAClB,mMAAmM;IACnM,GAAG,EAAE,MAAM,CAAC;IACZ,8HAA8H;IAC9H,KAAK,EAAE,MAAM,CAAC;IACd,sMAAsM;IACtM,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,MAAM,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,4PAA4P;IAC5P,EAAE,EAAE,MAAM,CAAC;IACX,2PAA2P;IAC3P,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,eAAe,EAAE,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC;IACrD;;OAEG;IACH,qBAAqB,EAAE,oBAAoB,CAAC,aAAa,EAAE,CAAC,CAAC;IAC7D;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"launch-options.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/launch-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAE5B;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,qKAAqK;IACrK,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mIAAmI;IACnI,EAAE,EAAE,MAAM,CAAC;IACX,2JAA2J;IAC3J,SAAS,EAAE,MAAM,CAAC;IAClB,mMAAmM;IACnM,GAAG,EAAE,MAAM,CAAC;IACZ,8HAA8H;IAC9H,KAAK,EAAE,MAAM,CAAC;IACd,sMAAsM;IACtM,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,MAAM,CAAC;AAElD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,cAAc,GAAG,MAAM,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,4PAA4P;IAC5P,EAAE,EAAE,MAAM,CAAC;IACX,2PAA2P;IAC3P,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,eAAe,EAAE,kBAAkB,CAAC,aAAa,EAAE,CAAC,CAAC;IACrD;;OAEG;IACH,qBAAqB,EAAE,oBAAoB,CAAC,aAAa,EAAE,CAAC,CAAC;IAC7D;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC,cAAc,CAAC,CAAC;IACnD;;OAEG;IACH,YAAY,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAC/C;;OAEG;IACH,kBAAkB,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC;IACvD;;OAEG;IACH,mBAAmB,EAAE,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACvD;;OAEG;IACH,yBAAyB,EAAE,oBAAoB,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAChE"}
|
|
@@ -74,15 +74,15 @@ export interface IntentResponseApi {
|
|
|
74
74
|
closed(): Promise<void>;
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
* The type of operation to perform: creating a new resource
|
|
77
|
+
* The type of operation to perform: creating a new resource, editing an existing one, or picking existing resources.
|
|
78
78
|
* @publicDocs
|
|
79
79
|
*/
|
|
80
|
-
export type IntentAction = 'create' | 'edit';
|
|
80
|
+
export type IntentAction = 'create' | 'edit' | 'pick';
|
|
81
81
|
/**
|
|
82
82
|
* The types of Shopify resources that support intent-based creation and editing workflows.
|
|
83
83
|
* @publicDocs
|
|
84
84
|
*/
|
|
85
|
-
export type IntentType = 'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/Location' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant';
|
|
85
|
+
export type IntentType = 'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/File' | 'shopify/Location' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant';
|
|
86
86
|
/**
|
|
87
87
|
* Additional parameters for intent invocation when using the string query format. Use these options to provide resource IDs for editing or pass required context data for resource creation.
|
|
88
88
|
* @publicDocs
|
|
@@ -114,7 +114,7 @@ export interface IntentQuery extends IntentQueryOptions {
|
|
|
114
114
|
type: IntentType;
|
|
115
115
|
}
|
|
116
116
|
/**
|
|
117
|
-
* The [`invoke` method](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/intents-api#invoke-method) in the Intents API launches a Shopify admin workflow for creating or
|
|
117
|
+
* The [`invoke` method](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/intents-api#invoke-method) in the Intents API launches a Shopify admin workflow for creating, editing, or picking resources, such as products, customers, or files. It opens a native admin interface, waits for the merchant to complete the workflow, and returns the result including any created, updated, or selected resource data.
|
|
118
118
|
*
|
|
119
119
|
* @param intent - Either a string query (for example, `'create:shopify/Product'`) or structured object describing the intent
|
|
120
120
|
* @param options - Optional parameters when using string query format, such as resource IDs for editing or additional context data
|
|
@@ -135,6 +135,13 @@ export interface IntentQuery extends IntentQueryOptions {
|
|
|
135
135
|
* data: { type: 'amount-off-product' }
|
|
136
136
|
* });
|
|
137
137
|
* const response = await activity.complete;
|
|
138
|
+
*
|
|
139
|
+
* // Pick files from the store
|
|
140
|
+
* const activity = await intents.invoke('pick:shopify/File', {
|
|
141
|
+
* data: { mediaTypes: ['MediaImage'], multiSelect: true }
|
|
142
|
+
* });
|
|
143
|
+
* const response = await activity.complete;
|
|
144
|
+
* // response.data.ids contains the selected file GIDs
|
|
138
145
|
* ```
|
|
139
146
|
* @publicDocs
|
|
140
147
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"intents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,gIAAgI;IAChI,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,iIAAiI;IACjI,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,6HAA6H;IAC7H,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,2IAA2I;IAC3I,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,oIAAoI;IACpI,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oJAAoJ;IACpJ,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,qJAAqJ;IACrJ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,qHAAqH;IACrH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yGAAyG;IACzG,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"intents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,gIAAgI;IAChI,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,iIAAiI;IACjI,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,6HAA6H;IAC7H,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,2IAA2I;IAC3I,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,oIAAoI;IACpI,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oJAAoJ;IACpJ,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,qJAAqJ;IACrJ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,qHAAqH;IACrH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yGAAyG;IACzG,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExD;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAEtD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,6BAA6B,GAC7B,oBAAoB,GACpB,8BAA8B,GAC9B,cAAc,GACd,iBAAiB,GACjB,wBAAwB,CAAC;AAE7B;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5E;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B"}
|
|
@@ -215,7 +215,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
|
215
215
|
*/
|
|
216
216
|
ref?: preact.Ref<TClass>;
|
|
217
217
|
/**
|
|
218
|
-
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/
|
|
218
|
+
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
219
219
|
*/
|
|
220
220
|
slot?: Lowercase<string>;
|
|
221
221
|
}
|
|
@@ -47,7 +47,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
|
47
47
|
*/
|
|
48
48
|
ref?: preact.Ref<TClass>;
|
|
49
49
|
/**
|
|
50
|
-
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/
|
|
50
|
+
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
51
51
|
*/
|
|
52
52
|
slot?: Lowercase<string>;
|
|
53
53
|
}
|
|
@@ -201,7 +201,7 @@ export interface BoxProps
|
|
|
201
201
|
*
|
|
202
202
|
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
|
|
203
203
|
*
|
|
204
|
-
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
204
|
+
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
205
205
|
*
|
|
206
206
|
* @default 'none'
|
|
207
207
|
*/
|
|
@@ -213,7 +213,7 @@ export interface BoxProps
|
|
|
213
213
|
*
|
|
214
214
|
* This overrides the block value of `padding`.
|
|
215
215
|
*
|
|
216
|
-
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
216
|
+
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
217
217
|
*
|
|
218
218
|
* @default '' - meaning no override
|
|
219
219
|
*/
|
|
@@ -223,7 +223,7 @@ export interface BoxProps
|
|
|
223
223
|
*
|
|
224
224
|
* This overrides the block-start value of `paddingBlock`.
|
|
225
225
|
*
|
|
226
|
-
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
226
|
+
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
227
227
|
*
|
|
228
228
|
* @default '' - meaning no override
|
|
229
229
|
*/
|
|
@@ -233,7 +233,7 @@ export interface BoxProps
|
|
|
233
233
|
*
|
|
234
234
|
* This overrides the block-end value of `paddingBlock`.
|
|
235
235
|
*
|
|
236
|
-
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
236
|
+
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
237
237
|
*
|
|
238
238
|
* @default '' - meaning no override
|
|
239
239
|
*/
|
|
@@ -245,7 +245,7 @@ export interface BoxProps
|
|
|
245
245
|
*
|
|
246
246
|
* This overrides the inline value of `padding`.
|
|
247
247
|
*
|
|
248
|
-
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
248
|
+
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
249
249
|
*
|
|
250
250
|
* @default '' - meaning no override
|
|
251
251
|
*/
|
|
@@ -255,7 +255,7 @@ export interface BoxProps
|
|
|
255
255
|
*
|
|
256
256
|
* This overrides the inline-start value of `paddingInline`.
|
|
257
257
|
*
|
|
258
|
-
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
258
|
+
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
259
259
|
*
|
|
260
260
|
* @default '' - meaning no override
|
|
261
261
|
*/
|
|
@@ -265,7 +265,7 @@ export interface BoxProps
|
|
|
265
265
|
*
|
|
266
266
|
* This overrides the inline-end value of `paddingInline`.
|
|
267
267
|
*
|
|
268
|
-
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
268
|
+
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
269
269
|
*
|
|
270
270
|
* @default '' - meaning no override
|
|
271
271
|
*/
|
|
@@ -181,7 +181,7 @@ export interface BoxProps
|
|
|
181
181
|
*
|
|
182
182
|
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
|
|
183
183
|
*
|
|
184
|
-
* `padding` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
184
|
+
* `padding` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
185
185
|
*
|
|
186
186
|
* @default 'none'
|
|
187
187
|
*/
|
|
@@ -193,7 +193,7 @@ export interface BoxProps
|
|
|
193
193
|
*
|
|
194
194
|
* This overrides the block value of `padding`.
|
|
195
195
|
*
|
|
196
|
-
* `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
196
|
+
* `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
197
197
|
*
|
|
198
198
|
* @default '' - meaning no override
|
|
199
199
|
*/
|
|
@@ -203,7 +203,7 @@ export interface BoxProps
|
|
|
203
203
|
*
|
|
204
204
|
* This overrides the block-start value of `paddingBlock`.
|
|
205
205
|
*
|
|
206
|
-
* `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
206
|
+
* `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
207
207
|
*
|
|
208
208
|
* @default '' - meaning no override
|
|
209
209
|
*/
|
|
@@ -213,7 +213,7 @@ export interface BoxProps
|
|
|
213
213
|
*
|
|
214
214
|
* This overrides the block-end value of `paddingBlock`.
|
|
215
215
|
*
|
|
216
|
-
* `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
216
|
+
* `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
217
217
|
*
|
|
218
218
|
* @default '' - meaning no override
|
|
219
219
|
*/
|
|
@@ -225,7 +225,7 @@ export interface BoxProps
|
|
|
225
225
|
*
|
|
226
226
|
* This overrides the inline value of `padding`.
|
|
227
227
|
*
|
|
228
|
-
* `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
228
|
+
* `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
229
229
|
*
|
|
230
230
|
* @default '' - meaning no override
|
|
231
231
|
*/
|
|
@@ -235,7 +235,7 @@ export interface BoxProps
|
|
|
235
235
|
*
|
|
236
236
|
* This overrides the inline-start value of `paddingInline`.
|
|
237
237
|
*
|
|
238
|
-
* `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
238
|
+
* `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
239
239
|
*
|
|
240
240
|
* @default '' - meaning no override
|
|
241
241
|
*/
|
|
@@ -245,7 +245,7 @@ export interface BoxProps
|
|
|
245
245
|
*
|
|
246
246
|
* This overrides the inline-end value of `paddingInline`.
|
|
247
247
|
*
|
|
248
|
-
* `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
248
|
+
* `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
249
249
|
*
|
|
250
250
|
* @default '' - meaning no override
|
|
251
251
|
*/
|
|
@@ -371,31 +371,31 @@ export interface GridProps
|
|
|
371
371
|
| `${AlignContentKeyword} ${JustifyContentKeyword}`
|
|
372
372
|
| AlignContentKeyword;
|
|
373
373
|
/**
|
|
374
|
-
* The spacing between grid rows and columns. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for rows and columns. This property also accepts [responsive values](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
374
|
+
* The spacing between grid rows and columns. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for rows and columns. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
375
375
|
*
|
|
376
376
|
* @default 'none'
|
|
377
377
|
*/
|
|
378
378
|
gap: ResponsiveGridProps['gap'];
|
|
379
379
|
/**
|
|
380
|
-
* The spacing between grid rows. This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
380
|
+
* The spacing between grid rows. This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
381
381
|
*
|
|
382
382
|
* @default '' - meaning no override
|
|
383
383
|
*/
|
|
384
384
|
rowGap: ResponsiveGridProps['rowGap'];
|
|
385
385
|
/**
|
|
386
|
-
* The spacing between grid columns. This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
386
|
+
* The spacing between grid columns. This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
387
387
|
*
|
|
388
388
|
* @default '' - meaning no override
|
|
389
389
|
*/
|
|
390
390
|
columnGap: ResponsiveGridProps['columnGap'];
|
|
391
391
|
/**
|
|
392
|
-
* The number of columns and their sizes. You can use [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (for example, `'1fr auto'` or `'repeat(3, 1fr)'`) to define the grid structure. This property also accepts [responsive values](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
392
|
+
* The number of columns and their sizes. You can use [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (for example, `'1fr auto'` or `'repeat(3, 1fr)'`) to define the grid structure. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
393
393
|
*
|
|
394
394
|
* @default 'none'
|
|
395
395
|
*/
|
|
396
396
|
gridTemplateColumns: ResponsiveGridProps['gridTemplateColumns'];
|
|
397
397
|
/**
|
|
398
|
-
* The number of rows and their sizes. You can use [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (for example, `'1fr auto'` or `'repeat(3, 100px)'`) to define the grid structure. This property also accepts [responsive values](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
398
|
+
* The number of rows and their sizes. You can use [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (for example, `'1fr auto'` or `'repeat(3, 100px)'`) to define the grid structure. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
399
399
|
*
|
|
400
400
|
* @default 'none'
|
|
401
401
|
*/
|
|
@@ -176,7 +176,7 @@ export interface BoxProps
|
|
|
176
176
|
*
|
|
177
177
|
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
|
|
178
178
|
*
|
|
179
|
-
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
179
|
+
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
180
180
|
*
|
|
181
181
|
* @default 'none'
|
|
182
182
|
*/
|
|
@@ -188,7 +188,7 @@ export interface BoxProps
|
|
|
188
188
|
*
|
|
189
189
|
* This overrides the block value of `padding`.
|
|
190
190
|
*
|
|
191
|
-
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
191
|
+
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
192
192
|
*
|
|
193
193
|
* @default '' - meaning no override
|
|
194
194
|
*/
|
|
@@ -198,7 +198,7 @@ export interface BoxProps
|
|
|
198
198
|
*
|
|
199
199
|
* This overrides the block-start value of `paddingBlock`.
|
|
200
200
|
*
|
|
201
|
-
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
201
|
+
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
202
202
|
*
|
|
203
203
|
* @default '' - meaning no override
|
|
204
204
|
*/
|
|
@@ -208,7 +208,7 @@ export interface BoxProps
|
|
|
208
208
|
*
|
|
209
209
|
* This overrides the block-end value of `paddingBlock`.
|
|
210
210
|
*
|
|
211
|
-
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
211
|
+
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
212
212
|
*
|
|
213
213
|
* @default '' - meaning no override
|
|
214
214
|
*/
|
|
@@ -220,7 +220,7 @@ export interface BoxProps
|
|
|
220
220
|
*
|
|
221
221
|
* This overrides the inline value of `padding`.
|
|
222
222
|
*
|
|
223
|
-
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
223
|
+
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
224
224
|
*
|
|
225
225
|
* @default '' - meaning no override
|
|
226
226
|
*/
|
|
@@ -230,7 +230,7 @@ export interface BoxProps
|
|
|
230
230
|
*
|
|
231
231
|
* This overrides the inline-start value of `paddingInline`.
|
|
232
232
|
*
|
|
233
|
-
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
233
|
+
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
234
234
|
*
|
|
235
235
|
* @default '' - meaning no override
|
|
236
236
|
*/
|
|
@@ -240,7 +240,7 @@ export interface BoxProps
|
|
|
240
240
|
*
|
|
241
241
|
* This overrides the inline-end value of `paddingInline`.
|
|
242
242
|
*
|
|
243
|
-
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
243
|
+
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
244
244
|
*
|
|
245
245
|
* @default '' - meaning no override
|
|
246
246
|
*/
|
|
@@ -214,7 +214,7 @@ export interface BoxProps
|
|
|
214
214
|
*
|
|
215
215
|
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
|
|
216
216
|
*
|
|
217
|
-
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
217
|
+
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
218
218
|
*
|
|
219
219
|
* @default 'none'
|
|
220
220
|
*/
|
|
@@ -226,7 +226,7 @@ export interface BoxProps
|
|
|
226
226
|
*
|
|
227
227
|
* This overrides the block value of `padding`.
|
|
228
228
|
*
|
|
229
|
-
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
229
|
+
* `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
230
230
|
*
|
|
231
231
|
* @default '' - meaning no override
|
|
232
232
|
*/
|
|
@@ -236,7 +236,7 @@ export interface BoxProps
|
|
|
236
236
|
*
|
|
237
237
|
* This overrides the block-start value of `paddingBlock`.
|
|
238
238
|
*
|
|
239
|
-
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
239
|
+
* `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
240
240
|
*
|
|
241
241
|
* @default '' - meaning no override
|
|
242
242
|
*/
|
|
@@ -246,7 +246,7 @@ export interface BoxProps
|
|
|
246
246
|
*
|
|
247
247
|
* This overrides the block-end value of `paddingBlock`.
|
|
248
248
|
*
|
|
249
|
-
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
249
|
+
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
250
250
|
*
|
|
251
251
|
* @default '' - meaning no override
|
|
252
252
|
*/
|
|
@@ -258,7 +258,7 @@ export interface BoxProps
|
|
|
258
258
|
*
|
|
259
259
|
* This overrides the inline value of `padding`.
|
|
260
260
|
*
|
|
261
|
-
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
261
|
+
* `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
262
262
|
*
|
|
263
263
|
* @default '' - meaning no override
|
|
264
264
|
*/
|
|
@@ -268,7 +268,7 @@ export interface BoxProps
|
|
|
268
268
|
*
|
|
269
269
|
* This overrides the inline-start value of `paddingInline`.
|
|
270
270
|
*
|
|
271
|
-
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
271
|
+
* `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
272
272
|
*
|
|
273
273
|
* @default '' - meaning no override
|
|
274
274
|
*/
|
|
@@ -278,7 +278,7 @@ export interface BoxProps
|
|
|
278
278
|
*
|
|
279
279
|
* This overrides the inline-end value of `paddingInline`.
|
|
280
280
|
*
|
|
281
|
-
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
281
|
+
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
282
282
|
*
|
|
283
283
|
* @default '' - meaning no override
|
|
284
284
|
*/
|
|
@@ -180,7 +180,7 @@ export interface BoxProps
|
|
|
180
180
|
*
|
|
181
181
|
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
|
|
182
182
|
*
|
|
183
|
-
* `padding` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
183
|
+
* `padding` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
184
184
|
*
|
|
185
185
|
* @default 'none'
|
|
186
186
|
*/
|
|
@@ -192,7 +192,7 @@ export interface BoxProps
|
|
|
192
192
|
*
|
|
193
193
|
* This overrides the block value of `padding`.
|
|
194
194
|
*
|
|
195
|
-
* `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
195
|
+
* `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
196
196
|
*
|
|
197
197
|
* @default '' - meaning no override
|
|
198
198
|
*/
|
|
@@ -202,7 +202,7 @@ export interface BoxProps
|
|
|
202
202
|
*
|
|
203
203
|
* This overrides the block-start value of `paddingBlock`.
|
|
204
204
|
*
|
|
205
|
-
* `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
205
|
+
* `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
206
206
|
*
|
|
207
207
|
* @default '' - meaning no override
|
|
208
208
|
*/
|
|
@@ -212,7 +212,7 @@ export interface BoxProps
|
|
|
212
212
|
*
|
|
213
213
|
* This overrides the block-end value of `paddingBlock`.
|
|
214
214
|
*
|
|
215
|
-
* `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
215
|
+
* `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
216
216
|
*
|
|
217
217
|
* @default '' - meaning no override
|
|
218
218
|
*/
|
|
@@ -224,7 +224,7 @@ export interface BoxProps
|
|
|
224
224
|
*
|
|
225
225
|
* This overrides the inline value of `padding`.
|
|
226
226
|
*
|
|
227
|
-
* `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
227
|
+
* `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
228
228
|
*
|
|
229
229
|
* @default '' - meaning no override
|
|
230
230
|
*/
|
|
@@ -234,7 +234,7 @@ export interface BoxProps
|
|
|
234
234
|
*
|
|
235
235
|
* This overrides the inline-start value of `paddingInline`.
|
|
236
236
|
*
|
|
237
|
-
* `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
237
|
+
* `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
238
238
|
*
|
|
239
239
|
* @default '' - meaning no override
|
|
240
240
|
*/
|
|
@@ -244,7 +244,7 @@ export interface BoxProps
|
|
|
244
244
|
*
|
|
245
245
|
* This overrides the inline-end value of `paddingInline`.
|
|
246
246
|
*
|
|
247
|
-
* `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
247
|
+
* `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
248
248
|
*
|
|
249
249
|
* @default '' - meaning no override
|
|
250
250
|
*/
|
|
@@ -349,25 +349,25 @@ export interface StackProps
|
|
|
349
349
|
*/
|
|
350
350
|
alignContent: AlignContentKeyword;
|
|
351
351
|
/**
|
|
352
|
-
* The spacing between children in the stack. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for the block and inline axes. This property also accepts [responsive values](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
352
|
+
* The spacing between children in the stack. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for the block and inline axes. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
353
353
|
*
|
|
354
354
|
* @default 'none'
|
|
355
355
|
*/
|
|
356
356
|
gap: ResponsiveStackProps['gap'];
|
|
357
357
|
/**
|
|
358
|
-
* The spacing between children in the block axis (vertical in horizontal writing modes). This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
358
|
+
* The spacing between children in the block axis (vertical in horizontal writing modes). This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
359
359
|
*
|
|
360
360
|
* @default '' - meaning no override
|
|
361
361
|
*/
|
|
362
362
|
rowGap: ResponsiveStackProps['rowGap'];
|
|
363
363
|
/**
|
|
364
|
-
* The spacing between children in the inline axis (horizontal in left-to-right languages). This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
364
|
+
* The spacing between children in the inline axis (horizontal in left-to-right languages). This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
365
365
|
*
|
|
366
366
|
* @default '' - meaning no override
|
|
367
367
|
*/
|
|
368
368
|
columnGap: ResponsiveStackProps['columnGap'];
|
|
369
369
|
/**
|
|
370
|
-
* The direction in which the stack's children are laid out. Use `'inline'` to arrange children horizontally (with wrapping enabled), or `'block'` to arrange them vertically (without wrapping). This property also accepts [responsive values](/docs/api/polaris/using-web-components#responsive-values) using container query syntax.
|
|
370
|
+
* The direction in which the stack's children are laid out. Use `'inline'` to arrange children horizontally (with wrapping enabled), or `'block'` to arrange them vertically (without wrapping). This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax.
|
|
371
371
|
*
|
|
372
372
|
* @default 'block'
|
|
373
373
|
*
|
|
@@ -63,7 +63,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
|
63
63
|
*/
|
|
64
64
|
ref?: preact.Ref<TClass>;
|
|
65
65
|
/**
|
|
66
|
-
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/
|
|
66
|
+
* The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
67
67
|
*/
|
|
68
68
|
slot?: Lowercase<string>;
|
|
69
69
|
}
|
|
@@ -20,16 +20,21 @@ export interface ShippingOptionItemApi {
|
|
|
20
20
|
isTargetSelected: SubscribableSignalLike<boolean>;
|
|
21
21
|
/**
|
|
22
22
|
* The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.
|
|
23
|
+
*
|
|
24
|
+
* @deprecated Do not rely on render context. This target can render inside an overlay, so use inline UI instead of opening overlays such as modals.
|
|
23
25
|
*/
|
|
24
26
|
renderMode: ShippingOptionItemRenderMode;
|
|
25
27
|
}
|
|
26
28
|
/**
|
|
27
29
|
* The render mode of a shipping option.
|
|
30
|
+
*
|
|
28
31
|
* @publicDocs
|
|
29
32
|
*/
|
|
30
33
|
export interface ShippingOptionItemRenderMode {
|
|
31
34
|
/**
|
|
32
35
|
* Whether the shipping option is rendered in an overlay. When `true`, the extension appears in a modal or sheet on top of the checkout page. When `false`, the extension renders inline within the shipping options list.
|
|
36
|
+
*
|
|
37
|
+
* @deprecated Do not rely on render context. Use inline UI instead of opening overlays such as modals.
|
|
33
38
|
*/
|
|
34
39
|
overlay: boolean;
|
|
35
40
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shipping-option-item.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/shipping/shipping-option-item.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAEzD,kBAAkB;AAClB,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,MAAM,EAAE,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,gBAAgB,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAElD
|
|
1
|
+
{"version":3,"file":"shipping-option-item.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/shipping/shipping-option-item.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAEzD,kBAAkB;AAClB,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,MAAM,EAAE,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,gBAAgB,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAElD;;;;OAIG;IACH,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB"}
|