Skip to content

armgit / ui

Public Imported from GitHub
0
TypeScript

Register document viewer sidebar component

Andrew Luo75cdf48c80ce
diff --git a/apps/v4/content/docs/components/document-viewer-sidebar.mdx b/apps/v4/content/docs/components/document-viewer-sidebar.mdx
new file mode 100644
index 0000000..7b5506d
--- /dev/null
+++ b/apps/v4/content/docs/components/document-viewer-sidebar.mdx
@@ -0,0 +1,66 @@
+---
+title: Document Viewer Sidebar
+description: Shared responsive thumbnail sidebar behavior for PDF, DOCX, and other document viewers.
+component: true
+---
+
+Document Viewer Sidebar provides the responsive shell used by document viewers to show thumbnail navigation inline on wider layouts and as an overlay on narrower layouts.
+
+## Installation
+
+<CodeTabs>
+
+<TabsList>
+ <TabsTrigger value="cli">Command</TabsTrigger>
+ <TabsTrigger value="manual">Manual</TabsTrigger>
+</TabsList>
+<TabsContent value="cli">
+
+```bash
+npx shadcn@latest add https://ui.extend.ai/r/document-viewer-sidebar.json
+```
+
+</TabsContent>
+
+<TabsContent value="manual">
+
+<Steps className="mb-0 pt-2">
+
+<Step>Copy `components/ui/document-viewer-sidebar.tsx` from the registry item into your project.</Step>
+
+<Step>Update the import paths to match your project setup.</Step>
+
+</Steps>
+
+</TabsContent>
+
+</CodeTabs>
+
+## API Reference
+
+### DocumentViewerThumbnailSidebar
+
+The DocumentViewerThumbnailSidebar component renders a responsive sidebar container for document thumbnails.
+
+| Prop | Type | Default | Required |
+| ----------- | ----------------- | ------- | -------- |
+| `children` | `React.ReactNode` | `-` | Yes |
+| `className` | `string` | `-` | No |
+| `inline` | `boolean` | `-` | Yes |
+| `open` | `boolean` | `-` | Yes |
+
+### DocumentViewerSidebarSkeleton
+
+The DocumentViewerSidebarSkeleton component renders the sidebar loading state used while document thumbnails are not ready.
+
+| Prop | Type | Default | Required |
+| -------- | --------- | ------- | -------- |
+| `inline` | `boolean` | `-` | Yes |
+
+### useElementWidth
+
+The useElementWidth hook returns a ref and measured width for responsive viewer layout decisions.
+
+### useInlineThumbnailSidebar
+
+The useInlineThumbnailSidebar hook returns whether the sidebar should render inline for a measured viewer width.
diff --git a/apps/v4/content/docs/components/meta.json b/apps/v4/content/docs/components/meta.json
index f382044..9b99ee4 100644
--- a/apps/v4/content/docs/components/meta.json
+++ b/apps/v4/content/docs/components/meta.json
@@ -13,6 +13,7 @@
"file-thumbnail",
"ocr-blocks",
"e-signature",
- "document-splits"
+ "document-splits",
+ "document-viewer-sidebar"
]
}
diff --git a/apps/v4/registry.json b/apps/v4/registry.json
index ae3c475..a006366 100644
--- a/apps/v4/registry.json
+++ b/apps/v4/registry.json
@@ -560,21 +560,6 @@
}
]
},
- {
- "name": "document-viewer-sidebar",
- "type": "registry:ui",
- "title": "Document Viewer Sidebar",
- "description": "Shared thumbnail sidebar behavior for document viewers, including viewer-width responsive overlay and inline modes.",
- "registryDependencies": ["utils"],
- "categories": ["documents"],
- "files": [
- {
- "path": "components/ui/document-viewer-sidebar.tsx",
- "type": "registry:ui",
- "target": "@ui/document-viewer-sidebar.tsx"
- }
- ]
- },
{
"name": "pdf-viewer",
"type": "registry:ui",
@@ -922,6 +907,21 @@
"target": "@components/blocks/docx-editor.tsx"
}
]
+ },
+ {
+ "name": "document-viewer-sidebar",
+ "type": "registry:ui",
+ "title": "Document Viewer Sidebar",
+ "description": "Shared thumbnail sidebar behavior for document viewers, including viewer-width responsive overlay and inline modes.",
+ "registryDependencies": ["utils"],
+ "categories": ["documents"],
+ "files": [
+ {
+ "path": "components/ui/document-viewer-sidebar.tsx",
+ "type": "registry:ui",
+ "target": "@ui/document-viewer-sidebar.tsx"
+ }
+ ]
}
]
}