| 776 |
lars |
1 |
# X-editable
|
|
|
2 |
|
|
|
3 |
In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery.
|
|
|
4 |
|
|
|
5 |
## Live demo
|
|
|
6 |
**http://vitalets.github.io/x-editable/demo.html**
|
|
|
7 |
|
|
|
8 |
## Installation
|
|
|
9 |
|
|
|
10 |
### Manual download
|
|
|
11 |
Use **http://vitalets.github.io/x-editable**
|
|
|
12 |
|
|
|
13 |
### Bower
|
|
|
14 |
````
|
|
|
15 |
bower install x-editable
|
|
|
16 |
````
|
|
|
17 |
|
|
|
18 |
### CDN
|
|
|
19 |
````js
|
|
|
20 |
<link href="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.4.6/bootstrap-editable/css/bootstrap-editable.css" rel="stylesheet"/>
|
|
|
21 |
<script src="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.4.6/bootstrap-editable/js/bootstrap-editable.min.js"></script>
|
|
|
22 |
````
|
|
|
23 |
|
|
|
24 |
## Documentation
|
|
|
25 |
**http://vitalets.github.io/x-editable**
|
|
|
26 |
|
|
|
27 |
|
|
|
28 |
## Reporting issues
|
|
|
29 |
When creating issues please provide [jsFiddle](http://jsfiddle.net) example. You can easily fork one of following:
|
|
|
30 |
1. [jsFiddle bootstrap template](http://jsfiddle.net/xBB5x/1817)
|
|
|
31 |
2. [jsFiddle jqueryui template](http://jsfiddle.net/xBB5x/196)
|
|
|
32 |
3. [jsFiddle jquery template](http://jsfiddle.net/xBB5x/197)
|
|
|
33 |
Your feedback is very appreciated!
|
|
|
34 |
|
|
|
35 |
## Contribution
|
|
|
36 |
A few steps how to start contributing:
|
|
|
37 |
|
|
|
38 |
1.[Fork X-editable](https://github.com/vitalets/x-editable/fork) and pull the latest changes from <code>dev</code> branch
|
|
|
39 |
|
|
|
40 |
2.Arrange local directory structure. It should be:
|
|
|
41 |
**x-editable**
|
|
|
42 |
| -- **lib** (repo related to <code>dev</code> and <code>master</code> branches)
|
|
|
43 |
| -- **gh-pages** (repo related to <code>gh-pages</code> branch for docs & demo)
|
|
|
44 |
| -- **playground** (simple node-server and html page for testing, [playground_1.2.zip](https://github.com/downloads/vitalets/x-editable/playground_1.2.zip), **updated in 1.2.0!**)
|
|
|
45 |
|
|
|
46 |
To make it easy follow this script ( _assuming you have [nodejs](http://nodejs.org) installed_ ).
|
|
|
47 |
Please replace <code><your-github-name></code> with your name:
|
|
|
48 |
````
|
|
|
49 |
mkdir x-editable
|
|
|
50 |
cd x-editable
|
|
|
51 |
|
|
|
52 |
#lib
|
|
|
53 |
git clone https://github.com/<your-github-name>/x-editable.git -b dev lib
|
|
|
54 |
cd lib
|
|
|
55 |
#install gruntjs globally - building tool
|
|
|
56 |
npm install -g grunt
|
|
|
57 |
#install other dependencies - grunt-contrib
|
|
|
58 |
npm install
|
|
|
59 |
cd ..
|
|
|
60 |
|
|
|
61 |
#gh-pages
|
|
|
62 |
git clone https://github.com/<your-github-name>/x-editable.git -b gh-pages gh-pages
|
|
|
63 |
cd gh-pages
|
|
|
64 |
npm install
|
|
|
65 |
cd ..
|
|
|
66 |
|
|
|
67 |
#playground
|
|
|
68 |
#download playground.zip from https://github.com/downloads/vitalets/x-editable/playground_1.2.zip
|
|
|
69 |
unzip playground.zip
|
|
|
70 |
cd playground
|
|
|
71 |
npm install
|
|
|
72 |
````
|
|
|
73 |
3.That's it! You can start editing files in **lib/src** directory or create new editable input/container/whatever.
|
|
|
74 |
To test the result go to **playground**, start server <code>node server.js</code> and open in your browser [http://localhost:3000/playground](http://localhost:3000/playground).
|
|
|
75 |
|
|
|
76 |
4.To run unit tests you can open it directly in browser **lib/test/index.html**.
|
|
|
77 |
Or use grunt's _qunit_ task <code>grunt test</code>. For that you also need to [install PhantomJS](https://github.com/gruntjs/grunt/blob/master/docs/faq.md#why-does-grunt-complain-that-phantomjs-isnt-installed)
|
|
|
78 |
|
|
|
79 |
5.To build distributive run <code>grunt build</code> in **lib** directory. Result will appear in **lib/dist**.
|
|
|
80 |
|
|
|
81 |
6.To build docs run <code>build data-docs-dist</code> in **gh-pages** directory. Result will appear in **gh-pages/*.html**.
|
|
|
82 |
Do not edit **index.html** and **docs.html** directly! Instead look at [Handlebars](https://github.com/wycats/handlebars.js) templates in **generator/templates**.
|
|
|
83 |
|
|
|
84 |
7.Commit changes on <code>dev</code> / <code>gh-pages-dev</code> branch and make pull request as usual.
|
|
|
85 |
|
|
|
86 |
Thanks for your support!
|
|
|
87 |
|
|
|
88 |
## License
|
|
|
89 |
Copyright (c) 2012 Vitaliy Potapov
|
|
|
90 |
Licensed under the MIT license.
|