Getting Started with the Kendo UI for Angular Editor
The Editor enables users to create rich textual content through a What-You-See-Is-What-You-Get (WYSIWYG) interface.
It delivers a set of tools for creating, editing, and formatting of text, paragraphs, lists, and other HTML elements.
Basic Usage
The following example demonstrates the Editor in action.
Installation
Either use the quick setup (Angular CLI) or manually add the package.
Quick Setup with Angular CLI
Angular CLI supports the addition of packages through the ng add
command which executes in one step the set of otherwise individually needed commands.
ng add @progress/kendo-angular-editor
Manual Setup
Download and install the package.
npm install --save @progress/kendo-angular-editor @progress/kendo-angular-buttons @progress/kendo-angular-common @progress/kendo-angular-dialog @progress/kendo-angular-dropdowns @progress/kendo-angular-inputs @progress/kendo-angular-intl @progress/kendo-angular-l10n @progress/kendo-angular-popup @progress/kendo-angular-toolbar @progress/kendo-drawing @progress/kendo-licensing
Once installed, import the EditorModule in your application root or feature module.
import { Component, NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; import { CommonModule } from '@angular/common'; import { EditorModule } from '@progress/kendo-angular-editor'; @NgModule({ declarations: [ AppComponent, ], imports: [ RouterModule.forChild( [{ path: '', component: AppComponent }] ), CommonModule, EditorModule ] }) export class AppModule {}
You are required to install one of the Kendo UI themes for Angular to style your component. For more information on how to add the styles, refer to the section on styling.
For Angular 9.x and later, install the
@angular/localize
package:- Run
npm install --save @angular/localize
. - Add
import '@angular/localize/init';
to yoursrc/polyfills.ts
file.
- Run
Follow the instructions on the Kendo UI for Angular My License page to activate your license. You can skip this step if your application already contains a Kendo UI license file.
Dependencies
The Editor package requires you to install the following peer dependencies in your application:
- @angular/common
- @angular/core
- @angular/forms
- rxjs
- @progress/kendo-angular-buttons
- @progress/kendo-angular-common
- @progress/kendo-angular-dialog
- @progress/kendo-angular-dropdowns
- @progress/kendo-angular-inputs
- @progress/kendo-angular-intl
- @progress/kendo-angular-l10n
- @progress/kendo-angular-popup
- @progress/kendo-angular-toolbar
- @progress/kendo-drawing
- @progress/kendo-licensing
The following dependencies are automatically installed:
- prosemirror-commands
- prosemirror-history
- prosemirror-inputrules
- prosemirror-keymap
- prosemirror-schema-basic
- prosemirror-schema-list
- prosemirror-state
- prosemirror-model
- prosemirror-view
- @types/prosemirror-commands
- @types/prosemirror-history
- @types/prosemirror-inputrules
- @types/prosemirror-keymap
- @types/prosemirror-model
- @types/prosemirror-schema-basic
- @types/prosemirror-schema-list
- @types/prosemirror-state
- @types/prosemirror-view
The Editor package utilizes the Angular animation system, which supports a specific set of browsers.
Functionality and Features
Events
The following example demonstrates the valueChange
event of the Editor.