Renames locations to placement in developer documentation

.changeset/calm-crabs-run.md

@@ -0,0 +1,6 @@
+---
+'@shopify/ui-extensions': patch
+'@shopify/ui-extensions-react': patch
+---
+
+Homogenizes terminology to use the term "placement" in place of "supported location", "placement reference", and others.

packages/ui-extensions-react/src/surfaces/checkout/render.tsx

@@ -17,7 +17,7 @@ import {ExtensionApiContext} from './context';
  * hook.
  *
  * @param target The extension target you are registering for. You can see a full list
- * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations).
+ * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements).
  *
  * @param render The function that will be called when Checkout begins rendering
  * your extension. This function is called with the API checkout provided to your
@@ -70,7 +70,7 @@ export function reactExtension<Target extends RenderExtensionTarget>(
  * hook.
  *
  * @param target The extension target you are registering for. You can see a full list
- * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations).
+ * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements).
  *
  * @param render The function that will be called when Checkout begins rendering
  * your extension. This function is called with the API checkout provided to your

packages/ui-extensions-react/src/surfaces/customer-account/render.tsx

@@ -17,7 +17,7 @@ import {ExtensionApiContext} from './context';
  * hook.
  *
  * @param target The extension target you are registering for. You can see a full list
- * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations).
+ * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements).
  *
  * @param render The function that will be called when Checkout begins rendering
  * your extension. This function is called with the API checkout provided to your
@@ -70,7 +70,7 @@ export function reactExtension<Target extends RenderExtensionTarget>(
  * hook.
  *
  * @param target The extension target you are registering for. You can see a full list
- * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations).
+ * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements).
  *
  * @param render The function that will be called when Checkout begins rendering
  * your extension. This function is called with the API checkout provided to your

packages/ui-extensions-react/src/surfaces/point-of-sale/render.tsx

@@ -17,7 +17,7 @@ import {ExtensionApiContext} from './context';
  * hook.
  *
  * @param target The extension target you are registering for. You can see a full list
- * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations).
+ * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements).
  *
  * @param render The function that will be called when Checkout begins rendering
  * your extension. This function is called with the API checkout provided to your
@@ -67,7 +67,7 @@ export function reactExtension<Target extends RenderExtensionTarget>(
  * hook.
  *
  * @param target The extension target you are registering for. You can see a full list
- * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations).
+ * of the available targets in our [developer documentation](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements).
  *
  * @param render The function that will be called when Checkout begins rendering
  * your extension. This function is called with the API checkout provided to your

packages/ui-extensions/docs/surfaces/checkout/reference/targets/customer-account.order-status.block.render.doc.ts

