Angular Rich Text Editor

Versatile

An adaptable ecosystem capable of handling end-to-end document editing, interoperability with third-party tools, document management, and collaboration.

Explore features

Extensible

Modular architecture where everything is a plugin. You can tune up, add, or remove plugins as you wish. Use custom processors to handle HTML, Markdown, or JSON output.

Create plugin

Progressive

Takes advantage of a superb team of 50+ industry experts and 20+ years of experience in WYSIWYG editing. We are releasing new features every month.

See GitHub

Trusted and approved by

Simple setup

Here is a quick example of how to use the Angular Rich Text Editor component for CKEditor 5 with the Angular CLI!

Create a project

Create a project using a basic Angular CLI template and change the working directory to a newly created project.

npx @angular/cli new ckeditor5-angular-example && cd ckeditor5-angular-example

Install packages

Install dependencies to the Rich Text Editor Angular Component and your chosen Editor Type according to the editing experience of your preference. In this case, we use the classic CKEditor 5 build.

npm install --save @ckeditor/ckeditor5-angular @ckeditor/ckeditor5-build-classic

Add a file

Add a file in src/app/typings.d.ts with the following code:

declare module '@ckeditor/ckeditor5-build-classic' {
  const ClassicEditorBuild: any;
  export = ClassicEditorBuild;
}

Add component

Replace the contents of src/app/app.component.ts with the code responsible for controlling the editor.

import { Component } from '@angular/core';
import * as ClassicEditor from '@ckeditor/ckeditor5-build-classic';
import { ChangeEvent } from '@ckeditor/ckeditor5-angular/ckeditor.component';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})

export class AppComponent {
  title = 'angular-template-ckeditor5-classic';
  public Editor = ClassicEditor;
  public onReady(editor: any) {
    console.log("CKEditor5 Angular Component is ready to use!", editor);
  }
  public onChange({ editor }: ChangeEvent) {
    const data = editor.getData();
    console.log(data);
  }
}

Add module

Replace the contents of src/app/app.module.ts with the code responsible for managing components.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { CKEditorModule } from '@ckeditor/ckeditor5-angular';

import { AppComponent } from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    CKEditorModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Add a template

Replace the contents of src/app/app.component.html with the template containing the editor component.

<header class="inverted">
  <h2>CKEditor 5 Classic in Angular</h2>
</header>
<div class="content" role="main">
  <ckeditor
    [editor]="Editor"
    data="<p>Hello from CKEditor5!</p>"
    (ready)="onReady($event)"
    (change)="onChange($event)"
    >
  </ckeditor>
</div>
<section class="inverted">
  <p>Edit <code>src/app/app.component.ts</code> and save to reload.</p>
  <a href="https://ckeditor.com/docs/ckeditor5/latest/installation/frameworks/angular.html">See docs</a>
</section>

Done!

That’s it! Run the app by executing the following command in your project’s directory.

npm run start

See Engine in action