Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 2.31 KB

README.md

File metadata and controls

86 lines (62 loc) · 2.31 KB

NgxEditor

ngxEditor

A Simple WYSIWYG Editor for Angular5+ Applications.

Build Status npm version npm licence

Getting Started

Installation

Install via Package managers such as npm or yarn

npm install ngx-editor --save
# or
yarn add ngx-editor

Usage

Import ngx-editor module

import { NgxEditorModule } from 'ngx-editor';

@NgModule({
  imports: [ NgxEditorModule ]
})

Import font-awesome into your application

Then in HTML

<app-ngx-editor [placeholder]="'Enter text here...'" [spellcheck]="true" [(ngModel)]="htmlContent"></app-ngx-editor>

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

PeerDependencies

ngx-editor depeneds on the following libraries to work.

Compatibility

All Evergreen-Browsers are supported

  • Google Chrome
  • Microsoft Edge
  • Mozilla Firefox
  • Opera

Demo

Demo at stackblitz ngx-editor

Documentation

Documentation is auto-generated using compodoc, and can be viewed here: https://sibiraj-s.github.io/ngx-editor/