首页 > 其他分享 >ONLYOFFICE 文档 Vue 组件

ONLYOFFICE 文档 Vue 组件

时间:2024-03-28 16:13:21浏览次数:39  
标签:Vue void object events 文档 null ONLYOFFICE event

ONLYOFFICE 文档 Vue 组件

ONLYOFFICE Docs Vue.js 组件 集成 ONLYOFFICE Docs 到 Vue.js 项目。

此过程需要 Node.js(和 npm)

此过程创建一个基本 Vue.js 应用程序 并在其中安装 ONLYOFFICE 文档编辑器。

  1. 打开命令行或命令提示符,并使用 创建 Vue 工具,创建一个名为 onlyoffice-vue-demo 的 Vue.js 3.x 项目:

    npm create vue@3
    
  2. 进入新创建的目录:

    cd onlyoffice-vue-demo
    
  3. 从 npm 安装 ONLYOFFICE Docs Vue.js 组件,并使用 --save 将其保存到 package.json 文件中:

    npm install --save @onlyoffice/document-editor-vue
    
  4. 打开 onlyoffice-vue-demo 项目中的 ./src/App.vue 文件,并将其内容替换为以下代码:

    <template>
        <DocumentEditor 
            id="docEditor" 
            documentServerUrl="http://documentserver/"
            :config="config"
            :events_onDocumentReady="onDocumentReady"
        /> 
    </template>
    
    <script lang="ts">
    import { defineComponent } from 'vue';
    import { DocumentEditor } from "@onlyoffice/document-editor-vue";
    
    export default defineComponent({
        name: 'ExampleComponent',
        components: {
            DocumentEditor
        },
        data() {
            return {
                config: {
                    document: {
                        fileType: "docx",
                        key: "Khirz6zTPdfd7",
                        title: "Example Document Title.docx",
                        url: "https://example.com/url-to-example-document.docx"
                    },
                    documentType: "word",
                    editorConfig: {
                        callbackUrl: "https://example.com/url-to-callback.ashx"
                    }
                }
            }
        },
        methods: {
            onDocumentReady() {
                console.log("Document is loaded");
            }
        },
    });
    </script>
    

    将以下行替换为您自己的数据:

    • "http://documentserver/" - 替换为您的服务器的 URL;
    • "https://example.com/url-to-example-document.docx" - 替换为您的文件的 URL;
    • "https://example.com/url-to-callback.ashx" - 替换为您的回调 URL(这是保存功能正常工作所必需的)。
  5. 使用 Vue 开发服务器测试应用程序:

    • 要启动开发服务器,请导航到 onlyoffice-vue-demo 目录并运行:

      npm run dev
      
    • 要停止开发服务器,请选择命令行或命令提示符,然后按 Ctrl+C

将应用程序部署到生产环境的最简单方法是安装 serve 并创建静态服务器:

  1. 全局安装 serve 包:

    npm install -g serve
    
  2. 在 3000 端口上为您的静态站点提供服务:

    serve -s build
    

    可以使用 -l 或 --listen 标志调整另一个端口:

    serve -s build -l 4000
    
  3. 要提供项目文件夹,请转到该文件夹并运行 serve 命令:

    cd onlyoffice-vue-demo
    serve
    

现在您可以将应用程序部署到创建的服务器:

  1. 导航到 onlyoffice-vue-demo 目录并运行:

    npm run build
    

    dist 目录将使用您的应用程序的产品版本创建。

  2. 将 onlyoffice-vue-demo/dist 目录的内容复制到 Web 服务器的根目录(复制到 onlyoffice-vue-demo 文件夹)。

