ngx-ckeditor

The CKEditor 4.x component for angular

If you used the ckeditor 5.x, please see: https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/angular.html#quick-start

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

Version Rules (Imports)

In order to match angular version, the ngx-ckeditor version no will same as angular majar version.

• 0.2.x: for angular 2.x ~ 4.x
• 0.4.x: for angular 5.x ~ 7.x
• 8.x.x: for angular 8.x
• 10.x.x: for angular 10.x
• 11.x.x: for angular 11.x
• 12.x.x: for angular 12.x

How to develop?

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

# install deps
npm i

# run dev
npm start

# build demo
npm run build:ngx-ckeditor-examples

# build lib
npm run build:ngx-ckeditor

# test
npm test

# Upgrade angular version
ng update 
ng update @angular/core@12 @angular/cli@12

# Package Publish
npm run build:ngx-ckeditor
cp README.md dist/ngx-ckeditor/README.md && cp CHANGELOG.md dist/ngx-ckeditor/CHANGELOG.md && cd dist/ngx-ckeditor
npm publish

# Update Docs Site
npm run build:ngx-ckeditor-examples
# replace docs/index.html content

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 [email protected] for angular 4.x.

Issues

Create an issue

[Changelog]

Changelog

License

MIT License