Skip to content

Commit 76cf3fb

Browse files
Zhuk, AlexanderZhuk, Alexander
authored andcommitted
adding NPM INSTALL support and updated descriptions
1 parent ab1d19e commit 76cf3fb

File tree

3 files changed

+33
-9
lines changed

3 files changed

+33
-9
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
##Angular Data Grid
22
Light, flexible and performant Data Grid for AngularJS apps, with built-in sorting, pagination and filtering options, unified API for client-side and server-side data fetching,
3-
seamless synchronization with browser address bar and total freedom in mark-up and styling suitable for your application.
3+
seamless synchronization with browser address bar and total freedom in mark-up and styling suitable for your application. Angular 1.3 - 1.5 compliant.
44

55
Demo Bootstrap: http://angular-data-grid.github.io/demo/bootstrap/
66

@@ -156,7 +156,7 @@ Directive is built on a base of excellent [Angular UI](https://angular-ui.github
156156
</pagination>
157157
```
158158
159-
Settings can be provided as attributes in the <pagination> or globally configured through the paginationConfig.
159+
Settings can be provided as attributes in the <pagination> or globally configured through the `paginationConfig`.
160160
161161
```ng-change``` : ng-change can be used together with ng-model to call a function whenever the page changes.
162162
@@ -190,8 +190,8 @@ Settings can be provided as attributes in the <pagination> or globally configure
190190
191191
### Filters
192192
Data Grid supports 4 built-in types of filters: `text`, `select`, `dateFrom` and `dateTo`.
193-
To use it, add attribute `filter-by` to any element and pass property name, which you want filtering.
194-
Also you need add attribute `filter-type` with type of filter.
193+
To use it, add attribute `filter-by` to any element and pass property name, which you want to be filtered.
194+
Also you need add attribute `filter-type` with type of filter.
195195
After that you need call `filter()` method in `ng-change` for text or select inputs and in `ng-blur/ng-focus` for datepickers.
196196
Filters are synchronized with URL by `ng-model` value.
197197
@@ -207,7 +207,7 @@ Filters are synchronized with URL by `ng-model` value.
207207
```
208208
209209
### Custom Filters
210-
If you need use some custom filters (f.e. filter by first letter), add `filter-by` to specify property name, which you want filtering and add `ng-model` property.
210+
If you need to use some custom filters (e.g. filter by first letter), add `filter-by` to specify property name, which you want filtering and add `ng-model` property.
211211
Then create in `gridOptions.customFilters` variable named as `ng-model` with filtering function. Filtering function accepts items, value, predicate arguments and returns filtered array.
212212
213213
```javascript
@@ -228,4 +228,4 @@ Then create in `gridOptions.customFilters` variable named as `ng-model` with fil
228228
### Others
229229
All filters have optional parameter `disable-url`. If you set it to **true**, URL-synchronization for this filter will be disabled.
230230
231-
If you need to use 2 or more grids on page, please add id to grids, and then use ```grid-id``` attribute on filters to specify their corresponding grid. [example](http://angular-data-grid.github.io/demo/bootstrap/multiple.html)
231+
If you need to use 2 or more grids on page, please add `id` to grids, and then use `grid-id` attribute on filters to specify their corresponding grid. [Example](http://angular-data-grid.github.io/demo/bootstrap/multiple.html)

demo/bootstrap/multiple.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<div class="container">
2121
<div>
2222
<h3>Angular Data Grid - Multiple Grids Example</h3>
23-
You need to assign <code>id</code> attribute for each grid instance on a page to make them work simultaneously. If you use external filtering, assign <code>grid-id</code> to id and <code>ng-change</code> to associated
23+
You need to assign <code>id</code> attribute for each grid instance on a page to make them work simultaneously. If you use external filtering, assign <code>grid-id</code> to grid id and <code>ng-change</code> to associated
2424
<code>gridActions</code> (see example below).
2525
<a href="https://github.com/angular-data-grid/angular-data-grid.github.io" target="_blank">Project GitHub</a>
2626
</div>

package.json

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "data-grid",
2+
"name": "angular-data-grid",
33
"version": "0.1.0",
44
"scripts": {
55
"start": "gulp serve",
@@ -13,5 +13,29 @@
1313
"gulp-rimraf": "*",
1414
"gulp-sass": "^2.1.0",
1515
"gulp-uglify": "^1.4.2"
16-
}
16+
},
17+
"description": "Light, flexible and performant Data Grid for AngularJS apps, with built-in sorting, pagination and filtering options, unified API for client-side and server-side data fetching, \r seamless synchronization with browser address bar and total freedom in mark-up and styling suitable for your application. Angular 1.3 - 1.5 compliant.",
18+
"main": "index.html",
19+
"devDependencies": {},
20+
"repository": {
21+
"type": "git",
22+
"url": "git+https://github.com/angular-data-grid/angular-data-grid.github.io.git"
23+
},
24+
"keywords": [
25+
"angular data grid",
26+
"data grid",
27+
"data grid for angular",
28+
"ng-data-grid",
29+
"ng-table",
30+
"angular table",
31+
"bootstra data grid",
32+
"material design grid",
33+
"data table"
34+
],
35+
"author": "Alexander Zhuk <alexander.zhuk83@gmail.com> (https://github.com/angular-data-grid/angular-data-grid.github.io)",
36+
"license": "ISC",
37+
"bugs": {
38+
"url": "https://github.com/angular-data-grid/angular-data-grid.github.io/issues"
39+
},
40+
"homepage": "https://github.com/angular-data-grid/angular-data-grid.github.io#readme"
1741
}

0 commit comments

Comments
 (0)