Merge pull request #2568 from Shopify/vic/print-preview-doc-stack

Add note for print preview
Shopify · Jan 17, 2025 · 4de072e · 4de072e
2 parents 46f5749 + 29a9a36
commit 4de072e
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/PrintPreview.doc.ts b/packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/PrintPreview.doc.ts
@@ -6,14 +6,18 @@ const generateCodeBlockForPrintPreview = (title: string, fileName: string) =>
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'PrintPreview',
-  description: `A component that displays a preview of a printable document. Use this component to let users review documents before printing.`,
+  description: `
+  A component that displays a preview of a printable document. 
+  > Note:
+  > This component must be a direct child of the Screen component and cannot be nested inside any other component.`,
   isVisualComponent: true,
   type: 'component',
   thumbnail: 'print-preview-thumbnail.png',
   definitions: [
     {
       title: 'PrintPreview',
-      description: 'Renders a preview of a printable document',
+      description:
+        'Renders a preview of a printable document. This component must a direct child of the Screen component.',
       type: 'PrintPreviewProps',
     },
   ],