React File Preview

English | 简体中文

一个现代化、功能丰富的 React 文件预览组件,支持图片、视频、音频、PDF、Office 文档(Word、Excel、PowerPoint)、Markdown 和代码文件预览。

✨ 特性

• 🎨 现代化 UI - Apple 风格的简约设计,毛玻璃效果
• 📁 多格式支持 - 支持 20+ 种文件格式
• 🪟 两种展示模式 - 全屏弹窗 或 嵌入式内联预览
• 🖼️ 强大的图片查看器 - 缩放、旋转、拖拽、滚轮缩放
• 🎬 自定义视频播放器 - 基于 Video.js,支持多种视频格式
• 🎵 自定义音频播放器 - 精美的音频控制界面
• 📄 PDF 查看器 - 支持分页浏览
• 📊 Office 文档支持 - Word、Excel、PowerPoint 文件预览
• 📝 Markdown 渲染 - 支持 GitHub Flavored Markdown
• 💻 代码高亮 - 支持 40+ 种编程语言
• 🎭 流畅动画 - 基于 Framer Motion
• 📱 响应式设计 - 适配各种屏幕尺寸
• ⌨️ 键盘导航 - 支持方向键和 ESC 键
• 🎯 拖拽上传 - 支持拖拽文件上传

📦 安装

# 使用 npm
npm install react-file-preview

# 使用 yarn
yarn add react-file-preview

# 使用 pnpm
pnpm add react-file-preview

重要提示： 你还需要导入 CSS 文件：

import 'react-file-preview/style.css';

PDF.js 配置（可选）

如果你需要预览 PDF 文件，建议配置 PDF.js 使用本地静态文件以提高性能和稳定性：

方式 1: 使用 CDN（默认）

默认情况下，组件会自动使用 unpkg CDN 加载 PDF.js，无需额外配置。

方式 2: 使用本地静态文件（推荐用于生产环境）

1. 将 PDF.js 文件复制到你的 public 目录：

# 从 node_modules 复制 PDF.js 文件到 public 目录
cp -r node_modules/pdfjs-dist/build/pdf.worker.min.mjs public/pdfjs/
cp -r node_modules/pdfjs-dist/cmaps public/pdfjs/

2. 在应用入口配置 PDF.js：

import { configurePdfjs } from '@eternalheart/react-file-preview';

// 配置使用本地静态文件
configurePdfjs({
  workerSrc: '/pdfjs/pdf.worker.min.mjs',
  cMapUrl: '/pdfjs/cmaps/',
  cMapPacked: true
});

使用 Vite 自动复制（推荐）

在 vite.config.ts 中配置自动复制：

import { defineConfig } from 'vite';
import { viteStaticCopy } from 'vite-plugin-static-copy';

export default defineConfig({
  plugins: [
    viteStaticCopy({
      targets: [
        {
          src: 'node_modules/pdfjs-dist/build/pdf.worker.min.mjs',
          dest: 'pdfjs'
        },
        {
          src: 'node_modules/pdfjs-dist/cmaps',
          dest: 'pdfjs'
        }
      ]
    })
  ]
});

然后在应用入口配置：

import { configurePdfjs } from '@eternalheart/react-file-preview';

configurePdfjs({
  workerSrc: '/pdfjs/pdf.worker.min.mjs',
  cMapUrl: '/pdfjs/cmaps/',
  cMapPacked: true
});

🚀 快速开始

📖 第一次使用？ 查看 快速开始指南 获取 5 分钟入门教程！

基础用法

import { FilePreviewModal } from 'react-file-preview';
import 'react-file-preview/style.css';
import { useState } from 'react';

function App() {
  const [files, setFiles] = useState([]);
  const [currentIndex, setCurrentIndex] = useState(0);
  const [isOpen, setIsOpen] = useState(false);

  const handleFileSelect = (file: File) => {
    // 方法 1: 直接传入 File 对象（推荐）
    setFiles([file]);
    setCurrentIndex(0);
    setIsOpen(true);
  };

  return (
    <>
      <input
        type="file"
        onChange={(e) => e.target.files?.[0] && handleFileSelect(e.target.files[0])}
      />

      <FilePreviewModal
        files={files}
        currentIndex={currentIndex}
        isOpen={isOpen}
        onClose={() => setIsOpen(false)}
        onNavigate={setCurrentIndex}
      />
    </>
  );
}

多种输入类型

组件支持三种类型的文件输入：

import { FilePreviewModal, PreviewFileInput } from '@eternalheart/react-file-preview';
import '@eternalheart/react-file-preview/style.css';

