betsol-ng-entity-list
Version:
Automatic entity lists for Angular.js
145 lines (85 loc) • 4.05 kB
Markdown
# betsol-ng-entity-list
[](http://badge.fury.io/bo/betsol-ng-entity-list)
[](http://badge.fury.io/js/betsol-ng-entity-list)
Convenient re-usable controller for lists of entities that makes your code very DRY and consistent.
## Features
- Entity fields are defined by user-provided schema
- List is dynamically generated based on provided schema
- Default list template is built around Bootstrap
- Different field types are supported
- Allows to delete items using user-provided repository
## Dependencies
- [AngularUI Router][ui-router] for navigation between states
- [betsol-ng-paginator][bs-paginator] to fetch list of entities
- [InView Directive for AngularJS][angular-inview] for infinite scrolling
## Installation
### Install library with Bower
`bower i --save betsol-ng-entity-list`
### Install library with NPM
`npm i --save betsol-ng-entity-list`
### Add library to your page
``` html
<script src="/bower_components/betsol-ng-entity-list/dist/betsol-ng-entity-list.js"></script>
```
You should use minified version (`betsol-ng-entity-list.min.js`) in production.
### Add dependency in your application's module definition
``` javascript
var application = angular.module('application', [
// ...
'betsol.entityList'
]);
```
## Usage
@todo
## API
@todo
## Changelog
Please see the [changelog][changelog] for list of changes.
## Feedback
If you have found a bug or have another issue with the library —
please [create an issue][new-issue].
If you have a question regarding the library or it's integration with your project —
consider asking a question at [StackOverflow][so-ask] and sending me a
link via [E-Mail][email]. I will be glad to help.
Have any ideas or propositions? Feel free to contact me by [E-Mail][email].
Cheers!
## FAQ
@todo
## Developer guide
Fork, clone, create a feature branch, implement your feature, cover it with tests, commit, create a PR.
Run:
- `npm i && bower i` to initialize the project
- `gulp build` to re-build the dist files
- `gulp test` or `karma start` to test the code
Do not add dist files to the PR itself.
We will re-compile the module manually each time before releasing.
## Support
If you like this library consider to add star on [GitHub repository][repo-gh].
Thank you!
## License
The MIT License (MIT)
Copyright (c) 2014 - 2015 Slava Fomin II, BETTER SOLUTIONS
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
[changelog]: changelog.md
[so-ask]: http://stackoverflow.com/questions/ask?tags=angularjs,javascript
[email]: mailto:s.fomin@betsol.ru
[new-issue]: https://github.com/betsol/ng-entity-list/issues/new
[gulp]: http://gulpjs.com/
[repo-gh]: https://github.com/betsol/ng-entity-list
[bs-paginator]: https://github.com/betsol/ng-paginator
[ui-router]: https://github.com/angular-ui/ui-router
[angular-inview]: https://github.com/thenikso/angular-inview