React component

The ONLYOFFICE Apps React component integrates ONLYOFFICE Apps into React projects.

备注

To work with this component, you need to have ONLYOFFICE Apps. If you are new to ONLYOFFICE Apps, create an account.

Prerequisites

This procedure requires Node.js (and npm).

Creating the demo React application with ONLYOFFICE Apps

This procedure creates a basic React application and installs an ONLYOFFICE Apps in it.

Create a new React project named docspace-react-demo using the Create React App package:
```
npx create-react-app docspace-react-demo
```
Go to the newly created directory:
```
cd docspace-react-demo
```
Install ONLYOFFICE Apps React component from npm and save it to the package.json file with --save:
```
npm install --save @onlyoffice/docspace-react
```

Open the ./src/App.js file in the docspace-react-demo project and replace its contents with the following code:

import {DocSpace} from "@onlyoffice/docspace-react";
import React, {useRef} from "react";

function onAppReady(e) {
  console.log("ONLYOFFICE Apps is ready!");
}

function onAppError(e) {
  console.log(e);
}

function onLoadComponentError(errorCode, errorDescription) {
  console.log(errorDescription);
}

export default function App() {
  return (
    <pre>
      <DocSpace
        url="http://example-onlyoffice.com/"
        config={{
          frameId: "onlyoffice-docspace",
          mode: "manager",
          width: "100%",
          height: "100%",
          events: {
            onAppReady: "onAppReady",
            onAppError: "onAppError",
          },
        }}
        onLoadComponentError={onLoadComponentError}
      />
    </pre>
  )
}

Replace the following line with your own data:

http://example-onlyoffice.com/ - replace with the URL of your server.

This JavaScript file will create the App component containing the ONLYOFFICE Apps configured with basic features.

Test the application using the Node.js development server:
- To start the development server, navigate to the docspace-react-demo directory and run:
```
npm run start
```
- To stop the development server, select on the command line or command prompt and press Ctrl+C.

Deploying the demo React 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 docspace-react-demo
serve
```

Now you can deploy the application to the created server:

Navigate to the docspace-react-demo directory and run:
```
npm run build
```
The build directory will be created with a production build of your app.
Copy the contents of the docspace-react-demo/build directory to the root directory of the web server (to the docspace-react-demo folder).

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

ONLYOFFICE Apps React component API

Properties

Name	Type	Default	Description
url*	string	null	Address of ONLYOFFICE Apps.
config*	object	null	Generic configuration object for opening a file with a token.
email	string	null	The user email to login in ONLYOFFICE Apps.
onRequestPasswordHash	(email: string) => string	null	The function called when the email parameter is passed, returning the passwordHash for login in ONLYOFFICE Apps.
onUnsuccessLogin	() => void	null	The function called when ONLYOFFICE Apps account login failed.
onLoadComponentError	(errorCode: number, errorDescription: string) => void	null	The function called when an error occurs while loading a component.

* - required field

Installing Storybook

Install Storybook to develop UI components in isolation:

Change the address of ONLYOFFICE Apps in the .env file:
```
"DOCSPACE_URL": "https://example-onlyoffice.com/"
```
where http://example-onlyoffice.com/ is the URL to the server with ONLYOFFICE Apps installed.
Build Storybook with the following command:
```
npm run build-storybook
```
Start Storybook:
```
npm run storybook
```

Developing ONLYOFFICE Apps React component

Clone project from the GitHub repository:

git clone https://github.com/ONLYOFFICE/docspace-react

Install the project dependencies:
```
npm install
```
Test the component:
```
npm run test
```
Build the project:
```
npm run rollup
```
Create the package:
```
npm pack
```

Feedback and support

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

Prerequisites​

Creating the demo React application with ONLYOFFICE Apps​

Deploying the demo React application​

ONLYOFFICE Apps React component API​

Properties​

Installing Storybook​

Developing ONLYOFFICE Apps React component​

Feedback and support​