ONLYOFFICE Docs React component

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

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

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

or

yarn add @onlyoffice/document-editor-react

Find below the component usage example:

...
import { DocumentEditor } from "@onlyoffice/document-editor-react";
...
...
var onDocumentReady = function (event) {
    console.log("Document is loaded");
};
...
...
<DocumentEditor
  id="docxEditor"
  documentServerUrl="http://documentserver/"
  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}
/>
...

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.

Properties
Name Type Default Description
string null Component unique identifier.
string null Address of ONLYOFFICE Document Server.
object null Generic configuration object for opening a file with token.
string null The type of the file.
string null The file name.
string null The document type.
string null Defines the document height in the browser window.
string null Defines the platform type used to access the document (desktop, mobile or embedded).
string null Defines the document width in the browser window.
(event: object) => void null The function called when the application is loaded into the browser.
(event: object) => void null The function called when the document is modified.
(event: object) => void null The function called when the meta information of the document is changed via the meta command.
(event: object) => void null The function called when the document is loaded into the document editor.
(event: object) => void null The function called when the application opened the file.
(event: object) => void null The function called when a warning occurs.
(event: object) => void null The function called when an error or some other specific event occurs.
(event: object) => void null The function called when the user is trying to manage document access rights by clicking Change access rights button.
(event: object) => void null The function called when the user is trying to rename the file by clicking the Rename... button.
(event: object) => void null The function called when the user is trying to get link for opening the document which contains a bookmark, scrolling to the bookmark position.
(event: object) => void null The function called when the user is trying to insert an image by clicking the Image from Storage button.
(event: object) => void null The function called when the user is trying to save file by clicking Save Copy as... button.
(event: object) => void null The function called when the user is trying to select recipients data by clicking the Mail merge button.
(event: object) => void null The function called when the user is trying to select document for comparing by clicking the Document from Storage button.
(event: object) => void null The function called when the user is trying to switch the document from the viewing into the editing mode by clicking the Edit Document button.
(event: object) => void null The function called when the user is trying to show the document version history by clicking the Version History button.
(event: object) => void null The 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.
(event: object) => void null The function called when the user is trying to click the specific document version in the document version history.
(event: object) => void null The function called when the user is trying to restore the file version by clicking the Restore button in the version history.
* - required field

Install Storybook to develop UI components in isolation:

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

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

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

  2. Build Storybook with the following command:

    yarn build-storybook
    
  3. Start Storybook:

    yarn storybook
    
  1. Clone project from the GitHub repository:

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

    yarn install
    
  3. Test the component:

    yarn test
    
  4. Build the project:

    yarn rollup
    
  5. Create the package:

    npm pack
    

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