nexus site path corrected
[portal.git] / ecomp-portal-FE / client / bower_components / angular-smart-table / readme.md
1 [![Build Status](https://travis-ci.org/lorenzofox3/Smart-Table.svg?branch=master)](https://travis-ci.org/lorenzofox3/Smart-Table)
2
3 # Smart Table
4 [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/lorenzofox3/Smart-Table?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5
6 Smart Table is a table module for angular js. It allows you to quickly compose your table in a declarative way including sorting, filtering, row selection, and pagination.
7 It is lightweight (around 3kb minified) and has no other dependencies than Angular itself.
8 Check the [documentation](http://lorenzofox3.github.io/smart-table-website/) website for more details
9
10 ## Submitting an issue
11
12 Please be responsible -- investigate potential issues yourself to eliminate the possibility that your issue isn't just an error.  If you are still having problems, try posting on our [gitter](https://gitter.im/lorenzofox3/Smart-Table).  When submitting an issue try as much as possible to:
13
14 1. Search in the already existing issues or on [stackoverflow](http://stackoverflow.com/questions/tagged/smart-table?sort=newest&pageSize=30) if your issue has not been raised before.
15
16 2. Give a precise description mentionning angular version, smart-table version.
17
18 3. Give a way to reproduce your issue, the best would be with a <strong>running example</strong>, you can use [plunkr](http://plnkr.co/) (smart-table is the list of available packages). Note if you want to mimic ajax loading behaviour you can use [$timeout](https://docs.angularjs.org/api/ng/service/$timeout) angular service or [$httpBackend](https://docs.angularjs.org/api/ng/service/$httpBackend).
19
20 4. Isolate your code sample on the probable issue to avoid pollution and noise.
21
22 5. Close your issue when a solution has been found (and share it with the community).
23
24 Note that 80% of the open issues are actually not issues but due to lack of good investigation. These issues create unnecessary work, so please be considerate.
25
26 Any open issue which do not follow the steps above will be closed without investigation.
27
28 ## Install
29
30 The easiest way is to run `bower install angular-smart-table`, then you just have to add the script and register the module `smart-table` to you application.
31
32 ## Test
33
34 Run `npm install` after you have installed the dependencies (`npm install` and `bower install`).
35
36 ## Custom builds
37
38 Smart Table is based around a main directive which generate a top level controller whose API can be accessed by sub directives
39 (plugins). If you don't need some of these, simply edit the gulpfile (the pluginList variable) and run `gulp build`.
40
41 ## Older versions
42
43 Smart Table used to be configuration based and if you rely on this version, you can still access the code on the [0.2.x](https://github.com/lorenzofox3/Smart-Table/tree/vx.2.x) branch. You will be able to find the documentation related to this version
44 [here](https://github.com/lorenzofox3/smart-table-website) (simply open index.html in a browser).
45
46 Note, I have closed all the issues related to these versions as people get confused when reading these issues and commented on them like it was related to the newer version. Feel free to reopen any of them (or open a new one), but don't forget to mention it is related to the older versions.
47
48 ## License
49
50 Smart Table module is under MIT license:
51
52 > Copyright (C) 2015 Laurent Renard.
53 >
54 > Permission is hereby granted, free of charge, to any person
55 > obtaining a copy of this software and associated documentation files
56 > (the "Software"), to deal in the Software without restriction,
57 > including without limitation the rights to use, copy, modify, merge,
58 > publish, distribute, sublicense, and/or sell copies of the Software,
59 > and to permit persons to whom the Software is furnished to do so,
60 > subject to the following conditions:
61 >
62 > The above copyright notice and this permission notice shall be
63 > included in all copies or substantial portions of the Software.
64 >
65 > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
66 > EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
67 > MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
68 > NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
69 > BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
70 > ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
71 > CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
72 > SOFTWARE.