Skip to content
This repository was archived by the owner on Mar 16, 2021. It is now read-only.

Commit 7c06931

Browse files
committed
Merge branch 'release/2.0.0'
2 parents d7f23d0 + faf9513 commit 7c06931

26 files changed

Lines changed: 11333 additions & 8173 deletions

LICENSE

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
(The MIT License)
22

3-
Copyright (c) 2012-2014 Marcin Warpechowski
4-
Copyright (c) 2015 Handsoncode sp. z o.o. <hello@handsoncode.net>
3+
Copyright (c) Handsoncode sp. z o.o. <hello@handsoncode.net>
54

65
Permission is hereby granted, free of charge, to any person obtaining
76
a copy of this software and associated documentation files (the

README.md

Lines changed: 143 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,181 @@
1-
# angular-handsontable [![Build Status](https://travis-ci.org/handsontable/angular-handsontable.png?branch=master)](https://travis-ci.org/handsontable/angular-handsontable)
2-
Official Angular module for [Handsontable](https://github.com/handsontable/handsontable).
1+
<img src="https://raw.githubusercontent.com/handsontable/static-files/master/Images/Logo/Handsontable/handsontable-angular.png" alt="Handsontable for Angular" />
2+
3+
<br/>
4+
5+
**Handsontable for Angular** is the official wrapper for [**Handsontable**](//github.com/handsontable/handsontable), a JavaScript data grid component with a spreadsheet look & feel. It easily integrates with any data source and comes with lots of useful features like data binding, validation, sorting or powerful context menu.
6+
7+
[![Build status](https://travis-ci.org/handsontable/angular-handsontable.png?branch=master)](//travis-ci.org/handsontable/angular-handsontable)
8+
9+
<br/>
310

411
## Table of contents
12+
513
1. [Installation](#installation)
6-
2. [Basic usage](#basic-usage)
7-
3. [Documentation](https://handsontable.github.io/angular-handsontable/)
8-
4. [License](#license)
9-
5. [Contact](#contact)
10-
6. [Other wrappers](#other-wrappers)
14+
2. [Getting Started](#getting-started)
15+
3. [Documentation](#documentation)
16+
4. [What to use it for?](#what-to-use-it-for)
17+
5. [Features](#features)
18+
6. [Screenshot](#screenshot)
19+
7. [Resources](#resources)
20+
8. [Support](#support)
21+
9. [Contributing](#contributing)
22+
10. [Licensing](#licensing)
1123

12-
## Installation
13-
To install a wrapper for Handsontable Community Edition (CE):
24+
<br/>
1425

26+
## Installation
27+
Use npm to download the project.
28+
```bash
29+
npm install handsontable @handsontable/angular
1530
```
16-
npm install @handsontable/angular handsontable
31+
A package scope for Handsontable Pro users:
32+
```bash
33+
npm install handsontable-pro @handsontable-pro/angular
1734
```
1835

19-
To install a wrapper for Handsontable PRO:
20-
```
21-
npm install @handsontable-pro/angular handsontable-pro
22-
```
36+
<br/>
37+
38+
## Getting Started
39+
Assuming that you have installed the wrapper with npm, now you just need to include Handsontable styles into your build system and use `<hot-table>` just like any other Angular component.
2340

24-
## Basic usage
41+
### Handsontable Community Edition:
2542

26-
styles.css
27-
```scss
43+
**Styles**
44+
```js
2845
@import '~handsontable/dist/handsontable.full.css';
2946
```
3047

31-
app/app.module.ts
32-
```javascript
48+
**Component**
49+
```js
3350
import { BrowserModule } from '@angular/platform-browser';
3451
import { NgModule } from '@angular/core';
3552
import { AppComponent } from './app.component';
3653
import { HotTableModule } from '@handsontable/angular';
54+
55+
@NgModule({
56+
declarations: [
57+
AppComponent
58+
],
59+
imports: [
60+
BrowserModule,
61+
HotTableModule.forRoot()
62+
],
63+
providers: [],
64+
bootstrap: [AppComponent]
65+
})
66+
export class AppModule { }
67+
```
68+
69+
**Template**
70+
```html
71+
<hot-table></hot-table>
72+
```
3773

74+
### Handsontable Pro:
75+
76+
**Styles**
77+
```js
78+
@import '~handsontable-pro/dist/handsontable.full.css';
79+
```
80+
81+
**Angular Component**
82+
```js
83+
import { BrowserModule } from '@angular/platform-browser';
84+
import { NgModule } from '@angular/core';
85+
import { AppComponent } from './app.component';
86+
import { HotTableModule } from '@handsontable-pro/angular';
87+
3888
@NgModule({
3989
declarations: [
4090
AppComponent
4191
],
4292
imports: [
4393
BrowserModule,
44-
HotTableModule
94+
HotTableModule.forRoot()
4595
],
4696
providers: [],
4797
bootstrap: [AppComponent]
4898
})
4999
export class AppModule { }
50100
```
51101

52-
app/app.component.html
102+
**Template**
53103
```html
54104
<hot-table></hot-table>
55105
```
56-
## Examples
57-
- [A basic implementation for Handsontable CE](https://stackblitz.com/edit/angular-handsontable-ce)
58106

59-
## License
60-
@handsontable/angular is released under the [MIT license](https://github.com/handsontable/angular-handsontable/blob/master/LICENSE).
61-
@handsontable-pro/angular is released under the [MIT license](https://github.com/handsontable/angular-handsontable/blob/master/LICENSE).
62-
Copyrights belong to Handsoncode sp. z o.o.
107+
<br/>
108+
109+
## Documentation
110+
Visit [docs.handsontable.com](https://docs.handsontable.com/angular) to get more Handsontable for Angular examples and guides.
111+
112+
<br/>
113+
114+
## What to use it for?
115+
The list below gives a rough idea on what you can do with Handsontable, but it shouldn't limit you in any way:
116+
117+
- Database editing
118+
- Configuration controlling
119+
- Data merging
120+
- Team scheduling
121+
- Sales reporting
122+
- Financial analysis
123+
124+
<br/>
125+
126+
## Features
63127

64-
## Contact
65-
Feel free to give us feedback on this wrapper using this [contact form](https://handsontable.com/contact.html).
128+
Some of the most popular features include:
66129

67-
## Other Wrappers
68-
Handsontable is available for other popular frameworks:
130+
- Sorting data
131+
- Data validation
132+
- Conditional formatting
133+
- Freezing rows/columns
134+
- Merging cells
135+
- Defining custom cell types
136+
- Moving rows/columns
137+
- Resizing rows/columns
138+
- Context menu
139+
- Adding comments to cells
140+
- Dragging fill handle to populate data
141+
- Internationalization
142+
- Non-contiguous selection
69143

70-
- [hot-table](https://github.com/handsontable/hot-table) (Polymer - WebComponents)
71-
- [ngHandsontable](https://github.com/handsontable/ngHandsontable) (Angular 1)
72-
- [vue-handsontable-official](https://github.com/handsontable/vue-handsontable-official) (Vue.js)
73-
- [react-handsotable](https://github.com/handsontable/react-handsontable) (React)
144+
<br/>
145+
146+
## Screenshot
147+
<div align="center">
148+
<a href="//handsontable.com/examples">
149+
<img src="https://raw.githubusercontent.com/handsontable/static-files/master/Images/Screenshots/handsontable-ce-showcase.png" align="center" alt="Handsontable for Angular" />
150+
</a>
151+
</div>
152+
153+
<br/>
154+
155+
## Resources
156+
- [Guides](//docs.handsontable.com/angular)
157+
- [API Reference](//docs.handsontable.com/Core.html)
158+
- [Release notes](//github.com/handsontable/angular-handsontable/releases)
159+
- [Roadmap](//trello.com/b/PztR4hpj)
160+
- [Twitter](//twitter.com/handsontable)
161+
162+
<br/>
163+
164+
## Support
165+
You can report your issues here on [GitHub](//github.com/handsontable/angular-handsontable/issues).
166+
167+
An open source version of Handsontable doesn't include technical support. You need to purchase the [Handsontable Pro](//handsontable.com/pricing) license or [contact us](//handsontable.com/contact) directly in order to obtain a technical support from the Handsontable team.
168+
169+
<br/>
170+
171+
## Contributing
172+
If you would like to help us to develop this wrapper for Angular, please read the [guide for contributors](//github.com/handsontable/angular-handsontable/blob/master/CONTRIBUTING.md) first.
173+
174+
<br/>
175+
176+
## Licensing
177+
This wrapper is released under [the MIT license](//github.com/handsontable/angular-handsontable/blob/master/LICENSE).
178+
179+
<br/>
180+
181+
Copyrights belong to Handsoncode sp. z o.o.

lib/ce/README.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<img src="https://raw.githubusercontent.com/handsontable/static-files/master/Images/Logo/Handsontable/handsontable-angular.png" alt="Handsontable Community Edition for Angular" />
2+
3+
<br/>
4+
5+
**Handsontable Community Edition for Angular** is the official wrapper for [**Handsontable Community Edition**](//github.com/handsontable/handsontable), an open source data grid component with a spreadsheet look & feel. It easily integrates with any data source and comes with lots of useful features like data binding, validation, sorting or powerful context menu.
6+
7+
[![Build status](https://travis-ci.org/handsontable/angular-handsontable.png?branch=master)](//travis-ci.org/handsontable/angular-handsontable)
8+
9+
<br/>
10+
11+
## Table of contents
12+
13+
1. [Installation](#installation)
14+
2. [Getting Started](#getting-started)
15+
4. [Documentation](#documentation)
16+
5. [What to use it for?](#what-to-use-it-for)
17+
6. [Features](#features)
18+
7. [Screenshot](#screenshot)
19+
8. [Resources](#resources)
20+
9. [Support](#support)
21+
10. [Contributing](#contributing)
22+
11. [Licensing](#licensing)
23+
24+
<br/>
25+
26+
## Installation
27+
Use npm to download the project.
28+
```bash
29+
npm install handsontable @handsontable/angular
30+
```
31+
32+
<br/>
33+
34+
## Getting Started
35+
Assuming that you have installed the wrapper with npm, now you just need to include Handsontable styles into your build system and use `<hot-table>` just like any other Angular component.
36+
37+
**Styles**
38+
```js
39+
@import '~handsontable/dist/handsontable.full.css';
40+
```
41+
42+
**Angular Component**
43+
```js
44+
import { BrowserModule } from '@angular/platform-browser';
45+
import { NgModule } from '@angular/core';
46+
import { AppComponent } from './app.component';
47+
import { HotTableModule } from '@handsontable/angular';
48+
49+
@NgModule({
50+
declarations: [
51+
AppComponent
52+
],
53+
imports: [
54+
BrowserModule,
55+
HotTableModule.forRoot()
56+
],
57+
providers: [],
58+
bootstrap: [AppComponent]
59+
})
60+
export class AppModule { }
61+
```
62+
63+
**Template**
64+
```html
65+
<hot-table></hot-table>
66+
```
67+
68+
<br/>
69+
70+
## Documentation
71+
Visit [docs.handsontable.com](https://docs.handsontable.com/angular) to get more Handsontable for Angular examples and guides.
72+
73+
<br/>
74+
75+
## What to use it for?
76+
The list below gives a rough idea on what you can do with Handsontable, but it shouldn't limit you in any way:
77+
78+
- Database editing
79+
- Configuration controlling
80+
- Data merging
81+
- Team scheduling
82+
- Sales reporting
83+
- Financial analysis
84+
85+
<br/>
86+
87+
## Features
88+
89+
Some of the most popular features include:
90+
91+
- Sorting data
92+
- Data validation
93+
- Conditional formatting
94+
- Freezing rows/columns
95+
- Merging cells
96+
- Defining custom cell types
97+
- Moving rows/columns
98+
- Resizing rows/columns
99+
- Context menu
100+
- Adding comments to cells
101+
- Dragging fill handle to populate data
102+
- Internationalization
103+
- Non-contiguous selection
104+
105+
<br/>
106+
107+
## Screenshot
108+
<div align="center">
109+
<a href="//handsontable.com/examples">
110+
<img src="https://raw.githubusercontent.com/handsontable/static-files/master/Images/Screenshots/handsontable-ce-showcase.png" align="center" alt="Handsontable Community Edition for Angular" />
111+
</a>
112+
</div>
113+
114+
<br/>
115+
116+
## Resources
117+
- [Guides](//docs.handsontable.com/angular)
118+
- [API Reference](//docs.handsontable.com/Core.html)
119+
- [Release notes](//github.com/handsontable/angular-handsontable/releases)
120+
- [Roadmap](//trello.com/b/PztR4hpj)
121+
- [Twitter](//twitter.com/handsontable)
122+
123+
<br/>
124+
125+
## Support
126+
You can report your issues here on [GitHub](//github.com/handsontable/angular-handsontable/issues).
127+
128+
An open source version of Handsontable doesn't include technical support. You need to purchase the [Handsontable Pro](//handsontable.com/pricing) license or [contact us](//handsontable.com/contact) directly in order to obtain a technical support from the Handsontable team.
129+
130+
<br/>
131+
132+
## Contributing
133+
If you would like to help us to develop this wrapper for Angular, please read the [guide for contributors](//github.com/handsontable/angular-handsontable/blob/master/CONTRIBUTING.md) first.
134+
135+
<br/>
136+
137+
## Licensing
138+
This wrapper is released under [the MIT license](//github.com/handsontable/angular-handsontable/blob/master/LICENSE).
139+
140+
<br/>
141+
142+
Copyrights belong to Handsoncode sp. z o.o.

lib/ce/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
{
22
"name": "@handsontable/angular",
33
"version": "1.0.0-beta4",
4+
"keywords": [],
45
"peerDependencies": {
5-
"handsontable": "0.35.1",
6+
"handsontable": "^4.0.0",
67
"zone.js": "^0.8.19"
78
},
89
"ngPackage": {

0 commit comments

Comments
 (0)