@@ -11,7 +11,7 @@ const data: ReferenceEntityTemplateSchema = {
   name: 'customer-account.order-status.block.render',
   description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Order status** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/docs/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
 
-  The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
+  The [placements](/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
 
   ${ORDER_STATUS_SURFACE_NOTE}
   `,

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.block.render.doc.ts

@@ -6,7 +6,7 @@ const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.checkout.block.render',
   description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
 
-  The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).`,
+  The [placements](/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).`,
   subCategory: 'Block',
   defaultExample: getExample('purchase.checkout.block.render/default', [
     'jsx',

packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.block.render.doc.ts

@@ -6,7 +6,7 @@ const data: ReferenceEntityTemplateSchema = {
   name: 'purchase.thank-you.block.render',
   description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/docs/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
 
-  The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).`,
+  The [placements](/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).`,
   subCategory: 'Block',
   defaultExample: getExample('purchase.thank-you.block.render/default', [
     'jsx',

packages/ui-extensions/docs/surfaces/checkout/staticPages/extension-overview.doc.ts

@@ -18,8 +18,8 @@ You register for targets in your [configuration file](/docs/api/checkout-ui-exte
   sections: [
     {
       type: 'GenericAccordion',
-      title: 'Checkout locations',
-      anchorLink: 'supported-locations',
+      title: 'Checkout placements',
+      anchorLink: 'placements',
       sectionContent:
         'Checkout is where buyers go to purchase goods. Checkout consists of the information, shipping, and payment steps in addition to the order summary and Shop Pay. Learn more about building [custom functionality for checkout](/docs/api/checkout-ui-extensions).',
       accordionContent: [
@@ -99,8 +99,8 @@ Get started testing extensions on [one-page checkout](/docs/apps/checkout/best-p
     },
     {
       type: 'GenericAccordion',
-      title: 'Thank you locations',
-      anchorLink: 'supported-typ-locations',
+      title: 'Thank you placements',
+      anchorLink: 'typ-placements',
       sectionContent:
         'The **Thank you** page is shown to buyers immediately after a checkout is successfully submitted. Learn more about building for [the **Thank you** page](/docs/apps/checkout/thank-you-order-status).',
       accordionContent: [
@@ -126,8 +126,8 @@ Review [all **Thank you** page extensions targets](/docs/api/checkout-ui-extensi
     },
     {
       type: 'GenericAccordion',
-      title: 'Order status locations',
-      anchorLink: 'supported-osp-locations',
+      title: 'Order status placements',
+      anchorLink: 'osp-placements',
       sectionContent:
         'The **Order status** page is shown to buyers when they return to a completed checkout for order updates. Learn more about building for [the **Order status** page](/docs/apps/checkout/thank-you-order-status).',
       accordionContent: [
@@ -176,7 +176,7 @@ Review [all **Order status** page extensions targets](/docs/api/checkout-ui-exte
       type: 'Generic',
       anchorLink: 'block-extension-targets',
       title: 'Block extension targets',
-      sectionContent: `Block extension targets render between core checkout features. Merchants can use the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor) to place the extension in the [checkout](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations), [**Thank you**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-typ-locations), or [**Order status**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-osp-locations) pages.
+      sectionContent: `Block extension targets render between core checkout features. Merchants can use the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor) to place the extension in the [checkout](/docs/api/checkout-ui-extensions/extension-targets-overview#placements), [**Thank you**](/docs/api/checkout-ui-extensions/extension-targets-overview#typ-placements), or [**Order status**](/docs/api/checkout-ui-extensions/extension-targets-overview#osp-placements) pages.
       \n\nBlock extensions are always rendered, regardless of what other elements of the checkout are present. For example, an extension placed above the shipping address will still render even for digital products which do not require a shipping address.\n\nChoose block extension targets when your content and functionality works independently of a core checkout feature. This is useful for custom content, like a field to capture order notes from the customer.`,
       image: 'block-extension-targets.png',
       sectionCard: [

packages/ui-extensions/docs/surfaces/checkout/staticPages/overview.doc.ts

@@ -56,7 +56,7 @@ const data: LandingTemplateSchema = {
       type: 'Generic',
       anchorLink: 'extension-targets',
       title: 'Extension Targets',
-      sectionContent: `Extension targets provide locations where merchants can insert custom content.
+      sectionContent: `Extension targets provide placements where merchants can insert custom content.
         Static extension targets are tied to core checkout features like contact information, shipping methods, and order summary line items.
         Block extension targets can be displayed at any point in the checkout process and will always render regardless of which checkout features are available.
         An example is a field to capture order notes from the customer.

packages/ui-extensions/src/surfaces/checkout/targets.ts

@@ -169,7 +169,7 @@ export interface RenderExtensionTargets {
    * Unlike static extension targets, block extension targets render where the merchant
    * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
    *
-   * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development
+   * The [placements](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development
    * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
    */
   'purchase.checkout.block.render': RenderExtension<
@@ -181,7 +181,7 @@ export interface RenderExtensionTargets {
    * Unlike static extension targets, block extension targets render where the merchant
    * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
    *
-   * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development
+   * The [placements](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development
    * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
    *
    * @deprecated Use `purchase.checkout.block.render` instead.
@@ -195,7 +195,7 @@ export interface RenderExtensionTargets {
    * Unlike static extension targets, block extension targets render where the merchant
    * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
    *
-   * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development
+   * The [placements](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development
    * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
    *
    */
@@ -208,7 +208,7 @@ export interface RenderExtensionTargets {
    * Unlike static extension targets, block extension targets render where the merchant
    * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
    *
-   * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development
+   * The [placements](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development
    * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
    *
    * @deprecated Use `purchase.thank-you.block.render` instead.
@@ -280,7 +280,7 @@ export interface RenderExtensionTargets {
    * Unlike static extension targets, block extension targets render where the merchant
    * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
    *
-   * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development
+   * The [placements](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development
    * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
    *
    * @deprecated Use `customer-account.order-status.block.render` from `@shopify/ui-extension/customer-account` instead.
@@ -295,7 +295,7 @@ export interface RenderExtensionTargets {
    * Unlike static extension targets, block extension targets render where the merchant
    * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
    *
-   * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development
+   * The [placements](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for block extension targets can be previewed during development
    * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).
    *
    * @deprecated Use `customer-account.order-status.block.render` from `@shopify/ui-extension/customer-account` instead.

packages/ui-extensions/src/surfaces/customer-account/targets.ts

@@ -34,7 +34,7 @@ export interface OrderStatusExtensionTargets {
    * Unlike static extension targets, dynamic extension targets render where the merchant
    * sets them using the [checkout editor](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
    *
-   * The [supported locations](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for dynamic extension targets can be previewed during development
+   * The [placements](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#placements) for dynamic extension targets can be previewed during development
    * by [using a URL parameter](https://shopify.dev/docs/apps/checkout/best-practices/testing-ui-extensions#dynamic-extension-targets).
    */
   'customer-account.order-status.block.render': RenderExtension<