> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# React API

`@superdoc-dev/react` is a first-party React wrapper for SuperDoc. It handles lifecycle management, SSR safety, and React Strict Mode compatibility so you can drop a DOCX editor into any React app.

Building your own toolbar, comments sidebar, or review panel? Pair `<SuperDocEditor>` with `superdoc/ui/react`. See [Custom UI](https://docs.superdoc.dev/editor/custom-ui/overview.md).

## Installation

```bash theme={null}
npm install superdoc@1 @superdoc-dev/react@1
```

> [!NOTE]
>
> `superdoc` is included as a dependency: no need to install it separately.

## Quick start

```jsx theme={null}
import { SuperDocEditor } from '@superdoc-dev/react';
import '@superdoc-dev/react/style.css';

function App() {
  return (
    <SuperDocEditor
      document={file}
      documentMode="editing"
      onReady={() => console.log('Editor ready!')}
    />
  );
}
```

## What the component handles

* **Mounting**: Creates a SuperDoc instance when the component mounts
* **Updates**: Rebuilds automatically when the `document` prop changes
* **Cleanup**: Destroys the instance on unmount
* **SSR**: Renders container structure on server, initializes SuperDoc after hydration
* **Strict Mode**: Internal cleanup flag prevents issues from React 18 double-invocation

## Requirements

| Requirement | Version |
| - | - |
| React | 16.8.0+ |
| Node.js | 16+ |

## API structure

* **[Configuration](https://docs.superdoc.dev/editor/react/configuration.md)**: All props reference
* **[Methods](https://docs.superdoc.dev/editor/react/methods.md)**: Ref API, instance methods, and patterns
* **[Types](https://docs.superdoc.dev/editor/react/types.md)**: TypeScript types, framework integration, troubleshooting


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.