2.8 KiB
X-editable
In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery.
It is a new life of bootstrap-editable plugin that was strongly refactored and improved.
Demo + Docs + Download
See http://vitalets.github.com/x-editable
Reporting issues
When creating issues please provide jsFiddle example. You can just fork this fiddle as starting point.
Your feedback is very appreciated!
Contribution
A few steps how to start contributing:
1.Fork X-editable and pull the latest changes from dev
branch
2.Arrange local directory structure. It should be:
x-editable
| -- lib (repo related to dev
and master
branches)
| -- gh-pages (repo related to gh-pages
branch for docs & demo)
| -- playground (simple node-server and html page for testing, playground.zip)
To make it easy follow this script ( assuming you have nodejs installed ).
Please replace <your-github-name>
with your name:
mkdir x-editable
cd x-editable
#lib
git clone https://github.com/<your-github-name>/x-editable.git -b dev lib
cd lib
#install gruntjs globally - building tool
npm install -g grunt
#install other dependencies - grunt-contrib
npm install
cd ..
#gh-pages
git clone https://github.com/<your-github-name>/x-editable.git -b gh-pages gh-pages
cd gh-pages
npm install
cd ..
#playground
#download playground.zip from https://github.com/downloads/vitalets/x-editable/playground.zip
unzip playground.zip
cd playground
npm install
3.That's it! You can start editing files in lib/src directory or create new editable input/container/whatever.
To test the result go to playground, start server node server.js
and open in your browser http://localhost:3000/playground.
4.To run unit tests you can open it directly in browser lib/test/index.html.
Or use grunt's qunit task grunt test
. For that you also need to install PhantomJS
5.To build lib + docs:
- run
grunt build
in lib directory - run
build data-docs-dist
in gh-pages directory
You will get distributive in lib/dist and updated docs in gh-pages/index.html and gh-pages/docs.html (don't edit these files directly).
6.Commit changes on dev
branch and make pull request as usual.
Thanks for your support!
License
Copyright (c) 2012 Vitaliy Potapov
Licensed under the MIT licenses.