function App() {
  const files: PreviewFileInput[] = [
    // 1. 原生 File 对象
    file1,

    // 2. HTTP URL 字符串
    'https://example.com/image.jpg',

    // 3. 带元数据的文件对象
    {
      name: 'document.pdf',
      type: 'application/pdf',
      url: '/path/to/document.pdf',
      size: 1024,
    },
  ];

  return (
    <FilePreviewModal
      files={files}
      currentIndex={0}
      isOpen={true}
      onClose={() => {}}
    />
  );
}

嵌入模式 (FilePreviewEmbed)

除了全屏弹窗,组件库还提供了嵌入式变体,可以将预览内联渲染到任意 div 容器中,适合详情面板、左右分栏布局、仪表盘等场景。

import { FilePreviewEmbed } from '@eternalheart/react-file-preview';
import '@eternalheart/react-file-preview/style.css';
import { useState } from 'react';

function InlinePreview() {
  const [index, setIndex] = useState(0);

  const files = [
    'https://example.com/image.jpg',
    { name: 'document.pdf', type: 'application/pdf', url: '/doc.pdf' },
  ];

  return (
    // 嵌入式预览默认填充父容器
    <div style={{ width: '100%', height: 520 }}>
      <FilePreviewEmbed
        files={files}
        currentIndex={index}
        onNavigate={setIndex}
      />
    </div>
  );
}

与 FilePreviewModal 的区别:

• 不使用 Portal、无全屏遮罩、没有 isOpen / onClose
• 不显示关闭按钮
• 键盘导航 (←/→) 作用域限定在嵌入容器内 (基于 focus)
• 尺寸默认 width: 100%; height: 100%,可通过 width / height props 覆盖

// 显式指定尺寸
<FilePreviewEmbed files={files} width={800} height={500} />

💡 使用示例

预览 PowerPoint 文件

import { FilePreviewModal } from '@eternalheart/react-file-preview';
import { useState } from 'react';

function PptPreview() {
  const [isOpen, setIsOpen] = useState(false);

  const pptFile = {
    name: 'presentation.pptx',
    type: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
    url: '/path/to/your/presentation.pptx',
  };

  return (
    <>
      <button onClick={() => setIsOpen(true)}>
        预览 PPT
      </button>

      <FilePreviewModal
        files={[pptFile]}
        currentIndex={0}
        isOpen={isOpen}
        onClose={() => setIsOpen(false)}
      />
    </>
  );
}

预览多个文件

