Iget Editor

A lightweight WYSIWYG Editor for Angular Material applications.

Help me keeping this project alive

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 or yarn

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:

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

@NgModule({
  imports: [ IgetEditorModule ]
})

Import Material Icon font 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

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

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

Demo

Demo at stackblitz iget-editor

Documentation

For more information about usage, check out Documentation.

The documentation is auto-generated using compodoc

Thanks to

This package is based on ngx-editor from sibiraj-s, so this package is thanks to his work.