@zhuyunjing/file-viewer
v1.0.11
Published
A powerful file preview library for web applications
Readme
file-viewer
A powerful file preview library for web applications
简介
file-viewer 是一个功能强大的文件预览库,支持多种文件格式的在线预览,包括 PDF、图片、视频等。它基于现代 Web 技术构建,提供流畅的预览体验和丰富的交互功能。
特性
- 📄 PDF 预览:支持 PDF 文件的在线预览,包括缩放、旋转、翻页等功能
- 🖼️ 图片预览:支持常见图片格式的预览
- 📋 OFD 预览:支持 OFD 文件的在线预览
- 🚀 高性能:基于 PDF.js 等成熟技术,提供流畅的预览体验
- 📱 响应式:适配各种屏幕尺寸
- 🎨 可定制:支持自定义样式和主题
- 🔧 易于集成:简单的 API,易于集成到现有项目中
安装
pnpm install file-viewer pdfjs-dist注意:file-viewer 依赖 pdfjs-dist,需要同时安装。
使用示例
PDF 预览
import { createPdfPreview } from 'file-viewer'
const pdfPreview = createPdfPreview({
url: '/path/to/file.pdf',
container: document.getElementById('pdf-container'),
scale: 'auto',
showToolbar: true,
showSidebar: true
})图片预览
import { createImageViewer } from 'file-viewer'
const imageViewer = createImageViewer({
images: ['/path/to/image1.jpg', '/path/to/image2.jpg'],
container: document.getElementById('image-container'),
mode: 'single',
objectFit: 'contain'
})OFD 预览
import { createOfdPreview } from 'file-viewer'
const ofdPreview = createOfdPreview({
url: '/path/to/file.ofd',
container: document.getElementById('ofd-container'),
scale: 'auto',
showToolbar: true
})依赖
- pdfjs-dist: ^4.10.38 - PDF.js 核心库,用于 PDF 文件的渲染
文档
详细文档请访问:文档地址
许可证
MIT
