Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@iget/editor

iget-master103MIT13.2.1TypeScript support: included

WYSIWYG Editor for Angular Material applications

angular-editor, angular-wysiwyg-editor, wysiwyg-editor, ngx-editor, iget-editor, angular2-wysiwyg-editor, angular4-wysiwyg-editor

readme

Iget Editor

IgetEditor

A lightweight WYSIWYG Editor for Angular Material applications.

npm version npm licence CircleCI

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.

changelog

v13.2.1

| | Description | Issue # | |---------|---------------------------------------------------|---------| | Fix | Remove unused HttpClient imports and dependency | |

v13.2.0

| | Description | Issue # | |---------|--------------------------------------------------------------------------------|---------| | Feature | Allow disabling resizer by passing resizable: false on options | | | Feature | Added toolbarPosition option to show toolbar before or after the content | #10 | | Docs | Refresh and update the documentation | |

v13.1.2

  • Remove unwanted console.log calls

v13.1.1

  • Fix missing @Output initializer on IgetEditorGrippieComponent

v13.1.0

  • Renamed outputs: blur to blured and focus to focused

v13.0.0

  • Make compatible with Angular 13

v12.0.1

  • Rename interface file to remove .d suffix to include it in bundle

v12.0.0

  • Make compatible with Angular 12

v11.0.0

  • Make compatible with Angular 11

v10.0.0

  • Make compatible with Angular 10

v9.1.0

Features

  • Added 8x8 color palette for Text and Fill color buttons
  • Toolbar configuration now works as intended to do, allowing manually set groups and buttons that should be enabled (Issue #4)
  • Font family button dropdown now shows a sample of each font
  • Font size button dropdown now shows a sample of each size

Fixes

  • Fixed toolbar breaking line inside group (Issue #1)
  • Fixed resizing

Internal improvements

  • Removed unnecessary inputs. Now options relies only on config input
  • Updated devDependencies to use Angular 9.1
  • Textarea content now is bound using [innerHtml] instead of directly manipulating element innerHtml.