Preview 文件预览
支持 docx、pptx、pdf、xlsx 文件的在线预览组件
适用场景:需要在浏览器中预览
docx、pptx、xlsx文件时,<r-preview>会从文件 URL 打开一个文档预览弹窗(现已作为独立的@ranui/preview包发布)。
⚠️ 重要通知:ranui 包在 0.1.10-alpha-27 版本之后将不再提供此组件,请迁移到独立的 @ranui/preview 包
快速开始
安装
# 使用独立的 preview 包(推荐)
npm install @ranui/preview
# 或使用完整的 ranui 包(0.1.10-alpha-27 版本之前)
npm install ranui基础用法
<r-preview id="preview-demo"></r-preview>
<r-button type="primary" onclick="uploadFile()">选择文件预览</r-button>
<script>
const uploadFile = () => {
const preview = document.getElementById('preview-demo');
const input = document.createElement('input');
input.setAttribute('type', 'file');
input.setAttribute('accept', '.docx,.pptx,.pdf,.xlsx');
input.click();
input.onchange = (e) => {
const { files = [] } = input;
if (files.length > 0) {
const file = files[0];
const url = URL.createObjectURL(file);
preview.setAttribute('src', url);
}
};
};
</script>API 参考
属性
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
src |
string |
'' |
文件预览地址,有值时会自动打开预览弹窗 |
closeable |
boolean |
true |
是否显示关闭按钮 |
baseUrl |
string |
'https://edit.chaxus.com' |
自定义文档预览服务地址 |
资源地址 src
设置文件地址即可打开预览弹窗,为空时不显示
<r-preview src="https://example.com/document.docx"></r-preview>是否可关闭 closeable
控制预览弹窗的关闭行为
<!-- 默认可关闭 -->
<r-preview closeable="true"></r-preview>
<!-- 不可关闭 -->
<r-preview closeable="false"></r-preview>自定义预览服务 baseUrl
当您需要自定义文档预览服务时,可以通过 baseUrl 属性指定服务地址
<r-preview baseUrl="https://edit.chaxus.com"></r-preview>💡 提示:默认使用
https://edit.chaxus.com提供的预览服务,如需自部署请参考 OnlyOffice Web Local
迁移指南
如果您正在使用 ranui 包中的 r-preview 组件,建议按以下步骤迁移:
安装新包:
npm install @ranui/preview更新导入:
// 之前 import 'ranui'; // 现在 import '@ranui/preview';HTML 使用方式保持不变:
<r-preview src="your-file-url"></r-preview>