Skip to content

Commit d33d890

Browse files
authored
Consistent casing for admin UI extensions term (#4025)
1 parent 4522987 commit d33d890

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

packages/ui-extensions/src/surfaces/admin/api/picker/picker.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ const data: ReferenceEntityTemplateSchema = {
112112
subCategory: 'Utility APIs',
113113
thumbnail: 'picker.png',
114114
requires:
115-
'an Admin UI [block, action, or print](/docs/api/admin-extensions/{API_VERSION}#building-your-extension) extension.',
115+
'an admin UI [block, action, or print](/docs/api/admin-extensions/{API_VERSION}#building-your-extension) extension.',
116116
defaultExample: {
117117
description:
118118
'Build a custom picker for email templates with multiple columns and status badges. This example shows defining column headers, populating items with searchable data fields, adding visual status indicators, and handling the selection promise. Use this pattern for app-specific resources like templates, product reviews, or subscription options where you need custom data structures beyond standard Shopify resources.',

packages/ui-extensions/src/surfaces/admin/api/resource-picker/resource-picker.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ const data: ReferenceEntityTemplateSchema = {
171171
subCategory: 'Utility APIs',
172172
thumbnail: 'resource-picker.png',
173173
requires:
174-
'an Admin UI [block, action, or print](/docs/api/admin-extensions/{API_VERSION}#building-your-extension) extension.',
174+
'an admin UI [block, action, or print](/docs/api/admin-extensions/{API_VERSION}#building-your-extension) extension.',
175175
defaultExample: {
176176
description:
177177
'Open the product resource picker to select items from the store catalog. This example invokes `shopify.resourcePicker` with `type: "product"`, handles the async selection, and displays the count of selected products. When merchants confirm their selection, the resource picker returns an array of product objects with GIDs, titles, and handles for use in your extension.',

packages/ui-extensions/src/surfaces/admin/api/standard/standard.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
33
const data: ReferenceEntityTemplateSchema = {
44
name: 'Standard API',
55
description:
6-
'The Standard API provides core functionality available to all Admin UI extension types. Use this API to authenticate with your app backend, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, and handle intent-based navigation.',
6+
'The Standard API provides core functionality available to all admin UI extension types. Use this API to authenticate with your app backend, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, and handle intent-based navigation.',
77
isVisualComponent: false,
88
type: 'API',
99
defaultExample: {

packages/ui-extensions/src/surfaces/admin/extension-targets.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ type OrderRoutingComponents = AnyComponentBuilder<
4343
>;
4444

4545
/**
46-
* The set of UI components available for all Admin UI extension targets. This includes all standard Polaris components except for specialized components used in specific contexts. Use this type to define which components can be rendered in your extension.
46+
* The set of UI components available for all admin UI extension targets. This includes all standard Polaris components except for specialized components used in specific contexts. Use this type to define which components can be rendered in your extension.
4747
*/
4848
type AllComponents = AnyComponentBuilder<
4949
Omit<
@@ -677,7 +677,7 @@ export interface ExtensionTargets {
677677
}
678678

679679
/**
680-
* A string literal union of all valid extension target identifiers. Use this type to specify where your Admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components.
680+
* A string literal union of all valid extension target identifiers. Use this type to specify where your admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components.
681681
*/
682682
export type ExtensionTarget = keyof ExtensionTargets;
683683

0 commit comments

Comments
 (0)