editable

Turn DOM elements into read-write streams with in-place editing

npm install editable
11 downloads in the last month

editable

Turn DOM-Elements into streams that

  • emit updates through in place editing
  • update their innerText when written to

preview

In place editing starts on click and ends on form submit

usage

var editable = require('editable')

var el = editable(document.querySelector('#my-element'))

el.on('data', function (update) {
  console.log(update)
})

el.write('foo')

api

editable(el)

Turn el into a editable element, returns a readable writable stream.

editable#{form,input,submit}

The underlying DOM elements for in place editing.

editable#startEdit()

editable#endEdit()

You shouldn't need to call those.

installation

$ npm install editable

and bundle with browserify

license

(MIT)

Copyright (c) 2012 <julian@juliangruber.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you