Skip to content

Commit

Permalink
order status page
Browse files Browse the repository at this point in the history
  • Loading branch information
rennyG committed Nov 15, 2023
1 parent 63b2ca4 commit 1cbdbd1
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export function useBuyerJourney<
/**
* Returns true if the buyer completed submitting their order.
*
* For example, when viewing the order status page after submitting payment, the buyer will have completed their order.
* For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.
*/
export function useBuyerJourneyCompleted<
Target extends RenderExtensionTarget = RenderExtensionTarget,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const data: ReferenceEntityTemplateSchema = {
title: 'useBuyerJourneyCompleted',
description: `
Returns \`true\` if the buyer completed submitting their order.
For example, when viewing the order status page after submitting payment, the buyer will have completed their order.
For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.
`,
type: 'UseBuyerJourneyCompletedGeneratedType',
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
const data: ReferenceEntityTemplateSchema = {
name: 'Order',
description:
'The API for interacting with the order, available on the Order Status Page.',
'The API for interacting with the order, available on the **Order status** page.',
isVisualComponent: false,
category: 'APIs',
type: 'API',
Expand All @@ -21,7 +21,7 @@ const data: ReferenceEntityTemplateSchema = {
{
title: 'useOrder',
description:
"Returns the order information that's available on the Order Status Page.",
"Returns the order information that's available on the **Order status** page.",
type: 'UseOrderGeneratedType',
},
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {

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](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
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](/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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
const data: ReferenceEntityTemplateSchema = {
name: 'customer-account.order-status.cart-line-item.render-after',
description: `
A static extension target that renders on every line item, inside the details under the line item properties element on the Order Status Page.
A static extension target that renders on every line item, inside the details under the line item properties element on the **Order status** page.
${ORDER_STATUS_SURFACE_NOTE}
`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
const data: ReferenceEntityTemplateSchema = {
name: 'customer-account.order-status.cart-line-list.render-after',
description: `
A static extension target that is rendered after all line items on the Order Status page.
A static extension target that is rendered after all line items on the **Order status** page.
${ORDER_STATUS_SURFACE_NOTE}
`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
const data: ReferenceEntityTemplateSchema = {
name: 'customer-account.order-status.customer-information.render-after',
description: `
A static extension target that is rendered after a purchase below the customer information on the Order Status page.
A static extension target that is rendered after a purchase below the customer information on the **Order status** page.
${ORDER_STATUS_SURFACE_NOTE}
`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,14 @@ Review [all **Thank you** page extensions targets](/docs/api/checkout-ui-extensi
title: 'Order status locations',
anchorLink: 'supported-osp-locations',
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).',
'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: [
{
title: 'Order details',
description: `
Displays all order information to buyers.
See [all order status page extension targets](/docs/api/checkout-ui-extensions/targets).
Review [all **Order status** page extension targets](/docs/api/checkout-ui-extensions/targets).
`,
image: 'supported-locations-order-status.png',
},
Expand All @@ -145,7 +145,7 @@ See [all order status page extension targets](/docs/api/checkout-ui-extensions/t
description: `
Summary of the cart contents, discounts, and order totals.
See [all order status page extensions targets](/docs/api/checkout-ui-extensions/targets).
Review [all **Order status** page extensions targets](/docs/api/checkout-ui-extensions/targets).
`,
image: 'supported-locations-order-summary-order-status.png',
},
Expand Down Expand Up @@ -176,7 +176,7 @@ See [all order status page extensions targets](/docs/api/checkout-ui-extensions/
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#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.
\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: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ export interface BuyerJourney {
/**
* This subscribable value will be true if the buyer completed submitting their order.
*
* For example, when viewing the order status page after submitting payment, the buyer will have completed their order.
* For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.
*/
completed: StatefulRemoteSubscribable<boolean>;
}
Expand Down
16 changes: 8 additions & 8 deletions packages/ui-extensions/src/surfaces/checkout/targets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ export interface ExtensionTargets {
AnyComponent
>;
/**
* A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the Order Status Page.
* A [block extension target](https://shopify.dev/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](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
*
Expand All @@ -276,7 +276,7 @@ export interface ExtensionTargets {
AnyComponent
>;
/**
* A [block extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the Order Status Page.
* A [block extension target](https://shopify.dev/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](https://shopify.dev/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).
*
Expand All @@ -292,7 +292,7 @@ export interface ExtensionTargets {
>;
/**
* A static extension target that renders on every line item, inside the details
* under the line item properties element on the Order Status Page.
* under the line item properties element on the **Order status** page.
*
* @deprecated Use `customer-account.order-status.cart-line-item.render-after` from `@shopify/ui-extension/customer-account` instead.
*/
Expand All @@ -304,7 +304,7 @@ export interface ExtensionTargets {
>;
/**
* A static extension target that renders on every line item, inside the details
* under the line item properties element on the Order Status Page.
* under the line item properties element on the **Order status** page.
*
* @deprecated Use `customer-account.order-status.cart-line-item.render-after` instead.
*/
Expand All @@ -315,7 +315,7 @@ export interface ExtensionTargets {
AnyComponent
>;
/**
* A static extension target that is rendered after all line items on the Order Status page.
* A static extension target that is rendered after all line items on the **Order status** page.
*
* @deprecated Use `customer-account.order-status.cart-line-list.render-after` from `@shopify/ui-extension/customer-account` instead.
*/
Expand All @@ -325,7 +325,7 @@ export interface ExtensionTargets {
AnyComponent
>;
/**
* A static extension target that is rendered after all line items on the Order Status page.
* A static extension target that is rendered after all line items on the **Order status** page.
*
* @deprecated Use `customer-account.order-status.cart-line-list.render-after` from `@shopify/ui-extension/customer-account` instead.
*/
Expand All @@ -335,7 +335,7 @@ export interface ExtensionTargets {
AnyComponent
>;
/**
* A static extension target that is rendered after a purchase below the customer information on the Order Status page.
* A static extension target that is rendered after a purchase below the customer information on the **Order status** page.
*
* @deprecated Use `customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.
*/
Expand All @@ -345,7 +345,7 @@ export interface ExtensionTargets {
AnyComponent
>;
/**
* A static extension target that is rendered after a purchase below the customer information on the Order Status page.
* A static extension target that is rendered after a purchase below the customer information on the **Order status** page.
*
* @deprecated Use `customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.
*/
Expand Down
12 changes: 6 additions & 6 deletions packages/ui-extensions/src/surfaces/customer-account/targets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export type ExtensionTarget = keyof ExtensionTargets;

export interface OrderStatusExtensionTargets {
/**
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that renders exclusively on the Order Status Page.
* A [dynamic extension target](https://shopify.dev/docs/api/checkout-ui-extensions/extension-targets-overview#dynamic-extension-targets) that renders exclusively on the **Order status** page.
* 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).
*
Expand All @@ -45,7 +45,7 @@ export interface OrderStatusExtensionTargets {
>;
/**
* A static extension target that renders on every line item, inside the details
* under the line item properties element on the Order Status Page.
* under the line item properties element on the **Order status** page.
*/
'customer-account.order-status.cart-line-item.render-after': RenderExtension<
CartLineItemApi &
Expand All @@ -54,7 +54,7 @@ export interface OrderStatusExtensionTargets {
AnyComponent
>;
/**
* A static extension target that is rendered after all line items on the Order Status page.
* A static extension target that is rendered after all line items on the **Order status** page.
*/
'customer-account.order-status.cart-line-list.render-after': RenderExtension<
OrderStatusApi<'customer-account.order-status.cart-line-list.render-after'> &
Expand Down Expand Up @@ -84,7 +84,7 @@ export interface OrderStatusExtensionTargets {
AnyComponent
>;
/**
* A static extension target that is rendered after a purchase below the customer information on the Order Status page.
* A static extension target that is rendered after a purchase below the customer information on the **Order status** page.
*/
'customer-account.order-status.customer-information.render-after': RenderExtension<
OrderStatusApi<'customer-account.order-status.cart-line-list.render-after'> &
Expand Down Expand Up @@ -193,7 +193,7 @@ export type RenderExtensionTarget = {
}[keyof ExtensionTargets];

/**
* A union type containing the extension targets on order status page that follow the pattern of
* A union type containing the extension targets on **Order status** page that follow the pattern of
* accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-ui/tree/main/packages/core)
* and an additional `api` argument, and using those arguments to render
* UI.
Expand All @@ -208,7 +208,7 @@ export type RenderOrderStatusExtensionTarget = {
}[keyof OrderStatusExtensionTargets];

/**
* A union type containing the extension targets on customer account except order status page that follow the pattern of
* A union type containing the extension targets on customer account except **Order status** page that follow the pattern of
* accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-ui/tree/main/packages/core)
* and an additional `api` argument, and using those arguments to render
* UI.
Expand Down

0 comments on commit 1cbdbd1

Please sign in to comment.