Skip to content

Commit 2edb703

Browse files
kdinevkdinev
committed
Merge pull request #57 from skrustev/master
Add specific files for npm distribution. Update readme files and vers…
2 parents 622890c + 2f967b9 commit 2edb703

File tree

9 files changed

+295
-64
lines changed

9 files changed

+295
-64
lines changed

‎.gitignore‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
node_modules
22
bower_components
3-
dist
43
test_out
54
coverage
6-
instrument
5+
instrument
6+
dist/igniteui-angular.min.js
7+
dist/npm/igniteui-angular.js
8+
dist/npm/igniteui-angular.min.js

‎.npmignore‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎Gruntfile.js‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@ module.exports = function (grunt) {
2929
jshintrc: ".jshintrc",
3030
reporter: require("jshint-stylish")
3131
}
32+
},
33+
34+
exec: {
35+
update_src_npm: {
36+
cmd: 'cp src/igniteui-angular.js dist/npm/'
37+
},
38+
39+
update_min_npm: {
40+
cmd: 'cp dist/igniteui-angular.min.js dist/npm/'
41+
}
3242
}
3343
});
3444

@@ -40,8 +50,9 @@ module.exports = function (grunt) {
4050
grunt.loadNpmTasks("grunt-contrib-uglify");
4151
grunt.loadNpmTasks("grunt-contrib-jshint");
4252
grunt.loadNpmTasks("grunt-contrib-watch");
53+
grunt.loadNpmTasks('grunt-exec');
4354

44-
grunt.registerTask("build", ["uglify"]);
55+
grunt.registerTask("build", ["uglify", "exec:update_src_npm", "exec:update_min_npm"]);
4556

4657
grunt.registerTask("default", ["jshint"]);
4758

‎README.md‎

Lines changed: 63 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#Ignite UI directives for AngularJS
22

3+
[![NPM version](https://img.shields.io/npm/v/igniteui-angular.svg?style=flat)](https://www.npmjs.com/package/igniteui-angular)
34
[![Build Status](https://travis-ci.org/IgniteUI/igniteui-angular.svg?branch=master)](https://travis-ci.org/IgniteUI/igniteui-angular)
45
[![Coverage Status](https://coveralls.io/repos/github/IgniteUI/igniteui-angular/badge.svg?branch=master)](https://coveralls.io/github/IgniteUI/igniteui-angular?branch=master)
56
[![Codacy Badge](https://api.codacy.com/project/badge/grade/f7b38e525b504be0aabc891079530521)](https://www.codacy.com/app/kdinev/igniteui-angular)
@@ -14,8 +15,25 @@ Use the directives found in `igniteui-angular.js` to use [Ignite UI](http://igni
1415

1516
> **Note:** The Ignite UI Angular directives *do not* work with the Ignite UI ASP.NET MVC Helpers
1617
18+
#Install
19+
20+
You can install this package either with `npm` or with `bower`. This is a development repo!
21+
22+
### npm
23+
24+
```shell
25+
npm install igniteui-angular
26+
```
27+
28+
### bower
29+
30+
```shell
31+
bower install igniteui-angular
32+
```
33+
1734
#Building
1835
Build will produce an obfuscated and minified version of the `src/igniteui-angular.js` in the `dist/igniteui-angular.min.js`.
36+
The build will also put the original and the minified version of the `src/igniteui-angular.js` in the `dist/npm` for distribution to npm.
1937
The build uses [Grunt](http://gruntjs.com/), so you need [Node.js](http://nodejs.org/) installed on your machine.
2038
To build the project use the following steps:
2139

@@ -57,33 +75,34 @@ Each control implements a custom tag directive where the tag name is formed by s
5775
**Note**: It is recommended to use closing tags (`</ig-combo>`) over the self-closing tags (`<ig-combo/>`), because the latter are known to make issues on some browsers (depending on the used document mode).
5876

5977
#### Examples:
60-
Control Name | Tag
61-
--- | ---
62-
igCombo | `<ig-combo>`
63-
igGrid | `<ig-grid>`
64-
igDataChart | `<ig-data-chart>`
65-
igDialog | `<ig-dialog>`
66-
igDateEditor | `<ig-date-editor>`
67-
igEditor | `<ig-editor>`
68-
igMaskEditor | `<ig-mask-editor>`
69-
igNumericEditor | `<ig-numeric-editor>`
70-
igPercentEditor | `<ig-percent-editor>`
71-
igTextEditor | `<ig-text-editor>`
72-
igDatePicker | `<ig-date-picker>`
73-
igTree | `<ig-tree>`
74-
igMap | `<ig-map>`
75-
igUpload | `<ig-upload>`
76-
igVideoPlayer | `<ig-video-player>`
78+
79+
| Control Name | Tag |
80+
|-----------------|-----------------------|
81+
| igCombo | `<ig-combo>` |
82+
| igGrid | `<ig-grid>` |
83+
| igDataChart | `<ig-data-chart>` |
84+
| igDialog | `<ig-dialog>` |
85+
| igDateEditor | `<ig-date-editor>` |
86+
| igEditor | `<ig-editor>` |
87+
| igMaskEditor | `<ig-mask-editor>` |
88+
| igNumericEditor | `<ig-numeric-editor>` |
89+
| igPercentEditor | `<ig-percent-editor>` |
90+
| igTextEditor | `<ig-text-editor>` |
91+
| igDatePicker | `<ig-date-picker>` |
92+
| igTree | `<ig-tree>` |
93+
| igMap | `<ig-map>` |
94+
| igUpload | `<ig-upload>` |
95+
| igVideoPlayer | `<ig-video-player>` |
7796

7897
### Configuring Control Options
7998
Simple type control options (`string`, `number`, `bool` etc.) are configured as an attributes on the control element. The options follow the same naming convention logic as the tag name.
8099

81100
#### Examples:
82101

83-
Option | Markup
84-
--- | ---
85-
igGrid.options.localSchemaTransform | `<ig-grid local-schema-transform="true">`
86-
igCombo.options.caseSensitive | `<ig-combo case-sensitive="true">`
102+
| Option | Markup |
103+
|-------------------------------------|-------------------------------------------|
104+
| igGrid.options.localSchemaTransform | `<ig-grid local-schema-transform="true">` |
105+
| igCombo.options.caseSensitive | `<ig-combo case-sensitive="true">` |
87106

88107
Defining complex type control options (`arrays` & `objects`) are configured as a child elements of the main control.
89108

@@ -101,33 +120,34 @@ Binding to control events is done again with attributes. Event attribute names a
101120

102121
#### Examples:
103122

104-
Event | Markup
105-
--- | ---
106-
igGrid.events.dataBind | `<ig-grid event-data-bind="dataBindHandler">`
107-
igCombo.events.textChanged | `<ig-combo event-text-changed="textChangedHandler">`
108-
igDateEditor.events.keypress | `<ig-date-editor event-keypress="keypressHandler">`
123+
| Event | Markup |
124+
|-----------------------------|------------------------------------------------------|
125+
|igGrid.events.dataBind | `<ig-grid event-data-bind="dataBindHandler">` |
126+
|igCombo.events.textChanged | `<ig-combo event-text-changed="textChangedHandler">` |
127+
|igDateEditor.events.keypress | `<ig-date-editor event-keypress="keypressHandler">` |
109128

110129
## Controller Initialization
111130
Each control also implements a custom attribute directive where the attribute name is formed by splitting each capital letter in the control name with the `-` symbol (this naming convention follows the standard Angular normalization process) and the attribute value corresponds to the scope object holding the control options.
112131

113132
#### Examples:
114-
Control | Markup
115-
--- | ---
116-
igCombo | `<div id="combo" data-ig-combo="combo_options"></div>`
117-
igGrid | `<table id="grid" data-ig-grid="grid_options"></table>`
118-
igDataChart | `<div id="chart" data-ig-data-chart="data_chart_options"></div>`
119-
igDialog | `<div id="dialog" data-ig-dialog="dialog_options"></div>`
120-
igDateEditor | `<input id="dialog" data-ig-date-editor="date_editor_options"></input>`
121-
igEditor | `<input id="editor" data-ig-editor="editor_options"></input>`
122-
igMaskEditor | `<input id="editor" data-ig-mask-editor="mask_editor_options"></input>`
123-
igNumericEditor | `<input id="editor" data-ig-numeric-editor="numeric_editor_options"></input>`
124-
igPercentEditor | `<input id="editor" data-ig-percent-editor="precent_editor_options"></input>`
125-
igTextEditor | `<input id="editor" data-ig-text-editor="text_editor_options"></input>`
126-
igDatePicker | `<input id="editor" data-ig-date-picker="date_picker_options"></input>`
127-
igTree | `<ul id="tree" data-ig-tree="tree_options"></ul>`
128-
igMap | `<div id="map" data-ig-map="map_options"></div>`
129-
igUpload | `<div id="upload" data-ig-upload="upload_options"></div>`
130-
igVideoPlayer | `<div id="video" data-ig-video-player="video_options"></div>`
133+
134+
| Control | Markup |
135+
|-----------------|-------------------------------------------------------------------------------|
136+
| igCombo | `<div id="combo" data-ig-combo="combo_options"></div>` |
137+
| igGrid | `<table id="grid" data-ig-grid="grid_options"></table>` |
138+
| igDataChart | `<div id="chart" data-ig-data-chart="data_chart_options"></div>` |
139+
| igDialog | `<div id="dialog" data-ig-dialog="dialog_options"></div>` |
140+
| igDateEditor | `<input id="dialog" data-ig-date-editor="date_editor_options"></input>` |
141+
| igEditor | `<input id="editor" data-ig-editor="editor_options"></input>` |
142+
| igMaskEditor | `<input id="editor" data-ig-mask-editor="mask_editor_options"></input>` |
143+
| igNumericEditor | `<input id="editor" data-ig-numeric-editor="numeric_editor_options"></input>` |
144+
| igPercentEditor | `<input id="editor" data-ig-percent-editor="precent_editor_options"></input>` |
145+
| igTextEditor | `<input id="editor" data-ig-text-editor="text_editor_options"></input>` |
146+
| igDatePicker | `<input id="editor" data-ig-date-picker="date_picker_options"></input>` |
147+
| igTree | `<ul id="tree" data-ig-tree="tree_options"></ul>` |
148+
| igMap | `<div id="map" data-ig-map="map_options"></div>` |
149+
| igUpload | `<div id="upload" data-ig-upload="upload_options"></div>` |
150+
| igVideoPlayer | `<div id="video" data-ig-video-player="video_options"></div>` |
131151

132152
## One-way Data Binding
133153
The following controls currently support one-way data binding:

‎dist/igniteui-angular.min.js‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)