git ssb


0+

noffle / hyper-textarea



Branch:

Stephen Whitmore committed 0.2.3Latest: 6e08c8c on 1/28/2017, 3:06:28 AM
📄README.md
📄example.js
📄index.js
📄p2p-example.js
📄package.json

hyper-textarea

Back a textarea with a hyper-string
for conflict-free p2p replication!

Usage

Let's create two textarea elements on the same page and back each with their own hyper-string:

$ cat > example.js
var hyperize = require('hyper-textarea')
var memdb = require('memdb')
var hstring = require('hyper-string')

document.body.innerHTML = ''

var ta = document.createElement('textarea')
ta.setAttribute('cols', 80)
ta.setAttribute('rows', 8)
document.body.appendChild(ta)
var string = hstring(memdb())
hyperize(ta, string)

var ta2 = document.createElement('textarea')
ta2.setAttribute('cols', 80)
ta2.setAttribute('rows', 8)
document.body.appendChild(ta2)
var string2 = hstring(memdb())
hyperize(ta2, string2)

// perform a single sync between the two
var r1 = string.log.createReplicationStream()
var r2 = string2.log.createReplicationStream()
r1.pipe(r2).pipe(r1)
^D

Now start up a dev server + browserify/watchify process with wzrd:

$ wzrd example.js:bundle.js
server started at http://localhost:9967

Take a look! Everything you type in one textarea will be replicated to the other in realtime.

Peer-to-peer Browser Usage

Let's let two different browsers edit a textarea collaboratively, using webrtc-swarm to facilitate browser-to-browser peering:

$ cat > p2p-example.js
var swarm = require('webrtc-swarm')
var signalhub = require('signalhub')
var hyperize = require('hyper-textarea')
var hstring = require('hyper-string')
var memdb = require('memdb')

document.body.innerHTML = ''

var ta = document.createElement('textarea')
ta.setAttribute('cols', 80)
ta.setAttribute('rows', 8)
document.body.appendChild(ta)
var string = hstring(memdb())
hyperize(ta, string)

var hub = signalhub('hyper-textarea', [
  'https://signalhub.mafintosh.com'
])

var sw = swarm(hub)

sw.on('peer', function (peer, id) {
  console.log('connected to a new peer:', id)
  var r = string.log.createReplicationStream()
  r.pipe(peer).pipe(r)
})

sw.on('disconnect', function (peer, id) {
  console.log('disconnected from a peer:', id)
})
^D

Like before, fire up wzrd:

$ wzrd p2p-example.js:bundle.js
server started at http://localhost:9967

Now open two browser tabs pointing at this address. They'll find each other via signalhub and perform a sync on their contents.

API

var hyperize = require('hyper-textarea')

hyperize(textarea, hstring)

Backs a textarea element textarea with a hyper-string instance hstring.

Install

With npm installed, run

$ npm install hyper-textarea

See Also

License

ISC


Built with git-ssb-web