该应用程序将部署在 Web 服务器上(默认情况下http://localhost:3000)。

属性
名称 类型 默认 描述
string null 组件唯一标识符。
string null ONLYOFFICE 文档服务器的地址。
object null 用于使用令牌打开文件的 通用配置 对象。
string null 文件的类型。
string null 文件名。
string null 文档类型。
string null 定义浏览器窗口中的文档高度。
string null 定义用于访问文档的平台类型(桌面、移动或嵌入式)。
string null 定义浏览器窗口中的文档宽度。
(event: object) => void null 当应用程序加载到浏览器时调用的函数。 当应用程序加载到浏览器中时调用的函数。
(event: object) => void null 修改文档时调用的函数。
(event: object) => void null 通过 meta 命令更改文档的元信息时调用的函数。
(event: object) => void null 将文档加载到文档编辑器时调用的函数。
(event: object) => void null 应用程序打开文件时调用的函数。
(event: object) => void null 发生警告时调用的函数。
(event: object) => void null 发生错误或其他特定事件时调用的函数。
(event: object) => void null 当用户尝试通过单击 更改访问权限 按钮来管理文档访问权限时调用的函数。
(event: object) => void null 当用户尝试通过单击 “重命名...” 按钮重命名文件时调用的函数。
(event: object) => void null 当用户试图获取打开包含书签的文档的链接时调用的函数,滚动到书签位置。
(event: object) => void null 当用户尝试通过单击 “来自存储的图像” 按钮插入图像时调用的函数。
(event: object) => void null 当用户尝试通过单击 “另存为...” 按钮来保存文件时调用的函数。
(event: object) => void null 当用户尝试通过单击 “邮件合并” 按钮来选择收件人数据时调用的函数。
(event: object) => void null 当用户尝试通过单击 “存储中的文档” 按钮来选择要比较的文档时调用的函数。
(event: object) => void null 当用户尝试通过单击 “编辑文档” 按钮将文档从查看模式切换到编辑模式时调用的函数。
(event: object) => void null 当用户尝试通过单击 “版本历史记录” 按钮来显示文档版本历史记录时调用的函数。
(event: object) => void null 当用户试图通过单击 “关闭历史记录” 按钮从查看文档版本历史记录返回到文档时调用的函数。
(event: object) => void null 当用户试图单击文档版本历史记录中的特定文档版本时调用的函数。
(event: object) => void null 当用户尝试通过单击版本历史记录中的 “恢复” 按钮来恢复文件版本时调用的函数。
* - 必填字段

安装 Storybook 以独立开发UI组件:

  1. 更改 config/default.json 文件中文档服务器的地址:

    "documentServerUrl": "http://documentserver/";
    

    其中 documentserver 是安装了 ONLYOFFICE 文档 的服务器的名称。

  2. 使用以下命令生成Storybook:

    npm run build-storybook
    
  3. 启动Storybook:

    npm run storybook
    
  1. 从 GitHub 存储库克隆项目:

    git clone https://github.com/ONLYOFFICE/document-editor-vue
    
  2. 安装项目依赖:

    npm install
    
  3. 测试组件:

    npm run test
    
  4. 构建项目:

    npm run build
    
  5. 创建包:

    npm pack
    

如果您对 ONLYOFFICE 文档 Vue有任何问题、疑问或建议,请参阅 问题 部分。

标签:Vue,void,object,events,文档,null,ONLYOFFICE,event
From: https://www.cnblogs.com/mouseleo/p/18101953

相关文章

  • 若依RuoYi-Vue创建菜单并添加自定义页
    全文见:若依管理系统RuoYi-Vue(一):项目启动和菜单创建添加菜单和页面是若依管理系统最核心的功能,也是使用者最关心的事情,这里涉及到核心中的核心功能:权限,先不考虑那么多,直接新增页面,看看能否生效。下面演示新闻列表页添加的过程,这里如果想要新增新闻列表菜单,需要先新增“新闻”父菜......
  • 最佳开源文档管理解决方案:2024年免费软件精选
    本文将为大家分享9款开源文档管理系统:Bitrix24、Kimios、OpenDocMan、Papermerge、Nuxeo、OpenKM、Teedy、FileRun、SeedDMS。在现今充满数字化的世界里,不论大小,各种组织都会产出很多文件、图片等数字化内容。好好管理这些信息对于组织的顺畅运作和保持其竞争力非常关键。这......
  • 在Vue项目中使用Vuex进行状态管理是一种常见做法。下面是一个简单的示例,展示了如何创
    步骤1:创建VuexStore首先,你需要创建一个Vuexstore。通常,这是在你的项目的store目录下完成的。//store.jsimportVuefrom'vue';importVuexfrom'vuex';Vue.use(Vuex);conststore=newVuex.Store({state:{count:0},mutations:{increment(......
  • (毕业设计)基于Java+Vue+Mysql的网上订餐系统
    前言:网上订餐系统是一个综合性的在线服务平台,旨在为用户提供便捷的点餐、支付、配送等一体化服务。下面是对系统列出的各个功能模块的详细解释:一、个人中心个人中心是用户登录后的主要界面,展示用户的个人信息、订单记录、优惠券、积分等。用户可以在此查看并管理自己的账户......
  • (毕业设计)基于Java+Vue+Mysql的大学生租房平台
     前言:大学生租房平台是一个专门为大学生提供租房服务的在线平台。这个平台不仅简化了租房流程,还提供了多种功能,如房源搜索、在线沟通、合同签订等,让大学生能够轻松、安全地找到适合自己的房源。以下是针对系统列出的七个平台功能的详细解释:一、个人中心个人中心是用户在使......
  • (毕业设计)基于Java+Vue+Mysql的学生心理咨询评估系统
     前言:学生心理咨询评估系统是一个集成了多个功能模块的综合性系统,旨在为学生提供心理咨询服务和评估。以下是对系统的五个主要功能模块的详细解释:一、个人中心个人中心是用户的个人空间,主要用于展示和管理用户的基本信息、心理评估记录、咨询历史等。学生可以在这里查看自......
  • 在Vue.js框架中,activated和created的区别
    在Vue.js框架中,activated和created两个钩子函数都是在组件被创建时执行的函数,但它们的使用场景略有不同。createdcreated钩子函数是在组件被创建(即实例化)时执行的,可以用它来初始化组件的数据、监听事件、调用方法等操作。它是组件生命周期中的第一个钩子函数,通常用于组件初......
  • vue实例的data属性,可以在哪些生命周期中获取到
    Vue实例的data属性可以在beforeCreate、created和beforeMount生命周期中获取到。在Vue实例的生命周期中,data属性在不同的阶段有着不同的可访问性:beforeCreate:在实例初始化之后,数据观测(dataobserver)和事件配置之前被调用。在这个阶段,data属性已经可以被访问,但是事件监听器......
  • vue3子组件给父组件传参,父组件给子组件传参,在父组件中直接调用子组件中的某个方法
    vue3子组件给父组件传参,父组件给子组件传参,在父组件中直接调用子组件中的某个方法1、子传父,以传递id为例子:constemit=defineEmits(['passId']);//在需要传递的参数的地方写,id为需要传递的参数emit('passId',id); 父://引入子组件constSonPage=defineAsyncCo......
  • 解决vue3项目中四周留白的原因
    留白原因:vue3中body有默认属性margin:8px。body{display:block;margin:8px;}如何解决:需要在vue项目中对根目录的index.html进行代码添加<style>body{margin:0;}</style>index.html完整代码:<!DOCTYPEhtml><htmllang="en">&......