@iget/editor/README.md

WYSIWYG Editor for Angular Material applications

# Iget Editor

<p align="center">
  <a href="https://github.com/iget-master/iget-editor">
   <img src="https://raw.githubusercontent.com/iget-master/iget-editor/master/src/assets/icons/iget-editor.png" alt="IgetEditor">
  </a>
</p>
<p align="center">A lightweight WYSIWYG Editor for Angular Material applications.</p>
<p align="center">
  <a href="https://www.npmjs.com/package/@iget/editor">
    <img alt="npm version" src="https://img.shields.io/npm/v/@iget/editor.svg">
  </a>
  <a href="https://www.npmjs.com/package/@iget/editor">
    <img alt="npm" src="https://img.shields.io/npm/dm/@iget/editor.svg">
  </a>
  <a href="https://github.com/iget-master/iget-editor/blob/master/LICENSE">
    <img alt="licence" src="https://img.shields.io/npm/l/@iget/editor.svg">
  </a>
  <a href="https://circleci.com/gh/iget-master/iget-editor">
    <img alt="CircleCI" src="https://circleci.com/gh/iget-master/iget-editor.svg?style=svg">
  </a>
</p>
<p align="center">
  Help me keeping this project alive</br><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PG6CGJ9TQPSFL"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif"></a>
</p>

## Getting Started

This package is a lightweight editor for applications based on Angular Components (*aka Angular Material*). It has zero dependencies, except for the peer dependency on `@angular/angular` and `@angular/components`.

It's compatible with all Evergreen-Browsers

### Installation

Install via Package managers such as [npm][npm] or [yarn][yarn]

```bash
npm install @iget/editor --save
```

#### Choosing correct version

Since v9.0.0 our version matches with the Angular & Angular Components
version that it support. See the compatibility table:

| @angular/angular | @angular/components | @iget/editor |
| ---------------- | ------------------- | ------------ |
|     ^12.0.0      | ^12.0.0             |    ^12.0.0   |
|     ^11.0.0      | ^11.0.0             |    ^11.0.0   |
|     ^10.0.0      | ^10.0.0             |    ^10.0.0   |
|     ^9.0.0       | ^9.0.0              |    ^9.0.0    |
|     ^8.0.0       | ^8.0.0              |    ^2.0.0    |

### Usage

Add `IgetEditorModule` to your imports:

```typescript
import { IgetEditorModule } from '@iget/editor';

@NgModule({
  imports: [ IgetEditorModule ]
})
```

Import [Material Icon font](https://material.io/tools/icons/) into your application by adding this to your `index.html` `head` tag:

    <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
 
Then insert the editor on your template

```html
<iget-editor [(ngModel)]="htmlContent"></iget-editor>
```

For `ngModel` work, You must import `FormsModule` from `@angular/forms`.

## Demo

Demo at stackblitz [iget-editor](https://iget-editor.stackblitz.io/)

## Documentation

For more information about usage, check out [Documentation](https://iget-master.github.io/iget-editor/).

The documentation is auto-generated using [compodoc][compodoc]

## Thanks to

This package is based on [ngx-editor](https://github.com/sibiraj-s/ngx-editor) from [sibiraj-s](https://github.com/sibiraj-s), so this package is thanks to his work.  

[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/lang/en/
[github]: https://iget-master.github.io/
[compodoc]: https://compodoc.github.io/website/