Skip to content

README.md

Latest commit

 

History

History
80 lines (56 loc) · 3.03 KB

README.md

File metadata and controls

80 lines (56 loc) · 3.03 KB
Raw

Official TinyMCE Angular Component

About

Official Angular component for TinyMCE, the rich text editor. It wraps TinyMCE as an Angular <editor> component. By default it pulls TinyMCE from the Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the tinymce NPM package.

Quickstart

Cloud CDN

  1. Sign up for a Tiny Cloud account to receive a Tiny Cloud API key.
  2. Then in your Angular project:
    1. npm install @tinymce/tinymce-angular
    2. Include the following code: 
      import { Component } from '@angular/core';
import { EditorComponent } from '@tinymce/tinymce-angular';

@Component({
  selector: 'app-root',
  imports: [EditorComponent],
  template: `
  <h1>TinyMCE Angular demo</h1>
  <editor
    [init]="init"
    apiKey="your-api-key"
  />
  `
})
export class AppComponent {
  init: EditorComponent['init'] = {
    plugins: 'lists link image table code help wordcount'
  };
}
    3. Update the apiKey option in the editor element to include your Tiny Cloud API key.

For more information: Using TinyMCE with Angular - Cloud CDN

Self hosted via NPM package

Using TinyMCE from NPM in an Angular project requires a couple of extra steps. See the documentation for more information: Using TinyMCE with Angular - Self hosted via NPM

Demos

For our quick demos, check out the TinyMCE Angular Storybook.

Detailed documentation

Version compatibility

Angular version tinymce-angular version
>=16.x 8+
14+ 7.x
13+ 6.x
9+ 4.x
<= 8 3.x
< 5 Not supported

Note: The component works with both zone-based and zoneless applications.

Issues

Have you found an issue with tinymce-angular or do you have a feature request? Open up an issue and let us know or submit a pull request.

Note: for issues concerning TinyMCE please visit the TinyMCE repository.

License

tinymce-angular is licensed under the MIT License. See the LICENSE.txt file for details.

Depending on use case, the TinyMCE core editor can be used under either GPL-2.0-or-later or a commercial license. See the tinymce package for details.