ONLYOFFICE Docs Vue component

This component enables users to build ONLYOFFICE Docs user interface using Vue.

Installing ONLYOFFICE Docs Vue component

Install ONLYOFFICE Docs Vue component from npm in your project. Run:

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

or

  1. yarn add @onlyoffice/document-editor-vue

Using ONLYOFFICE Docs Vue component

Find below the component usage example:

  1. <template>
  2. <DocumentEditor
  3. id="docEditor"
  4. documentServerUrl="http://documentserver/"
  5. :config="config"
  6. :events_onDocumentReady="onDocumentReady"
  7. />
  8. </template>
  9. <script lang="ts">
  10. import { defineComponent } from 'vue';
  11. import { DocumentEditor } from "@onlyoffice/document-editor-vue";
  12. export default defineComponent({
  13. name: 'ExampleComponent',
  14. components: {
  15. DocumentEditor
  16. },
  17. data() {
  18. return {
  19. config: {
  20. document: {
  21. fileType: "docx",
  22. key: "Khirz6zTPdfd7",
  23. title: "Example Document Title.docx",
  24. url: "https://example.com/url-to-example-document.docx"
  25. },
  26. documentType: "word",
  27. editorConfig: {
  28. callbackUrl: "https://example.com/url-to-callback.ashx"
  29. }
  30. }
  31. }
  32. },
  33. methods: {
  34. onDocumentReady() {
  35. console.log("Document is loaded");
  36. }
  37. },
  38. });
  39. </script>

where the example.com is the name of the server where document manager and document storage service are installed and the documentserver is the name of the server with ONLYOFFICE Docs installed.

ONLYOFFICE Docs Vue component API

Properties

NameTypeDefaultDescription
idstringnullComponent unique identifier.
documentServerUrlstringnullAddress of ONLYOFFICE Document Server.
config*objectnullGeneric configuration object for opening a file with token.
document_fileTypestringnullThe type of the file.
document_titlestringnullThe file name.
documentTypestringnullThe document type.
heightstringnullDefines the document height in the browser window.
typestringnullDefines the platform type used to access the document (desktop, mobile or embedded).
widthstringnullDefines the document width in the browser window.
events_onAppReady(event: object) => voidnullThe function called when the application is loaded into the browser.
events_onDocumentStateChange(event: object) => voidnullThe function called when the document is modified.
events_onMetaChange(event: object) => voidnullThe function called when the meta information of the document is changed via the meta command.
events_onDocumentReady(event: object) => voidnullThe function called when the document is loaded into the document editor.
events_onInfo(event: object) => voidnullThe function called when the application opened the file.
events_onWarning(event: object) => voidnullThe function called when a warning occurs.
events_onError(event: object) => voidnullThe function called when an error or some other specific event occurs.
events_onRequestSharingSettings(event: object) => voidnullThe function called when the user is trying to manage document access rights by clicking Change access rights button.
events_onRequestRename(event: object) => voidnullThe function called when the user is trying to rename the file by clicking the Rename… button.
events_onMakeActionLink(event: object) => voidnullThe function called when the user is trying to get link for opening the document which contains a bookmark, scrolling to the bookmark position.
events_onRequestInsertImage(event: object) => voidnullThe function called when the user is trying to insert an image by clicking the Image from Storage button.
events_onRequestSaveAs(event: object) => voidnullThe function called when the user is trying to save file by clicking Save Copy as… button.
events_onRequestMailMergeRecipients(event: object) => voidnullThe function called when the user is trying to select recipients data by clicking the Mail merge button.
events_onRequestCompareFile(event: object) => voidnullThe function called when the user is trying to select document for comparing by clicking the Document from Storage button.
events_onRequestEditRights(event: object) => voidnullThe function called when the user is trying to switch the document from the viewing into the editing mode by clicking the Edit Document button.
events_onRequestHistory(event: object) => voidnullThe function called when the user is trying to show the document version history by clicking the Version History button.
events_onRequestHistoryClose(event: object) => voidnullThe function called when the user is trying to go back to the document from viewing the document version history by clicking the Close History button.
events_onRequestHistoryData(event: object) => voidnullThe function called when the user is trying to click the specific document version in the document version history.
events_onRequestRestore(event: object) => voidnullThe function called when the user is trying to restore the file version by clicking the Restore button in the version history.

* - required field

Installing Storybook

Install Storybook to develop UI components in isolation:

  1. Change the address of the document server in the config/default.json file:

    1. "documentServerUrl": "http://documentserver/"

    where the documentserver is the name of the server with ONLYOFFICE Docs installed.

  2. Build Storybook with the following command:

    1. npm run build-storybook
  3. Start Storybook:

    1. npm run storybook

Developing ONLYOFFICE Docs Vue component

  1. Clone project from the GitHub repository:

    1. git clone https://github.com/ONLYOFFICE/document-editor-vue
  2. Install the project dependencies:

    1. npm install
  3. Test the component:

    1. npm run test
  4. Build the project:

    1. npm run build
  5. Create the package:

    1. npm pack

Feedback and support

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