Skip to content

Commit 213826b

Browse files
committed
Add missing example descriptions
1 parent 5b9ce42 commit 213826b

File tree

6 files changed

+12
-0
lines changed

6 files changed

+12
-0
lines changed

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/order-api.doc.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ Order data reflects the current POS session and may not include real-time update
5858
"Retrieve an order's name, ID, and associated customer ID",
5959
'order-details',
6060
),
61+
description:
62+
'Access multiple order properties including the order name and customer ID. This example demonstrates accessing `shopify.order.id`, `shopify.order.name`, and `shopify.order.customerId` to display comprehensive order information, enabling order management workflows and customer service features.',
6163
},
6264
],
6365
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/pinpad-api.doc.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ const data: ReferenceEntityTemplateSchema = {
6060
'Configure PinPad options and handle dismissal',
6161
'validation-with-options',
6262
),
63+
description:
64+
'Configure PIN pad options including PIN length requirements, masking, and custom labels. This example shows how to use `showPinPad()` with options like `minPinLength`, `maxPinLength`, `masked`, `title`, and `onDismissed` callback to create a fully configured PIN entry experience with proper validation and dismissal handling.',
6365
},
6466
],
6567
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/product-api.doc.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ const data: ReferenceEntityTemplateSchema = {
3636
'Retrieve product and product variant IDs',
3737
'product-variant',
3838
),
39+
description:
40+
'Access both product and variant identifiers to implement variant-specific functionality. This example shows how to retrieve `shopify.product.id` and `shopify.product.variantId` together, enabling variant-aware features like inventory checks, variant-specific pricing, or detailed product information displays.',
3941
},
4042
],
4143
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/scanner-api.doc.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ const data: ReferenceEntityTemplateSchema = {
6060
'Subscribe to scanner data events and track scanning history',
6161
'scanner-data-subscribe',
6262
),
63+
description:
64+
'Subscribe to real-time scan events and maintain a history of scanned items. This example demonstrates using `shopify.scanner.scannerData.current.subscribe()` to capture scan data, source information, and timestamps, enabling features like scan logging, bulk scanning workflows, or scan history review.',
6365
},
6466
],
6567
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/session-api.doc.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ const data: ReferenceEntityTemplateSchema = {
5959
'Access properties associated with the current session',
6060
'current-session',
6161
),
62+
description:
63+
'Access comprehensive session information including shop details, user data, and location information. This example shows how to use `shopify.session.currentSession` to retrieve shop ID, domain, currency, user ID, location ID, staff member ID, and POS version, enabling location-aware features and personalized experiences.',
6264
},
6365
],
6466
},

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/toast-api.doc.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ const data: ReferenceEntityTemplateSchema = {
5959
'Display a toast notification for a custom duration',
6060
'show-with-duration',
6161
),
62+
description:
63+
'Configure custom display durations for toast notifications to match message importance and length. This example demonstrates using the `duration` option with `shopify.toast.show()` to control how long notifications remain visible, from quick 2-second confirmations to longer 8-second messages that require more reading time.',
6264
},
6365
],
6466
},

0 commit comments

Comments
 (0)