【亲测免费】 **React-Viewer 技术文档**
2026-01-25 06:32:03作者:范靓好Udolf
React-Viewer 是一个专为 React 应用设计的图像查看器组件,旨在提供更加流畅的用户体验,特别是在与 ViewerJS 在 React 中集成不顺畅时,作为替代方案。本文档将指导您从安装到应用的基本使用,以及详细配置 API。
安装指南
确保您的项目支持 React 16.8.0 及以上版本,包括对应的 React DOM。之后,通过 npm 执行以下命令来安装 React-Viewer:
npm install react-viewer --save
这会将 React-Viewer 添加到您的项目依赖中。
项目使用说明
基础使用
在需要使用图像查看功能的 React 组件中,首先导入 React-Viewer:
import React, { useState } from 'react';
import Viewer from 'react-viewer';
function App() {
const [visible, setVisible] = useState(false);
return (
<div>
<button onClick={() => setVisible(true)}>显示查看器</button>
<Viewer
visible={visible}
onClose={() => setVisible(false)}
images={[{ src: 'your-image-url', alt: '图片描述' }]}
/>
</div>
);
}
Next.js 环境下的服务器端渲染(SSR)
请注意,当前版本(3.x)不支持完全的服务器端渲染(SSR),但在 4.0 版本中预计将得到解决。如果您正使用 Next.js,可以采用按需加载动态导入的方式,并设置 ssr: false 来避免 SSR 预渲染的问题:
import dynamic from 'next/dynamic';
const ReactViewer = dynamic(() => import('react-viewer'), { ssr: false });
// 在您的组件中使用
<ReactViewer ... />
项目API使用文档
React-Viewer 提供了丰富灵活的属性来定制您的图像查看体验。
必需属性
- visible: 控制查看器是否可见,类型为布尔值。
- onClose: 当关闭查看器时触发的回调函数。
- images: 图片源数组,每个元素包含
src和可选的alt描述。
主要可选属性
- zIndex: 查看器的 CSS z-index,默认为 1000。
- drag: 是否允许拖动图片,默认开启。
- zoomable, rotatable, scalable: 分别控制缩放、旋转和缩放按钮的显示,默认均为开启状态。
- onChange: 图片切换时的回调。
更多高级属性
还包括自定义工具栏、键盘支持开关、下载选项等,具体见官方 README 文件中的 Props 列表。
项目安装方式
实际上,安装方式已在“安装指南”部分覆盖,通过 npm 或 yarn 引入库即可。
以上就是 React-Viewer 的基本介绍和技术文档概览。利用这些信息,您可以有效地集成这个强大的图像查看器到您的 React 应用中。对于更详细的使用案例和属性配置,请参考项目在 GitHub 上的完整 README 文件。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音(TTS)模型,代表了当前该领域的最高水平(SOTA),它直接在波形潜空间中进行操作。00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer(Mixture-of-Transformers, MoT) 架构,通过潜在令牌实现模态特异性计算,显著提升了细粒度感知能力。Jinja00
FreeSql功能强大的对象关系映射(O/RM)组件,支持 .NET Core 2.1+、.NET Framework 4.0+、Xamarin 以及 AOT。C#00
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
27
14
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
659
4.26 K
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
894
Ascend Extension for PyTorch
Python
503
609
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
391
286
暂无简介
Dart
905
218
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
昇腾LLM分布式训练框架
Python
142
168
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
939
862
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.33 K
108