Add print targets

Shopify · Jun 11, 2024 · cee44bc · cee44bc
1 parent f2d1ce4
commit cee44bc
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 2 deletions.
diff --git a/.changeset/tall-fireants-sleep.md b/.changeset/tall-fireants-sleep.md
@@ -0,0 +1,6 @@
+---
+'@shopify/ui-extensions': minor
+'@shopify/ui-extensions-react': minor
+---
+
+Add admin print action targets
diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/targets-overview.doc.ts b/packages/ui-extensions/docs/surfaces/admin/staticPages/targets-overview.doc.ts
@@ -191,6 +191,39 @@ You register targets in your \`shopify.extension.toml\` and inside the Javascrip
         },
       ],
     },
+    {
+      type: 'GenericAccordion',
+      title: 'Admin print actions locations',
+      anchorLink: 'print-locations',
+      sectionContent:
+        'Admin action extensions appear on order and product pages in the admin.',
+      accordionContent: [
+        {
+          title: 'Order details',
+          description:
+            'This page shows information about a single order. The `admin.order-details.print-action.render` target is available on this page.',
+          image: 'admin.order-details.print-action.render.png',
+        },
+        {
+          title: 'Product details',
+          description:
+            'This page shows information about a single product. The `admin.product-details.print-action.render` target is available on this page.',
+          image: 'admin.collection-details.block.render.png',
+        },
+        {
+          title: 'Order index selection',
+          description:
+            'This page shows a table of multiple orders. The `admin.order-index.selection-print-action.render` target is available on this page when multiple orders are selected.',
+          image: 'admin.order-index.selection-print-action.render.png',
+        },
+        {
+          title: 'Product index selection',
+          description:
+            'This page shows a table of multiple products. The `admin.product-index.selection-print-action.render` target is available on this page when multiple products are selected.',
+          image: 'admin.product-index.selection-print-action.render.png',
+        },
+      ],
+    },
     {
       type: 'Markdown',
       title: 'Customer segmentation locations',

diff --git a/packages/ui-extensions/src/surfaces/admin/extension-targets.ts b/packages/ui-extensions/src/surfaces/admin/extension-targets.ts
@@ -252,7 +252,7 @@ export interface ExtensionTargets {
   >;
 
   /**
-   * Renders an admin action extension in the abandonded checkout page. Open this extension from the "More Actions" menu.
+   * Renders an admin action extension in the abandoned checkout page. Open this extension from the "More Actions" menu.
    *
    * See the [list of available components](/docs/api/admin-extensions/components).
    */
@@ -335,7 +335,7 @@ export interface ExtensionTargets {
   >;
 
   /**
-   * 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.
+   * 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).
    */
@@ -354,6 +354,50 @@ export interface ExtensionTargets {
     AllComponents
   >;
 
+  // Print actions and bulk print actions
+
+  /**
+   * Renders an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" 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).
+   */
+  'admin.order-details.print-action.render': RenderExtension<
+    ActionExtensionApi<'admin.order-details.print-action.render'>,
+    AllComponents
+  >;
+
+  /**
+   * Renders an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" 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).
+   */
+  'admin.product-details.print-action.render': RenderExtension<
+    ActionExtensionApi<'admin.product-details.print-action.render'>,
+    AllComponents
+  >;
+
+  /**
+   * Renders an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" 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).
+   */
+  'admin.order-index.selection-print-action.render': RenderExtension<
+    ActionExtensionApi<'admin.order-index.selection-print-action.render'>,
+    AllComponents
+  >;
+
+  /**
+   * Renders an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" 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).
+   */
+  'admin.product-index.selection-print-action.render': RenderExtension<
+    ActionExtensionApi<'admin.product-index.selection-print-action.render'>,
+    AllComponents
+  >;
+
+  // Other
+
   /**
    * Renders Product Configuration on product details and product variant details
    *