# dropdeck_slate-yjs

> Yjs bindings for Slate.

Latest version **3.1.1** (published 2021-10-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install dropdeck_slate-yjs
pnpm add dropdeck_slate-yjs
yarn add dropdeck_slate-yjs
bun add dropdeck_slate-yjs
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2021-10-14 |
| First published | 2021-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.0.0 |
| Dependencies | 2 |
| Unpacked size | 171.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 553 |
| Author | Eric Meier |
| Maintainers | bjarkih |
| Keywords | slate, slatejs, yjs, y-websocket |

## Links

- npm: https://www.npmjs.com/package/dropdeck_slate-yjs
- Repository: https://github.com/BitPhinix/slate-yjs
- Homepage: https://github.com/BitPhinix/slate-yjs#readme
- Issues: https://github.com/BitPhinix/slate-yjs/issues
- npm.io page: https://npm.io/package/dropdeck_slate-yjs

## Dependencies (2)

- [y-protocols](https://npm.io/package/y-protocols.md) ^1.0.5
- [tiny-invariant](https://npm.io/package/tiny-invariant.md) 1.1.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.1.1 (latest) — 2021-10-14

## README

# Slate Yjs 

Fork of the [`slate-yjs` project](https://github.com/BitPhinix/slate-yjs), adding an optional `normalizeRemoteEvents: (editor, fn)` option to the `withYjs` plugin, to allow for custom handling of remote events, applied to the shared type. Specifically, this can be used to avoid remote events ending up in the editor's history; for example:

```react
withYjs(
  editor,
    sharedType, {
      // Remote events should clear the history stack!
      normalizeRemoteEvents: (editor, fn) => {
        HistoryEditor.withoutSaving(baseEditor, fn);            
      }
    }
);
```

Depends on the resolution of [this issue](https://github.com/BitPhinix/slate-yjs/issues/295).

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