feat: Add PDF viewer and preview components with styling and functionality

- Implemented DeesPdfViewer for full-featured PDF viewing with toolbar and sidebar navigation.
- Created DeesPdfPreview for lightweight PDF previews.
- Introduced PdfManager for managing PDF document loading and caching.
- Added CanvasPool for efficient canvas management.
- Developed utility functions for performance monitoring and file size formatting.
- Established styles for viewer and preview components to enhance UI/UX.
- Included demo examples for showcasing PDF viewer capabilities.
This commit is contained in:
2025-09-20 11:42:22 +00:00
parent c33ad2e405
commit a61f57db13
14 changed files with 1726 additions and 2 deletions

View File

@@ -0,0 +1,290 @@
import { DeesElement, property, html, customElement, domtools, type TemplateResult, css, cssManager } from '@design.estate/dees-element';
import { PdfManager } from '../dees-pdf-shared/PdfManager.js';
import { CanvasPool, type PooledCanvas } from '../dees-pdf-shared/CanvasPool.js';
import { PerformanceMonitor, throttle } from '../dees-pdf-shared/utils.js';
import { previewStyles } from './styles.js';
import { demo as demoFunc } from './demo.js';
declare global {
interface HTMLElementTagNameMap {
'dees-pdf-preview': DeesPdfPreview;
}
}
@customElement('dees-pdf-preview')
export class DeesPdfPreview extends DeesElement {
public static demo = demoFunc;
public static styles = previewStyles;
@property({ type: String })
public pdfUrl: string = '';
@property({ type: Number })
public maxPages: number = 3;
@property({ type: Number })
public stackOffset: number = 8;
@property({ type: Boolean })
public clickable: boolean = true;
@property({ type: Number })
private pageCount: number = 0;
@property({ type: Boolean })
private loading: boolean = false;
@property({ type: Boolean })
private rendered: boolean = false;
@property({ type: Boolean })
private error: boolean = false;
private observer: IntersectionObserver;
private pdfDocument: any;
private canvases: PooledCanvas[] = [];
private renderRequestId: number;
constructor() {
super();
}
public render(): TemplateResult {
return html`
<div
class="preview-container ${this.loading ? 'loading' : ''} ${this.error ? 'error' : ''} ${this.clickable ? 'clickable' : ''}"
@click=${this.handleClick}
>
${this.loading ? html`
<div class="preview-loading">
<div class="preview-spinner"></div>
<div class="preview-text">Loading preview...</div>
</div>
` : ''}
${this.error ? html`
<div class="preview-error">
<dees-icon icon="lucide:FileX"></dees-icon>
<div class="preview-text">Failed to load PDF</div>
</div>
` : ''}
${!this.loading && !this.error ? html`
<div class="preview-stack">
${this.getStackedCanvases()}
</div>
${this.pageCount > 0 ? html`
<div class="preview-info">
<dees-icon icon="lucide:FileText"></dees-icon>
<span class="preview-pages">${this.pageCount} page${this.pageCount > 1 ? 's' : ''}</span>
</div>
` : ''}
${this.clickable ? html`
<div class="preview-overlay">
<dees-icon icon="lucide:Eye"></dees-icon>
<span>View PDF</span>
</div>
` : ''}
` : ''}
</div>
`;
}
private getStackedCanvases(): TemplateResult[] {
const pagesToShow = Math.min(this.pageCount, this.maxPages);
const canvases: TemplateResult[] = [];
for (let i = pagesToShow - 1; i >= 0; i--) {
const offset = i * this.stackOffset;
canvases.push(html`
<canvas
class="preview-canvas"
data-page="${i + 1}"
style="
top: ${offset}px;
left: ${offset}px;
z-index: ${pagesToShow - i};
${i > 0 ? `box-shadow: 0 2px 8px rgba(0, 0, 0, ${0.1 + (i * 0.05)});` : ''}
"
></canvas>
`);
}
return canvases;
}
public async connectedCallback() {
super.connectedCallback();
this.setupIntersectionObserver();
}
public async disconnectedCallback() {
super.disconnectedCallback();
this.cleanup();
}
private setupIntersectionObserver() {
const options = {
root: null,
rootMargin: '200px',
threshold: 0.01,
};
this.observer = new IntersectionObserver(
throttle((entries) => {
for (const entry of entries) {
if (entry.isIntersecting && !this.rendered && this.pdfUrl) {
this.loadAndRenderPreview();
} else if (!entry.isIntersecting && this.rendered) {
// Optional: Clear canvases when out of view for memory optimization
// this.clearCanvases();
}
}
}, 100),
options
);
this.observer.observe(this);
}
private async loadAndRenderPreview() {
if (this.rendered || this.loading) return;
this.loading = true;
this.error = false;
PerformanceMonitor.mark(`preview-load-${this.pdfUrl}`);
try {
this.pdfDocument = await PdfManager.loadDocument(this.pdfUrl);
this.pageCount = this.pdfDocument.numPages;
await this.updateComplete;
await this.renderPages();
this.rendered = true;
const duration = PerformanceMonitor.measure(`preview-render-${this.pdfUrl}`, `preview-load-${this.pdfUrl}`);
console.log(`PDF preview rendered in ${duration}ms`);
} catch (error) {
console.error('Failed to load PDF preview:', error);
this.error = true;
} finally {
this.loading = false;
}
}
private async renderPages() {
const canvasElements = this.shadowRoot?.querySelectorAll('.preview-canvas') as NodeListOf<HTMLCanvasElement>;
const pagesToRender = Math.min(this.pageCount, this.maxPages);
// Release old canvases
this.clearCanvases();
// Calculate available width for preview (container width minus padding and stacking offset)
const containerWidth = 160; // 200px container - 40px padding
const maxStackOffset = (pagesToRender - 1) * this.stackOffset;
const availableWidth = containerWidth - maxStackOffset;
// Render pages in reverse order (back to front for stacking)
for (let i = 0; i < pagesToRender; i++) {
const canvas = canvasElements[i];
if (!canvas) continue;
const pageNum = parseInt(canvas.dataset.page || '1');
const page = await this.pdfDocument.getPage(pageNum);
// Calculate scale to fit within available width
const initialViewport = page.getViewport({ scale: 1 });
const scale = Math.min(availableWidth / initialViewport.width, 0.5); // Cap at 0.5 for quality
const viewport = page.getViewport({ scale });
// Acquire canvas from pool
const pooledCanvas = CanvasPool.acquire(viewport.width, viewport.height);
this.canvases.push(pooledCanvas);
// Render to pooled canvas first
const renderContext = {
canvasContext: pooledCanvas.ctx,
viewport: viewport,
};
await page.render(renderContext).promise;
// Transfer to display canvas
canvas.width = viewport.width;
canvas.height = viewport.height;
canvas.style.width = `${viewport.width}px`;
canvas.style.height = `${viewport.height}px`;
const ctx = canvas.getContext('2d');
if (ctx) {
ctx.drawImage(pooledCanvas.canvas, 0, 0);
}
// Release page to free memory
page.cleanup();
}
}
private clearCanvases() {
// Cancel any pending render
if (this.renderRequestId) {
cancelAnimationFrame(this.renderRequestId);
this.renderRequestId = 0;
}
// Release pooled canvases
for (const pooledCanvas of this.canvases) {
CanvasPool.release(pooledCanvas);
}
this.canvases = [];
}
private cleanup() {
if (this.observer) {
this.observer.disconnect();
}
this.clearCanvases();
if (this.pdfUrl && this.pdfDocument) {
PdfManager.releaseDocument(this.pdfUrl);
this.pdfDocument = null;
}
this.rendered = false;
}
private handleClick() {
if (!this.clickable) return;
// Dispatch custom event for parent to handle
this.dispatchEvent(new CustomEvent('pdf-preview-click', {
detail: {
pdfUrl: this.pdfUrl,
pageCount: this.pageCount,
},
bubbles: true,
composed: true,
}));
}
public async updated(changedProperties: Map<PropertyKey, unknown>) {
super.updated(changedProperties);
if (changedProperties.has('pdfUrl') && this.pdfUrl) {
this.cleanup();
this.rendered = false;
// Check if in viewport and render if so
if (this.observer) {
const rect = this.getBoundingClientRect();
if (rect.top < window.innerHeight && rect.bottom > 0) {
this.loadAndRenderPreview();
}
}
}
}
}

