|
1 | | -# angular-handsontable [](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 | +[](//travis-ci.org/handsontable/angular-handsontable) |
| 8 | + |
| 9 | +<br/> |
3 | 10 |
|
4 | 11 | ## Table of contents |
| 12 | + |
5 | 13 | 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) |
11 | 23 |
|
12 | | -## Installation |
13 | | -To install a wrapper for Handsontable Community Edition (CE): |
| 24 | +<br/> |
14 | 25 |
|
| 26 | +## Installation |
| 27 | +Use npm to download the project. |
| 28 | +```bash |
| 29 | +npm install handsontable @handsontable/angular |
15 | 30 | ``` |
16 | | -npm install @handsontable/angular handsontable |
| 31 | +A package scope for Handsontable Pro users: |
| 32 | +```bash |
| 33 | +npm install handsontable-pro @handsontable-pro/angular |
17 | 34 | ``` |
18 | 35 |
|
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. |
23 | 40 |
|
24 | | -## Basic usage |
| 41 | +### Handsontable Community Edition: |
25 | 42 |
|
26 | | -styles.css |
27 | | -```scss |
| 43 | +**Styles** |
| 44 | +```js |
28 | 45 | @import '~handsontable/dist/handsontable.full.css'; |
29 | 46 | ``` |
30 | 47 |
|
31 | | -app/app.module.ts |
32 | | -```javascript |
| 48 | +**Component** |
| 49 | +```js |
33 | 50 | import { BrowserModule } from '@angular/platform-browser'; |
34 | 51 | import { NgModule } from '@angular/core'; |
35 | 52 | import { AppComponent } from './app.component'; |
36 | 53 | 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 | +``` |
37 | 73 |
|
| 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 | + |
38 | 88 | @NgModule({ |
39 | 89 | declarations: [ |
40 | 90 | AppComponent |
41 | 91 | ], |
42 | 92 | imports: [ |
43 | 93 | BrowserModule, |
44 | | - HotTableModule |
| 94 | + HotTableModule.forRoot() |
45 | 95 | ], |
46 | 96 | providers: [], |
47 | 97 | bootstrap: [AppComponent] |
48 | 98 | }) |
49 | 99 | export class AppModule { } |
50 | 100 | ``` |
51 | 101 |
|
52 | | -app/app.component.html |
| 102 | +**Template** |
53 | 103 | ```html |
54 | 104 | <hot-table></hot-table> |
55 | 105 | ``` |
56 | | -## Examples |
57 | | -- [A basic implementation for Handsontable CE](https://stackblitz.com/edit/angular-handsontable-ce) |
58 | 106 |
|
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 |
63 | 127 |
|
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: |
66 | 129 |
|
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 |
69 | 143 |
|
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. |
0 commit comments