Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vitalets/x-editable

In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery
https://github.com/vitalets/x-editable

Last synced: 5 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/vitalets/x-editable
Owner: vitalets
License: mit
Created: 2012-11-19T14:12:46.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2022-12-02T16:58:35.000Z (almost 2 years ago)
Last Synced: 2024-05-17T07:01:01.298Z (6 months ago)
Language: JavaScript
Homepage: http://vitalets.github.io/x-editable
Size: 9.78 MB
Stars: 6,488
Watchers: 302
Forks: 1,724
Open Issues: 620
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE-MIT

Awesome Lists containing this project

awesome-bootstrap - editable field - editable) (add-ons / inputs)
awesome-starred - vitalets/x-editable - In-place editing with Twitter Bootstrap, jQuery UI or pure jQuery (others)

README

# 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

## 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:
````html

````

Bootstrap 2 build:
````html

````

jQuery UI build:
````html

````

jQuery only build:
````html

````

## Reporting issues
Please **provide jsFiddle** when creating issues!
It's really saves much time. Use these as template:
1. [jsFiddle Bootstrap 3](http://jsfiddle.net/xBB5x/2265/)
2. [jsFiddle Bootstrap 2](http://jsfiddle.net/xBB5x/1817/)
3. [jsFiddle jQuery-ui](http://jsfiddle.net/xBB5x/2511/)
4. [jsFiddle jQuery](http://jsfiddle.net/xBB5x/197)
Your feedback is very appreciated!

## Contribution
A few steps how to start contributing.
Assuming you have [Node.js](http://nodejs.org/) already installed.

1.Fork *X-editable* on github and clone it to your local mashine:
````
git clone https://github.com//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:

* bootstrap 3
* popup: http://127.0.0.1:8000/test/?f=bootstrap3&c=popup
* inline: http://127.0.0.1:8000/test/?f=bootstrap3&c=inline
* bootstrap 2
* popup: http://127.0.0.1:8000/test/?f=bootstrap2&c=popup
* inline: http://127.0.0.1:8000/test/?f=bootstrap2&c=inline
* jquery-ui
* popup: http://127.0.0.1:8000/test/?f=jqueryui&c=popup
* inline: http://127.0.0.1:8000/test/?f=jqueryui&c=inline
* jquery + poshytip
* popup: http://127.0.0.1:8000/test/?f=plain&c=popup
* inline: http://127.0.0.1:8000/test/?f=plain&c=inline

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.