Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add new extension targets for action extensions everywhere #1837

Merged
merged 7 commits into from
Mar 26, 2024
Merged

add new extension targets for action extensions everywhere #1837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2aba48f
add new extension targets for action extensions everywhere
JoshuaWhite1 Mar 19, 2024
ec75f14
add definition for discount details
JoshuaWhite1 Mar 21, 2024
216c669
lower case admin action to follow style guide
JoshuaWhite1 Mar 21, 2024
8303397
reword description of order-fulfilled-card
JoshuaWhite1 Mar 25, 2024
10f4e4b
reword all action extension descriptions to explicitly say admin acti…
JoshuaWhite1 Mar 25, 2024
00a3a0c
rename variant details to product variant details
JoshuaWhite1 Mar 25, 2024
947b443
create changeset
JoshuaWhite1 Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/tidy-coins-retire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@shopify/ui-extensions': minor
'@shopify/ui-extensions-react': minor
---

add new targets for action extensions
121 changes: 111 additions & 10 deletions packages/ui-extensions/src/surfaces/admin/extension-targets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export interface ExtensionTargets {

// Actions
/**
* Renders an Admin Action in the product details page. Open this extension from the "More Actions" menu.
* Renders an admin action extension in the product details page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -112,7 +112,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the order details page. Open this extension from the "More Actions" menu.
* Renders an admin action extension in the order details page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -122,7 +122,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the customer details page. Open this extension from the "More Actions" menu.
* Renders an admin action extension in the customer details page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -132,7 +132,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the customer segment details page. Open this extension from the "Use segment" button.
* Renders an admin action extension in the customer segment details page. Open this extension from the "Use segment" button.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -142,7 +142,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the product index page. Open this extension from the "More Actions" menu.
* Renders an admin action extension in the product index page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -152,7 +152,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the order index page. Open this extension from the "More Actions" menu.
* Renders an admin action extension in the order index page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -162,7 +162,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the customer index page. Open this extension from the "More Actions" menu.
* Renders an admin action extension in the customer index page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -171,10 +171,101 @@ export interface ExtensionTargets {
AllComponents
>;

/**
* Renders an admin action extension in the discount index page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.discount-index.action.render': RenderExtension<
ActionExtensionApi<'admin.discount-index.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the collection details page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.collection-details.action.render': RenderExtension<
ActionExtensionApi<'admin.collection-details.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the collection index page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.collection-index.action.render': RenderExtension<
ActionExtensionApi<'admin.collection-index.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the abandonded checkout page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.abandoned-checkout-details.action.render': RenderExtension<
ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the product variant details page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.product-variant-details.action.render': RenderExtension<
ActionExtensionApi<'admin.product-variant-details.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the draft order details page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.draft-order-details.action.render': RenderExtension<
ActionExtensionApi<'admin.draft-order-details.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the draft orders page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.draft-order-index.action.render': RenderExtension<
ActionExtensionApi<'admin.draft-order-index.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the discount details page. Open this extension from the "More Actions" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.discount-details.action.render': RenderExtension<
ActionExtensionApi<'admin.discount-details.action.render'>,
AllComponents
>;

/**
* Renders an admin action extension in the order fulfilled card. Open this extension from the "3-dot" menu inside the order fulfilled card.
* Note: This extension will only be visible on orders which were fulfilled by your app.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.order-fulfilled-card.action.render': RenderExtension<
ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,
AllComponents
>;

// Bulk Actions

/**
* Renders an Admin Action in the product index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime.
* Renders an admin action extension in the product index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -184,7 +275,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the order index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime.
* Renders an admin action extension in the order index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -194,7 +285,7 @@ export interface ExtensionTargets {
>;

/**
* Renders an Admin Action in the customer index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime.
* Renders an admin action extension in the customer index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
Expand All @@ -203,6 +294,16 @@ export interface ExtensionTargets {
AllComponents
>;

/**
* Renders an admin action extension in the draft order page when multiple resources are selected. Open this extension from the "3-dot" menu.
*
* See the [list of available components](/docs/api/admin-extensions/components).
*/
'admin.draft-order-index.selection-action.render': RenderExtension<
ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,
AllComponents
>;

/**
* Renders Product Configuration on product details and product variant details
*
Expand Down