Giter Club home page Giter Club logo

peer-crdt-bind-codemirror's Introduction

peer-crdt-bind-codemirror

Binds a Codemirror editor and peer-crdt.

Install

$ npm install peer-crdt-bind-codemirror

Example

const Codemirror = require('codemirror')
const bind = require('peer-crdt-bind-codemirror')
const crdt = ...
const cursorCrdt = ...
const editor = Codemirror.fromTextArea(document.getElementById('codemirror'))

// bind editor to an array CRDT
const unbind = bind.editor(crdt, editor)

// bind cursors to a register CRDT
const unbindCursors = bind.cursors(cursorCrdt, editor)

// some time later ...

unbind()
unbindCursors()

API

bind (crdt, editor [, options])

Returns an unbind function.

Arguments:

  • crdt: must be a CRDT of type treedoc
  • editor: an instance of Codemirror
  • options: optional object with the following shape:
    • debounceMS: how long (in miliseconds) after the last edit should the CRDT be updated. Default is 2000.

bind.cursors (crdt, editor)

Returns an unbind function.

Arguments:

  • ipfs: IPFS node
  • crdt: must be a CRDT of type mv-register
  • editor: an instance of Codemirror
  • options: optional object with the following shape:
    • debounceMS: how long (in miliseconds) after the cursor position changed should the CRDT be updated. Default is 2000.

See example.

License

MIT

peer-crdt-bind-codemirror's People

Contributors

hacdias avatar pgte avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

peer-crdt-bind-codemirror's Issues

Example doesn't work

I get this error in the browser:

TypeError: cursors.peerId is not a function (cursors.js:17)

I'm on Node 10.0.0 and FireFox 59.0.2.

Any ideas?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.