|
1 |
| -# AngularJS Dropdown Multiselect Directive |
| 1 | +# AngularJS Dropdown Multiselect |
2 | 2 |
|
3 |
| -[TODO - brief summary] |
| 3 | +This directive gives you a Bootstrap Dropdown with the power of AngularJS directives. |
4 | 4 |
|
5 | 5 | ## Demo
|
6 | 6 | http://dotansimha.github.io/angularjs-dropdown-multiselect/
|
7 | 7 |
|
8 | 8 | ## Dependencies
|
9 |
| -- required: |
10 |
| - [TODO] |
11 |
| -- optional |
12 |
| - [TODO] |
| 9 | +- required: AngularJS >= 1.2, Lodash >= 2, Bootstrap >= 3.0 |
13 | 10 |
|
14 |
| -See `bower.json` and `index.html` in the `gh-pages` branch for a full list / more details |
| 11 | +- Make sure to add the dependencies before the directive's js file. |
| 12 | +- Note: Bootstrap JS file is not needed for the directive, it just uses the CSS file. |
15 | 13 |
|
16 | 14 | ## Install
|
17 |
| -1. download the files |
18 |
| - 1. Bower |
19 |
| - 1. add `"angularjs-dropdown-multiselect": "latest"` to your `bower.json` file then run `bower install` OR run `bower install angularjs-dropdown-multiselect` |
20 |
| -2. include the files in your app |
21 |
| - 1. `js-dropdown-multiselect.min.js` |
22 |
| - 2. `js-dropdown-multiselect.less` OR `js-dropdown-multiselect.min.css` OR `js-dropdown-multiselect.css` |
23 |
| -3. include the module in angular (i.e. in `app.js`) - `dotansimha.angularjs-dropdown-multiselect` |
24 |
| - |
25 |
| -See the `gh-pages` branch, files `bower.json` and `index.html` for a full example. |
26 |
| - |
27 |
| - |
28 |
| -## Documentation |
29 |
| -See the `js-dropdown-multiselect.js` file top comments for usage examples and documentation |
30 |
| -https://github.com/dotansimha/angularjs-dropdown-multiselect/blob/master/js-dropdown-multiselect.js |
31 |
| - |
32 |
| -ush origin master --tags` (want to push master branch first so it is the default on github) |
33 |
| - 3. `git checkout gh-pages` |
34 |
| - 4. `git push origin gh-pages` |
35 |
| -5. (optional) register bower component |
36 |
| - 1. `bower register angularjs-dropdown-multiselect [git repo url]` |
| 15 | +1. Download the files |
| 16 | + 1. Using bower: |
| 17 | + Just run `bower install angularjs-dropdown-multiselect` |
| 18 | + 2. Manually: |
| 19 | + You can download the `.js` file directly or clone this repository. |
| 20 | +2. Include the file in your app |
| 21 | + - `<script type="text/javascript" src="angularjs-dropdown-multiselect.js"></script>`. |
| 22 | + - You can also use the minfined version (`angularjs-dropdown-multiselect.min.js`). |
| 23 | +3. Include the module in angular (i.e. in `app.js`) - `angularjs-dropdown-multiselect` |
| 24 | + |
| 25 | + |
| 26 | +## Usage and Documentation |
| 27 | +See the documentation and examples in the GitHub pages: |
| 28 | +http://dotansimha.github.io/angularjs-dropdown-multiselect/ |
| 29 | + |
| 30 | +## TODO: |
| 31 | + - Full documentation for available features. |
0 commit comments