快速开始
本指南将帮助您在 Vue3 项目中快速开始使用 umo-office-viewer 插件。
1. 安装
1) 克隆官方仓库
git clone <Umo Office Viewer 官方私有仓库路径>2) 安装依赖并打包项目代码
npm install
npm run build3) 安装 Umo Office Viewer
假设您克隆的本地仓库路径相对于您的项目地址为 ../umo-office-viewer。请在您的项目中运行以下命令安装 Umo Office Viewer：
npm install --save ../umo-office-viewer/packages/umo-office-viewer-xxx.tgz2. 使用
以下使用方式任选一种即可：
1) 全局安装
main.js
import { createApp } from 'vue'
import { useUmoOfficeViewer } from '@umoteam/office-viewer'
const app = createApp(App)
app.use(useUmoOfficeViewer, {
// 配置项
// ...
})
app.mount('#app')2) 直接引入
以下组合式 API 和选项式 API 的示例，任选一种使用即可。
component.vue
<template>
<umo-office-viewer v-bind="options" />
</template>
// 使用组合式 API
<script setup>
import { ref } from 'vue'
import { UmoOfficeViewer } from '@umoteam/office-viewer'
const options = ref({
// 配置项
// ...
})
</script>
// 或使用选项式 API
<script>
import { UmoOfficeViewer } from '@umoteam/office-viewer'
export default {
components: {
UmoOfficeViewer,
},
data() {
return {
options: {
// 配置项
// ...
},
}
},
}
</script>3) 在 Nuxt 中使用
Umo Office Viewer 暂不支持 SSR。在 Nuxt 的 SSR 模式下，可以使用 <client-only> 插件或通过其他方式确保 Umo Office Viewer 在客户端渲染和使用。
component.vue
<template>
<client-only>
<umo-office-viewer v-bind="options" />
</client-only>
</template>
<script setup>
import { UmoOfficeViewer } from '@umoteam/office-viewer'
const options = ref({
// 配置项
// ...
})
</script>3. 配置
见配置项。在配置之前，建议先启动 Umo Office Convert 服务。