Skip to content

Commit d8e1489

Browse files
authored
Merge pull request #3687 from Shopify/cappslock/chore/2026-01-rc/bug-bash-cleanups
POS PWC 2026-01-RC cleanups from bug bash
2 parents b56d629 + b7fd190 commit d8e1489

File tree

9 files changed

+14
-9
lines changed

9 files changed

+14
-9
lines changed
1.43 KB
Loading
1.29 KB
Loading

packages/ui-extensions/src/surfaces/point-of-sale/components/Embed/Embed.doc.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
33
const data: ReferenceEntityTemplateSchema = {
44
name: 'Embed',
55
description:
6-
'The `Embed` component displays a preview of printable content from a specified source URL. Use it to show users what will be printed before triggering the actual print operation.\n\n`Embed` works in conjunction with the Print API to provide complete print functionality from preview to execution.\n\nSupported document types:\n\n- **HTML documents** (`.html`, `.htm`) - Best printing experience with full CSS styling, embedded images, and complex layouts. Use for receipts, invoices, and formatted reports.\n\n- **Text files** (`.txt`, `.csv`) - Plain text with basic content and tabular data support. Use for simple receipts and data exports.\n\n- **Image files** (`.png`, `.jpg`, `.jpeg`, `.gif`, `.bmp`, `.webp`) - Common web formats with format-specific optimizations. Use for logos, charts, QR codes, and barcodes.\n\n- **PDF files** (`.pdf`) - Behavior varies by platform: prints directly on iOS/desktop, but downloads to external viewer on Android. Use for complex documents and compliance requirements.\n\n[Learn how to build a print extension in POS](/docs/apps/build/pos/build-print-extension).',
6+
'The `Embed` component displays a preview of printable content from a specified source URL. Use it to show users what will be printed before triggering the actual print operation.\n\n`Embed` works in conjunction with the Print API to provide complete print functionality from preview to execution.\n\nSupported document types:\n\n- **HTML documents** (`.html`, `.htm`) - Best printing experience with full CSS styling, embedded images, and complex layouts. Use for receipts, invoices, and formatted reports.\n\n- **Text files** (`.txt`, `.csv`) - Plain text with basic content and tabular data support. Use for simple receipts and data exports.\n\n- **PDF files** (`.pdf`) - Behavior varies by platform: prints directly on iOS/desktop, but downloads to external viewer on Android. Use for complex documents and compliance requirements.\n\n[Learn how to build a print extension in POS](/docs/apps/build/pos/build-print-extension).',
77
isVisualComponent: true,
88
type: 'component',
99
thumbnail: 'embed-thumbnail.png',
@@ -21,7 +21,7 @@ const data: ReferenceEntityTemplateSchema = {
2121
defaultExample: {
2222
image: 'embed-default.png',
2323
description:
24-
'Display a preview of printable content before triggering the print operation. This example shows how to use Embed with HTML documents, PDFs, images, or text files, supporting various document formats with proper rendering for receipts, invoices, and formatted reports.',
24+
'Display a preview of printable content before triggering the print operation. This example shows how to use Embed with HTML documents, PDFs, or text files, supporting various document formats with proper rendering for receipts, invoices, and formatted reports.',
2525
codeblock: {
2626
title: 'Preview printable content',
2727
tabs: [{code: './examples/embed.html', language: 'html'}],

packages/ui-extensions/src/surfaces/point-of-sale/components/Link/Link.doc.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ const data: ReferenceEntityTemplateSchema = {
1515
'Configure the following properties on the `Link` component.',
1616
type: 'Link',
1717
},
18+
{
19+
title: 'Events',
20+
description:
21+
'The `Link` component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).',
22+
type: 'LinkEvents',
23+
},
1824
],
1925
category: 'Polaris web components',
2026
subCategory: 'Actions',
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<s-link>Tappable link</s-link>
1+
<s-link onClick={handleLinkTap}>Tappable link</s-link>

packages/ui-extensions/src/surfaces/point-of-sale/components/Spinner/Spinner.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const data: ReferenceEntityTemplateSchema = {
4141
- **Provide accessibility labels:** Always use \`accessibilityLabel\` to describe what is loading, helping screen reader users understand the context.
4242
- **Position strategically:** Place spinners where content will appear, or center them in the loading area to provide clear visual feedback.
4343
- **Don't overuse:** Avoid multiple spinners on the same screen. Use a single spinner to represent the overall loading state when possible.
44-
- **Consider alternatives for long waits:** For operations taking more than a few seconds, consider using progress indicators or status messages instead.
44+
- **Consider alternatives for long waits:** For operations taking more than a few seconds, consider using status messages instead.
4545
`,
4646
},
4747
],

packages/ui-extensions/src/surfaces/point-of-sale/components/Switch/Switch.doc.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ const data: ReferenceEntityTemplateSchema = {
2626
subCategory: 'Forms',
2727
defaultExample: {
2828
image: 'switch-default.png',
29-
description:
30-
'Toggle settings on or off using a `Switch` component. This example shows a basic switch with a label.',
29+
description: 'Toggle settings on or off using a `Switch` component.',
3130
codeblock: {
3231
title: 'Create a toggle switch',
3332
tabs: [
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
<s-switch label="Option 1" />
2-
<s-switch label="Option 2" defaultChecked />
1+
<s-switch />
2+
<s-switch defaultChecked />

packages/ui-extensions/src/surfaces/point-of-sale/components/Tabs/Tabs.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ const data: ReferenceEntityTemplateSchema = {
6464
sectionContent: `
6565
- **Provide accessibility labels:** Use the \`accessibilityLabel\` prop on the \`Tabs\` component to describe the purpose of the tab group.
6666
- **Ensure keyboard navigation:** The component supports arrow key navigation between tabs and Enter/Space to activate tabs.
67-
- **Connect tabs and panels:** Always use matching \`controls\` (on Tab) and \`id\` (on TabPanel) properties to maintain proper ARIA relationships.
67+
- **Connect tabs and panels:** Always use matching \`controls\` (on Tab) and \`id\` (on TabPanel) properties to maintain proper semantic relationships.
6868
`,
6969
},
7070
],

0 commit comments

Comments
 (0)