Project Icon

react-file-viewer

React 多格式文件在线预览组件

react-file-viewer 是一个基于 React 的可扩展 Web 文件预览组件。支持图片、PDF、CSV、Excel、Word、视频和音频等多种文件格式。该组件集成简便,允许自定义错误处理和不支持文件类型的显示。适用于 React 16+ 版本,API 简洁,易于使用。开发者可以方便地扩展支持的文件类型,是实现 Web 文件预览功能的有力工具。

react-file-viewer

用于网页的可扩展文件查看器

支持的文件格式:

  • 图片:png、jpeg、gif、bmp,包括360度全景图
  • pdf
  • csv
  • xlsx
  • docx
  • 视频:mp4、webm
  • 音频:mp3

使用方法

注意:此模块在React 16+版本下运行最佳。如果您使用的是React 16以下版本,您可能需要使用0.5版本。可以通过npm install react-file-viewer@0.5.0安装。

主要的React组件是FileViewer,它接受以下属性:

fileType 字符串:要显示的资源类型(支持的文件格式之一,例如'png')。传入不支持的文件类型将显示"不支持的文件类型"消息(或自定义组件)。

filePath 字符串:FileViewer要显示的资源的URL。

onError 函数 [可选]:当文件查看器在获取或渲染请求的资源时出错时将调用此函数。您可以在此处传入日志记录工具的回调函数。

errorComponent React元素 [可选]:出错时要渲染的组件,用于替代react-file-viewer自带的默认错误组件。

unsupportedComponent React元素 [可选]:文件格式不受支持时要渲染的组件。

要使用自定义错误组件,您可以这样做:

// MyApp.js
import React, { Component } from 'react';
import logger from 'logging-library';
import FileViewer from 'react-file-viewer';
import { CustomErrorComponent } from 'custom-error';

const file = 'http://example.com/image.png'
const type = 'png'

class MyComponent extends Component {
  render() {
    return (
      <FileViewer
        fileType={type}
        filePath={file}
        errorComponent={CustomErrorComponent}
        onError={this.onError}/>
    );
  }

  onError(e) {
    logger.logError(e, 'error in file-viewer');
  }
}

开发

此库内置了一个演示应用,可用于开发目的。默认情况下,它通过webpack-dev-server提供服务。

启动演示应用

运行npm run start将启动由webpack-dev-server提供服务的演示应用

测试

测试使用Jest和Enzyme。

运行测试:

npm run test

这将以监视模式启动Jest。要运行特定的测试文件,在监视模式下按p,然后输入文件的路径或名称。

某些测试使用快照。如果对组件的有意更改导致快照测试失败,需要更新快照文件(存储在__snapshots__目录中)。 要执行此操作,请运行:

npm run jest --updateSnapshot

运行代码检查

npm run lint

扩展文件查看器

添加支持的文件类型很容易(欢迎提交拉取请求!)。例如,假设您想添加对.rtf文件的支持。首先,您需要为该文件类型创建一个"驱动程序"。驱动程序只是一个能够渲染该文件类型的组件。(请参阅src/components/drivers中现有的驱动程序。)创建驱动程序组件并将其添加到src/components/drivers后,您只需要将该组件导入到file-viewer.jsx中,并在getDriver方法中为rtf添加一个switch子句。例如:

case 'rtf':
  return RtfViewer;

路线图

  • 移除被忽略的代码检查规则并修复它们
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

稿定AI

稿定设计 是一个多功能的在线设计和创意平台,提供广泛的设计工具和资源,以满足不同用户的需求。从专业的图形设计师到普通用户,无论是进行图片处理、智能抠图、H5页面制作还是视频剪辑,稿定设计都能提供简单、高效的解决方案。该平台以其用户友好的界面和强大的功能集合,帮助用户轻松实现创意设计。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号