@onlyoffice/document-editor-vue

@onlyoffice/document-editor-vue

This repo contains the ONLYOFFICE Docs Vue.js component which integrates ONLYOFFICE Document Server into Vue.js projects.

Please note: Before working with this component, you need to install ONLYOFFICE Docs. To do so, you can use Docker (recommended).

Prerequisites

This procedure requires Node.js (and npm).

Creating the demo Vue.js application with ONLYOFFICE Docs editor

This procedure creates a basic Vue.js application and installs an ONLYOFFICE Docs editor in it.

• Open a command line or command prompt and create a Vue.js 3.x project named onlyoffice-vue-demo using the Create Vue Tool:

npm create vue@3

• Go to the newly created directory:

cd onlyoffice-vue-demo

• Install ONLYOFFICE Docs Vue.js component from npm and save it to the package.json file with --save:

npm install --save @onlyoffice/document-editor-vue

• Open the ./src/App.vue file in the onlyoffice-vue-demo project and replace its contents with the following code:

<template>
    <DocumentEditor 
        id="docEditor" 
        documentServerUrl="http://documentserver/"
        :config="config"
        :onLoadComponentError="onLoadComponentError"
    /> 
</template>

<script lang="ts">
import { defineComponent } from 'vue';
import { DocumentEditor } from "@onlyoffice/document-editor-vue";

export default defineComponent({
    name: 'ExampleComponent',
    components: {
        DocumentEditor
    },
    data() {
        const onDocumentReady = () => {
            console.log("Document is loaded");
        };

        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"
                },
                events: {
                    onDocumentReady: onDocumentReady
                }
            }
        }
    },
    methods: {
        onLoadComponentError (errorCode, errorDescription) {
            switch(errorCode) {
                case -1: // Unknown error loading component
                    console.log(errorDescription);
                    break;

                case -2: // Error load DocsAPI from http://documentserver/
                    console.log(errorDescription);
                    break;

                case -3: // DocsAPI is not defined
                    console.log(errorDescription);
                    break;
            }
        }
    },
});
</script>

Replace the following lines with your own data:

• "http://documentserver/" - replace with the URL of your server;
• "https://example.com/url-to-example-document.docx" - replace with the URL to your file;
• "https://example.com/url-to-callback.ashx" - replace with your callback URL (this is required for the saving functionality to work).

• Test the application using the Vue development server:

• To start the development server, navigate to the onlyoffice-vue-demo directory and run:

npm run dev

• To stop the development server, select on the command line or command prompt and press Ctrl+C.

Deploying the demo Vue.js application

The easiest way to deploy the application to a production environment is to install serve and create a static server:

• Install the serve package globally:

npm install -g serve

• Serve your static site on the 3000 port:

serve -s build

Another port can be adjusted using the -l or --listen flags:

serve -s build -l 4000

• To serve the project folder, go to it and run the serve command:

cd onlyoffice-react-demo
serve

Now you can deploy the application to the created server:

• Navigate to the onlyoffice-vue-demo directory and run:

npm run build

The dist directory will be created with a production build of your app.

• Copy the contents of the onlyoffice-vue-demo/dist directory to the root directory of the web server (to the onlyoffice-react-demo folder).

The application will be deployed on the web server (http://localhost:3000 by default).

API

Props

Name	Type	Default	Required	Description
id	string	null	yes	Component unique identifier.
documentServerUrl	string	null	yes	Address ONLYOFFICE Document Server.
shardkey	string | boolean	true	no	The string or boolean parameter required to request load balancing during collaborative editing: all users editing the same document are served by the same server. Shard key
config	object	null	yes	Generic configuration object for opening a file with token. Config API
onLoadComponentError	(errorCode: number, errorDescription: string) => void	null	no	The function called when an error occurs while loading a component

Storybook

Change the address of the Document Server in the config/default.json file:

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

Build Storybook:

npm run build-storybook

Start Storybook:

npm run storybook

Development

Clone project from the GitHub repository:

git clone https://github.com/ONLYOFFICE/document-editor-vue

Install the project dependencies:

npm install

Test the component:

npm run test

Build the project:

npm run build

Create the package:

npm pack

Feedback and support

In case you have any issues, questions, or suggestions for the ONLYOFFICE Document Server Vue component, please refer to the Issues section.

Official project website: www.onlyoffice.com.

Support forum: forum.onlyoffice.com.