Skip to content

Latest commit

 

History

History
135 lines (113 loc) · 3.95 KB

README.md

File metadata and controls

135 lines (113 loc) · 3.95 KB
Raw

X-editable

In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery.

Live Demo

http://vitalets.github.io/x-editable/demo.html

Pull Requests

Please submit all Pull Requests to the develop branch: https://github.com/vitalets/x-editable/tree/develop

Issue Tracker

Please report all issues here: https://github.com/vitalets/x-editable/issues

User Support

Unfortunately, due to this project being supported by volunteers we cannot provide user support at this time. Please try a site like Stack Overflow: http://stackoverflow.com/questions/tagged/x-editable

Documentation

http://vitalets.github.io/x-editable

Project Status

Actively Maintained

How to get it

Manual download

Use http://vitalets.github.io/x-editable main page.

Bower

bower install x-editable

CDN

Bootstrap 3 build:

<link href="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/bootstrap3-editable/css/bootstrap-editable.css" rel="stylesheet"/>
<script src="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/bootstrap3-editable/js/bootstrap-editable.min.js"></script>

Bootstrap 2 build:

<link href="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/bootstrap-editable/css/bootstrap-editable.css" rel="stylesheet"/>
<script src="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/bootstrap-editable/js/bootstrap-editable.min.js"></script>

jQuery UI build:

<link href="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/jqueryui-editable/css/jqueryui-editable.css" rel="stylesheet"/>
<script src="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/jqueryui-editable/js/jqueryui-editable.min.js"></script>

jQuery only build:

<link href="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/jquery-editable/css/jquery-editable.css" rel="stylesheet"/>
<script src="//cdnjs.cloudflare.com/ajax/libs/x-editable/1.5.0/jquery-editable/js/jquery-editable-poshytip.min.js"></script>

Reporting issues

Please provide jsFiddle when creating issues!
It's really saves much time. Use these as template:

  1. jsFiddle Bootstrap 3
  2. jsFiddle Bootstrap 2
  3. jsFiddle jQuery-ui
  4. jsFiddle jQuery
    Your feedback is very appreciated!

Contribution

A few steps how to start contributing.
Assuming you have Node.js already installed.

1.Fork X-editable on github and clone it to your local mashine:

git clone https://github.com/<your-github-name>/x-editable.git -b dev

2.Install grunt-cli globally (if not yet):

npm i -g grunt-cli

3.Install dependencies:

cd x-editable
npm i

4.Make your changes:

vim editable-form.js

5.Write some tests for your changes:

vim /test/unit/*.js

6.Run tests in cli:

grunt test

or directly in browser:

grunt server

and open http://127.0.0.1:8000/test
By default test run on bootstrap 3 popup version, but you can test any other build:

7.Commit and push back on github:

git add .
git commit -m'refactor editable form, fix #123'
git push origin

8.Make pull request on github (to dev branch).

Thanks for your support!

Local build

To build x-editable locally please run:

grunt build

Result will appear in dist directory.

License

Copyright (c) 2012 Vitaliy Potapov
Licensed under the MIT license.