# monaco-remote

> Monaco Editor for remote collaboration

Latest version **0.0.4-beta** (published 2020-05-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install monaco-remote
pnpm add monaco-remote
yarn add monaco-remote
bun add monaco-remote
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4-beta |
| Published | 2020-05-18 |
| First published | 2020-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Miclle Zheng |
| Maintainers | miclle |
| Keywords | monaco, editor, react, vscode, remote, collaboration |

## Links

- npm: https://www.npmjs.com/package/monaco-remote
- Repository: https://github.com/miclle/monaco-remote
- Homepage: https://github.com/miclle/monaco-remote#readme
- Issues: https://github.com/miclle/monaco-remote/issues
- npm.io page: https://npm.io/package/monaco-remote

## Dependencies (2)

- [pako](https://npm.io/package/pako.md) ^1.0.11
- [monaco-editor](https://npm.io/package/monaco-editor.md) *

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.4-beta (latest) — 2020-05-18
- 0.0.3-beta — 2020-05-18
- 0.0.2-beta — 2020-05-18
- 0.0.1-beta — 2020-05-15

## README

monaco-remote
============

[Monaco Editor](https://github.com/Microsoft/monaco-editor) with remote collaboration.

[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]

[![monaco-remote](https://nodei.co/npm/monaco-remote.png)](https://npmjs.org/package/monaco-remote)

[npm-url]: https://npmjs.org/package/monaco-remote
[downloads-image]: http://img.shields.io/npm/dm/monaco-remote.svg
[npm-image]: http://img.shields.io/npm/v/monaco-remote.svg

![demo graphic](./docs/demo.jpg "Shared Cursors and Selections")

## Installation

```bash
yarn add monaco-remote
```

## Using

### Realtime messaging interface definition
```js
interface IMessage {
  uid?: string;
  message: Uint8Array;
  timestamp?: number;
}

interface IMessageChannel {
  sendMessage(message: IMessage): Promise<void>;
  onReceiver(listener: (message: IMessage) => any): void;
  onMemberJoined(listener: (memberId: string) => any): void;
  onMemberLeft(listener: (memberId: string) => any): void;
}
```

### Monaco editor content manager options
```js
interface IEditorContentManagerOptions {
  editor: editor.IStandaloneCodeEditor;
  channel: IMessageChannel;
}
```

```js
new EditorContentManager({ editor, channel })
```

# License

MIT, see the [LICENSE](/LICENSE) file for detail.

---
_Source: https://npm.io/package/monaco-remote · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._