View File

@@ -0,0 +1,189 @@
import { html } from '@design.estate/dees-element';
export const demo = () => {
const samplePdfs = [
'https://raw.githubusercontent.com/mozilla/pdf.js/ba2edeae/examples/learning/helloworld.pdf',
'https://raw.githubusercontent.com/mozilla/pdf.js/ba2edeae/web/compressed.tracemonkey-pldi-09.pdf',
];
const generateGridItems = (count: number) => {
const items = [];
for (let i = 0; i < count; i++) {
const pdfUrl = samplePdfs[i % samplePdfs.length];
items.push(html`
<dees-pdf-preview
pdfUrl="${pdfUrl}"
maxPages="3"
stackOffset="6"
clickable="true"
grid-mode
@pdf-preview-click=${(e: CustomEvent) => {
console.log('PDF Preview clicked:', e.detail);
alert(`PDF clicked: ${e.detail.pageCount} pages`);
}}
></dees-pdf-preview>
`);
}
return items;
};
return html`
<style>
.demo-container {
padding: 40px;
background: #f5f5f5;
}
.demo-section {
margin-bottom: 60px;
}
h3 {
margin-bottom: 20px;
font-size: 18px;
font-weight: 600;
}
.preview-grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
gap: 24px;
}
.preview-row {
display: flex;
gap: 24px;
align-items: center;
margin-bottom: 20px;
}
.preview-label {
font-size: 14px;
font-weight: 500;
min-width: 100px;
}
.performance-stats {
margin-top: 20px;
padding: 16px;
background: white;
border-radius: 8px;
font-size: 14px;
}
.stats-grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(150px, 1fr));
gap: 12px;
margin-top: 12px;
}
.stat-item {
display: flex;
flex-direction: column;
gap: 4px;
}
.stat-label {
font-size: 12px;
color: #666;
}
.stat-value {
font-size: 16px;
font-weight: 600;
}
</style>
<div class="demo-container">
<div class="demo-section">
<h3>Single PDF Preview with Stacked Pages</h3>
<dees-pdf-preview
pdfUrl="https://raw.githubusercontent.com/mozilla/pdf.js/ba2edeae/web/compressed.tracemonkey-pldi-09.pdf"
maxPages="3"
stackOffset="8"
clickable="true"
></dees-pdf-preview>
</div>
<div class="demo-section">
<h3>Different Sizes</h3>
<div class="preview-row">
<div class="preview-label">Small:</div>
<dees-pdf-preview
size="small"
pdfUrl="https://raw.githubusercontent.com/mozilla/pdf.js/ba2edeae/examples/learning/helloworld.pdf"
maxPages="2"
stackOffset="6"
clickable="true"
></dees-pdf-preview>
</div>
<div class="preview-row">
<div class="preview-label">Default:</div>
<dees-pdf-preview
pdfUrl="https://raw.githubusercontent.com/mozilla/pdf.js/ba2edeae/examples/learning/helloworld.pdf"
maxPages="3"
stackOffset="8"
clickable="true"
></dees-pdf-preview>
</div>
<div class="preview-row">
<div class="preview-label">Large:</div>
<dees-pdf-preview
size="large"
pdfUrl="https://raw.githubusercontent.com/mozilla/pdf.js/ba2edeae/examples/learning/helloworld.pdf"
maxPages="4"
stackOffset="10"
clickable="true"
></dees-pdf-preview>
</div>
</div>
<div class="demo-section">
<h3>Non-Clickable Preview</h3>
<dees-pdf-preview
pdfUrl="https://raw.githubusercontent.com/mozilla/pdf.js/ba2edeae/examples/learning/helloworld.pdf"
maxPages="3"
stackOffset="8"
clickable="false"
></dees-pdf-preview>
</div>
<div class="demo-section">
<h3>Performance Grid - 50 PDFs with Lazy Loading</h3>
<p style="margin-bottom: 20px; font-size: 14px; color: #666;">
This grid demonstrates the performance optimizations with 50 PDF previews.
Scroll to see lazy loading in action - previews render only when visible.
</p>
<div class="preview-grid">
${generateGridItems(50)}
</div>
<div class="performance-stats">
<h4>Performance Features</h4>
<div class="stats-grid">
<div class="stat-item">
<span class="stat-label">Lazy Loading</span>
<span class="stat-value">✓ Enabled</span>
</div>
<div class="stat-item">
<span class="stat-label">Canvas Pooling</span>
<span class="stat-value">✓ Active</span>
</div>
<div class="stat-item">
<span class="stat-label">Memory Management</span>
<span class="stat-value">✓ Optimized</span>
</div>
<div class="stat-item">
<span class="stat-label">Intersection Observer</span>
<span class="stat-value">200px margin</span>
</div>
</div>
</div>
</div>
</div>
`;
};

