ngx-ckeditor

The CKEditor component for angular(2.x and 4.x)

Usage

Installation

Import CKEditor js file

<script src="//cdn.ckeditor.com/4.7.1/full/ckeditor.js"></script>

Install ngx-ckeditor

npm i -S ngx-ckeditor

Sample

Import CKEditorModule module in your main module:

// app.module.ts

import { CKEditorModule } from 'ngx-ckeditor';

@NgModule({
  imports: [
    // ...
    CKEditorModule
  ],
  // ...
})
export class AppModule {

}

Then use it in your component:

// app.component.html

<ck-editor name="editor1" [(ngModel)]="editorValue" skin="moono-lisa" language="en" [fullPage]="true"></ck-editor>

// app.component.ts

@Component({
  selector: 'app',
  templateUrl: 'app.component.html'
})

export class AppComponent implements OnInit {

  public editorValue: string = '';

  ngOnInit() { }
}

`CKEditorComponent` Options

Type	Name	DataType	Default Value	Description
Input	readonly	boolean	false	Enabled / disable readonly on editor
Input	skin	string	'moono-lisa'	Set the editor skin
Input	language	string	'en'	Set the editor language
Input	fullPage	boolean	false	Enalbed /disable fullPage mode on editor
Input	config	object	{}	CKEditor's config object, see more
Input	inline	boolean	false	Set the inline mode
Two-way	ngModel	string		Two-way binding value

How to develop?

git clone https://github.com/HstarComponents/ngx-ckeditor.git

# install deps
npm i

# run dev
npm run dev

# build demo
npm run build

# build aot demo
npm run build:aot

# publish
npm run lib

FAQ?

1、Metadata version mismatch found version 4, expected 3

A: That because the lib is build for angular 5.x, it will throw the error when your used angular version is 4.x, please use ngx-ckeditor@0.2.x for angular 4.x.

Issues

Create an issue

License

MIT License

deveshmishra34/ngx-ckeditor