const files = [
  { name: 'image.jpg', type: 'image/jpeg', url: '/path/to/image.jpg' },
  { name: 'document.pdf', type: 'application/pdf', url: '/path/to/document.pdf' },
  { name: 'presentation.pptx', type: 'application/vnd.openxmlformats-officedocument.presentationml.presentation', url: '/path/to/presentation.pptx' },
  { name: 'spreadsheet.xlsx', type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', url: '/path/to/spreadsheet.xlsx' },
];

<FilePreviewModal
  files={files}
  currentIndex={0}
  isOpen={isOpen}
  onClose={() => setIsOpen(false)}
  onNavigate={setCurrentIndex}
/>

📖 支持的文件格式

图片

• 格式: JPG, PNG, GIF, WebP, SVG, BMP, ICO
• 功能: 缩放 (0.1x - 10x)、旋转、拖拽、滚轮缩放、双击重置

视频

• 格式: MP4, WebM, OGG, MOV, AVI, MKV, M4V, 3GP, FLV
• 功能: 自定义播放器、进度控制、音量调节、全屏播放

音频

• 格式: MP3, WAV, OGG, M4A, AAC, FLAC
• 功能: 自定义播放器、进度条、音量控制、快进/快退

文档

• PDF: 分页浏览、缩放
• Word: DOCX 格式支持
• Excel: XLSX 格式支持
• PowerPoint: PPTX/PPT 格式支持、幻灯片预览

代码 & 文本

• Markdown: GitHub Flavored Markdown,代码高亮
• 代码文件: JS, TS, Python, Java, C++, Go, Rust 等 40+ 种语言
• 配置 / 日志: YAML, TOML, INI, ENV, LOG, DIFF, PATCH 等

结构化数据

• JSON: 自动格式化 + 语法高亮
• CSV / TSV: 零依赖解析,表格视图 + 行列统计
• XML: DOMParser 校验 + 自动缩进 + 语法高亮

字幕 / 歌词

• SRT / WebVTT: 零依赖解析,结构化 cue 列表(索引、时间区间、文本)
• LRC / Enhanced LRC: 歌词文件,[mm:ss.xx] 行时间戳(ELRC 额外支持行内 <mm:ss.xx> 逐字时间戳),自动解析 [ti:][ar:][al:] 等元数据
• ASS / SSA: Advanced SubStation Alpha,提取 Dialogue 事件,自动剥离 \N \h 与 {...} 样式覆盖码,展示 Style 标签
• TTML / DFXP: W3C / Apple Music 使用的 XML 字幕,支持 begin / end / dur 与 <br/>

压缩包

• ZIP: 树形目录 + 内嵌预览文本/代码/图片,其他类型可下载导出

Outlook 邮件

• MSG: 邮件头、正文、附件列表

电子书

• EPUB: 章节导航、翻页

🎮 API 参考

FilePreviewModal Props

| 属性 | 类型 | 必填 | 说明 | |------|------|------|------| | files | PreviewFileInput[] | ✅ | 文件列表（支持 File 对象、文件对象或 URL 字符串） | | currentIndex | number | ✅ | 当前文件索引 | | isOpen | boolean | ✅ | 是否打开预览 | | onClose | () => void | ✅ | 关闭回调 | | onNavigate | (index: number) => void | ❌ | 导航回调 | | customRenderers | CustomRenderer[] | ❌ | 自定义渲染器 | | locale | Locale | ❌ | 界面语言（默认 'zh-CN'，内置 'en-US'） | | messages | Partial<Record<Locale, Partial<Messages>>> | ❌ | 自定义翻译覆盖 | | headless | boolean | ❌ | 无头模式，隐藏工具栏和导航箭头 | | theme | Theme | ❌ | 主题模式: 'auto' \| 'dark' \| 'light'（默认 'dark'） |

FilePreviewEmbed Props

| 属性 | 类型 | 必填 | 默认值 | 说明 | |------|------|------|--------|------| | files | PreviewFileInput[] | ✅ | - | 文件列表 | | currentIndex | number | ❌ | 0 | 当前文件索引 | | onNavigate | (index: number) => void | ❌ | - | 导航回调 | | customRenderers | CustomRenderer[] | ❌ | - | 自定义渲染器 | | width | number \| string | ❌ | '100%' | 容器宽度 | | height | number \| string | ❌ | '100%' | 容器高度 | | className | string | ❌ | - | 根节点额外 className | | style | CSSProperties | ❌ | - | 根节点额外内联样式 | | locale | Locale | ❌ | 'zh-CN' | 界面语言（'zh-CN' 或 'en-US'） | | messages | Partial<Record<Locale, Partial<Messages>>> | ❌ | - | 自定义翻译覆盖 | | headless | boolean | ❌ | false | 无头模式，隐藏工具栏和导航箭头 | | theme | Theme | ❌ | 'dark' | 主题模式: 'auto' \| 'dark' \| 'light' |

FilePreviewEmbed 没有 isOpen / onClose,若要显示/隐藏,请在父组件中条件渲染。同时它不会显示工具栏上的关闭按钮。

FilePreviewContent（高级用法）

FilePreviewModal 和 FilePreviewEmbed 都是基于底层 FilePreviewContent 组件的薄包装。当你需要构建完全自定义的容器时,可以直接使用它:

import { FilePreviewContent } from '@eternalheart/react-file-preview';

<FilePreviewContent
  mode="embed"       // 或 "modal"
  files={files}
  currentIndex={index}
  onNavigate={setIndex}
/>

文件类型定义

// 支持三种文件输入类型
type PreviewFileInput = File | PreviewFileLink | string;

// 1. 原生 File 对象（浏览器 File API）
const file: File = ...;

// 2. 文件对象
interface PreviewFileLink {
  id?: string;       // 可选的唯一标识符
  name: string;      // 文件名
  type: string;      // MIME 类型
  url: string;       // 文件 URL (支持 blob URL 和 HTTP URL)
  size?: number;     // 文件大小（字节）
}

// 3. HTTP URL 字符串
const url: string = 'https://example.com/file.pdf';

使用示例

// 方式 1: 使用原生 File 对象
const files = [file1, file2]; // File 对象数组

// 方式 2: 使用 HTTP URL 字符串
const files = [
  'https://example.com/image.jpg',
  'https://example.com/document.pdf',
];

// 方式 3: 使用文件对象
const files = [
  {
    name: 'presentation.pptx',
    type: 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
    url: '/path/to/presentation.pptx',
  },
];

// 方式 4: 混合使用
const files = [
  file1,  // File 对象
  'https://example.com/image.jpg',  // URL 字符串
  { name: 'doc.pdf', type: 'application/pdf', url: '/doc.pdf' },  // 文件对象
];

支持的 MIME 类型

Office 文档

• Word: application/vnd.openxmlformats-officedocument.wordprocessingml.document (.docx)
• Excel: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (.xlsx)
• PowerPoint: application/vnd.openxmlformats-officedocument.presentationml.presentation (.pptx)
• PowerPoint (旧版): application/vnd.ms-powerpoint (.ppt)

其他文档

• PDF: application/pdf

媒体文件

• 图片: image/jpeg, image/png, image/gif, image/webp, image/svg+xml, 等
• 视频: video/mp4, video/webm, video/ogg, 等
• 音频: audio/mpeg, audio/wav, audio/ogg, 等

文本文件

• Markdown: 文件扩展名 .md 或 .markdown
• 代码: 根据文件扩展名自动识别 (.js, .ts, .py, .java, 等)
• 配置 / 日志: .yaml, .yml, .toml, .ini, .conf, .env, .log, .diff, .patch
• 纯文本: text/plain

结构化数据

• JSON: application/json (.json)
• CSV / TSV: text/csv (.csv), text/tab-separated-values (.tsv)
• XML: application/xml, text/xml (.xml)

字幕 / 歌词

• SRT: application/x-subrip (.srt)
• WebVTT: text/vtt (.vtt)
• LRC: (.lrc)
• Enhanced LRC: (.elrc)
• ASS / SSA: (.ass, .ssa)
• TTML / DFXP: application/ttml+xml (.ttml, .dfxp)

压缩包

• ZIP: application/zip, application/x-zip-compressed (.zip)

Outlook 邮件

• MSG: application/vnd.ms-outlook (.msg)

电子书

• EPUB: application/epub+zip (.epub)

🌐 国际化（i18n）

内置中文（默认）和英文，零外部依赖。

// 切换为英文
<FilePreviewModal files={files} locale="en-US" ... />

// 自定义覆盖某些翻译
<FilePreviewModal
  files={files}
  locale="en-US"
  messages={{ 'en-US': { 'toolbar.zoom_in': 'Zoom ++' } }}
/>

在自定义渲染器中可通过 useTranslator() hook 获取翻译函数。

🎨 自定义样式

组件使用 Tailwind CSS 构建,您可以通过覆盖 CSS 变量来自定义样式:

/* 自定义主题色 */
:root {
  --primary-color: #8b5cf6;
  --secondary-color: #ec4899;
}

⌨️ 键盘快捷键

• ESC - 关闭预览
• ← - 上一个文件
• → - 下一个文件
• 滚轮 - 缩放图片 (仅图片预览)

📚 文档

• 在线演示 - 在线 Demo

🤖 Context7 支持

本项目支持 Context7 MCP Server。如果你正在使用 AI 编程助手（如 Claude Code、Cursor 等），可以配置 Context7 MCP Server 来获取 @eternalheart/react-file-preview 的最新文档和代码示例，从而获得更好的 AI 辅助开发体验。

如何使用

1. 将 Context7 MCP Server 添加到你的 AI 工具配置中
2. 在与 AI 交互时，Context7 会自动提供本库的最新 API 文档和使用示例
3. 无需手动查阅文档，即可获得更精准的代码建议和解答

更多关于 Context7 的配置方式，请访问 Context7 官方文档。

📦 包信息

打包体积

• ESM: ~54 KB (gzipped: ~12 KB)
• CJS: ~37 KB (gzipped: ~11 KB)
• CSS: ~56 KB (gzipped: ~14 KB)

Peer Dependencies

• react: ^18.0.0
• react-dom: ^18.0.0

导出

{
  ".": {
    "types": "./lib/index.d.ts",
    "import": "./lib/index.mjs",
    "require": "./lib/index.cjs"
  },
  "./style.css": "./lib/index.css"
}

🛠️ 开发

库开发

# 克隆仓库
git clone https://github.com/wh131462/file-preview.git

# 安装依赖
pnpm install

# 启动开发服务器（演示应用）
pnpm dev

# 构建库（用于 npm 发布）
pnpm build:lib

# 构建演示应用（用于 GitHub Pages）
pnpm build:demo

项目结构

react-file-preview/
├── src/
│   ├── index.ts              # 库入口文件
│   ├── FilePreviewModal.tsx  # 主组件
│   ├── types.ts              # 类型定义
│   ├── utils/                # 工具函数
│   ├── renderers/            # 文件类型渲染器
│   ├── App.tsx               # 演示应用
│   └── main.tsx              # 演示应用入口
├── lib/                      # 构建后的库（npm 包）
├── dist/                     # 构建后的演示应用（GitHub Pages）
└── vite.config.lib.ts        # 库构建配置

📄 许可证

MIT © EternalHeart

🤝 贡献

欢迎提交 Issue 和 Pull Request!

🔗 相关链接

• GitHub
• npm
• 在线演示
• 问题反馈