View File

@@ -0,0 +1 @@
export * from './component.js';

View File

@@ -0,0 +1,177 @@
import { css, cssManager } from '@design.estate/dees-element';
export const previewStyles = [
cssManager.defaultStyles,
css`
:host {
display: inline-block;
position: relative;
}
.preview-container {
position: relative;
width: 200px;
height: 260px;
background: ${cssManager.bdTheme('hsl(0 0% 100%)', 'hsl(215 20% 16%)')};
border: 1px solid ${cssManager.bdTheme('hsl(214 31% 91%)', 'hsl(217 25% 26%)')};
border-radius: 12px;
overflow: hidden;
transition: transform 0.2s ease, box-shadow 0.2s ease;
}
.preview-container.clickable {
cursor: pointer;
}
.preview-container.clickable:hover {
transform: translateY(-2px);
box-shadow: 0 8px 24px ${cssManager.bdTheme('rgba(0, 0, 0, 0.12)', 'rgba(0, 0, 0, 0.3)')};
}
.preview-container.clickable:hover .preview-overlay {
opacity: 1;
}
.preview-stack {
position: relative;
width: 100%;
height: 100%;
padding: 20px;
box-sizing: border-box;
}
.preview-canvas {
position: absolute;
background: white;
border: 1px solid ${cssManager.bdTheme('hsl(214 31% 88%)', 'hsl(217 25% 30%)')};
border-radius: 4px;
display: block;
image-rendering: -webkit-optimize-contrast;
image-rendering: crisp-edges;
}
.preview-info {
position: absolute;
bottom: 12px;
left: 12px;
right: 12px;
padding: 8px 12px;
background: ${cssManager.bdTheme('hsl(0 0% 100% / 0.95)', 'hsl(215 20% 12% / 0.95)')};
border: 1px solid ${cssManager.bdTheme('hsl(214 31% 91%)', 'hsl(217 25% 26%)')};
border-radius: 8px;
display: flex;
align-items: center;
gap: 8px;
font-size: 13px;
color: ${cssManager.bdTheme('hsl(215 16% 45%)', 'hsl(215 16% 75%)')};
backdrop-filter: blur(8px);
z-index: 10;
}
.preview-info dees-icon {
font-size: 14px;
color: ${cssManager.bdTheme('hsl(217 91% 60%)', 'hsl(213 93% 68%)')};
}
.preview-pages {
font-weight: 500;
}
.preview-overlay {
position: absolute;
top: 0;
left: 0;
right: 0;
bottom: 0;
background: ${cssManager.bdTheme('rgba(0, 0, 0, 0.7)', 'rgba(0, 0, 0, 0.8)')};
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
gap: 8px;
opacity: 0;
transition: opacity 0.2s ease;
z-index: 20;
}
.preview-overlay dees-icon {
font-size: 24px;
color: white;
}
.preview-overlay span {
font-size: 14px;
font-weight: 500;
color: white;
}
.preview-loading,
.preview-error {
position: absolute;
top: 0;
left: 0;
right: 0;
bottom: 0;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
gap: 12px;
color: ${cssManager.bdTheme('hsl(215 16% 45%)', 'hsl(215 16% 75%)')};
}
.preview-loading {
background: ${cssManager.bdTheme('hsl(0 0% 99%)', 'hsl(215 20% 14%)')};
}
.preview-error {
background: ${cssManager.bdTheme('hsl(0 72% 98%)', 'hsl(0 62% 20%)')};
color: ${cssManager.bdTheme('hsl(0 72% 40%)', 'hsl(0 70% 68%)')};
}
.preview-spinner {
width: 24px;
height: 24px;
border-radius: 50%;
border: 2px solid ${cssManager.bdTheme('hsl(214 31% 86%)', 'hsl(217 25% 28%)')};
border-top-color: ${cssManager.bdTheme('hsl(217 91% 60%)', 'hsl(213 93% 68%)')};
animation: spin 0.8s linear infinite;
}
@keyframes spin {
to {
transform: rotate(360deg);
}
}
.preview-text {
font-size: 13px;
font-weight: 500;
}
.preview-error dees-icon {
font-size: 32px;
}
/* Responsive sizes */
:host([size="small"]) .preview-container {
width: 150px;
height: 195px;
}
:host([size="large"]) .preview-container {
width: 250px;
height: 325px;
}
/* Grid optimizations */
:host([grid-mode]) .preview-container {
will-change: auto;
}
:host([grid-mode]) .preview-canvas {
image-rendering: -webkit-optimize-contrast;
image-rendering: crisp-edges;
}
`,
];