Awesome

Editable Component

Simple and tiny Edit in place component

Dependencies

- jQuery 1.8.2

How-to

Adds the stylesheet call into the <head> tag.

<link rel="stylesheet" href="editable.css">

Adds the JavaScript at bottom of page, before </body> tag close and after jQuery script call.

<script src="http://code.jquery.com/jquery-1.8.2.js"></script>
<script src="editable.js"></script>

Then, you can initialize a new editable component:

$('selector').editable();

API

Configuration

title Text for title

Events

done It's emitted when set a new content
cancel It's emitted when cancel the edit

Example

HTML

<div id="example">Everything contained within this div is editable.</div>

JavaScript

// Creates a new editable component
// $edit is a query selector {jQuery Object}
var $edit = $('#example').editable({
    'title': 'Please, edit this text.'
});

// Binds events
$edit.on('done', function (event, data) {
	// Some code here!
	// For example, you can send data to the server by ajax,
	// or save into localStorage.
	// Parameter 'data' is the current content.
});

$edit.on('cancel', function (event, data) {
	// Some code here!
});

Contact

Guille Paz (Frontend developer - JavaScript developer | Web standards lover)
E-mail: guille87paz@gmail.com
Twitter: @pazguille
Web: http://pazguille.me

License

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.