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

Commit 440c277

Browse files
authored
Merge readme (#80)
* Update README.md * Update README. Fixed typos.
1 parent 2662156 commit 440c277

1 file changed

Lines changed: 70 additions & 9 deletions

File tree

README.md

Lines changed: 70 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,73 @@
11
# angular-handsontable [![Build Status](https://travis-ci.org/handsontable/angular-handsontable.png?branch=master)](https://travis-ci.org/handsontable/angular-handsontable)
2-
Official Angular 2-4 module for Handsontable [Handsontable](https://github.com/handsontable/handsontable).
3-
4-
-> `Handsontable Pro` might not work with `angular-cli` newer than `1.1.0`
2+
Official Angular module for [Handsontable](https://github.com/handsontable/handsontable).
53

64
## Table of contents
7-
1. [Documentation](https://handsontable.github.io/angular-handsontable/)
8-
2. [Installation](https://handsontable.github.io/angular-handsontable/quick-start)
9-
3. [License](https://handsontable.github.io/angular-handsontable/license)
10-
4. [Support](https://handsontable.github.io/angular-handsontable/support)
11-
5. [Examples](https://handsontable.github.io/angular-handsontable/examples)
12-
6. [Other wrappers](https://handsontable.github.io/angular-handsontable/other-wrappers)
5+
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)
11+
12+
## Installation
13+
To install a wrapper for Handsontable Community Edition (CE):
14+
15+
```
16+
npm install @handsontable/angular handsontable
17+
```
18+
19+
To install a wrapper for Handsontable PRO:
20+
```
21+
npm install @handsontable-pro/angular handsontable-pro
22+
```
23+
24+
## Basic usage
25+
26+
styles.css
27+
```scss
28+
@import '~handsontable/dist/handsontable.full.css';
29+
```
30+
31+
app/app.module.ts
32+
```javascript
33+
import { BrowserModule } from '@angular/platform-browser';
34+
import { NgModule } from '@angular/core';
35+
import { AppComponent } from './app.component';
36+
import { HotTableModule } from '@handsontable/angular';
37+
38+
@NgModule({
39+
declarations: [
40+
AppComponent
41+
],
42+
imports: [
43+
BrowserModule,
44+
HotTableModule
45+
],
46+
providers: [],
47+
bootstrap: [AppComponent]
48+
})
49+
export class AppModule { }
50+
```
51+
52+
app/app.component.html
53+
```html
54+
<hot-table></hot-table>
55+
```
56+
## Examples
57+
- [A basic implementation for Handsontable CE](https://stackblitz.com/edit/angular-handsontable-ce)
58+
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.
63+
64+
## Contact
65+
Feel free to give us feedback on this wrapper using this [contact form](https://handsontable.com/contact.html).
66+
67+
## Other Wrappers
68+
Handsontable is available for other popular frameworks:
69+
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)

0 commit comments

Comments
 (0)