From 6e8fa0baf163a99bf118279fdc9006cb51f20a3d Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Fri, 18 Sep 2026 14:07:19 +0930 Subject: [PATCH 1/7] TINYINT-3451: Update readme file --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 64 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 49ff7648..81fd309f 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,84 @@ ## About -This package is a thin wrapper around [TinyMCE](https://github.com/tinymce/tinymce) to make it easier to use in an Angular application. +Official Angular component for [TinyMCE](https://www.npmjs.com/package/tinymce) to make it easy to integrate into your Angular applications -* If you need detailed documentation on TinyMCE, see: [TinyMCE Documentation](https://www.tiny.cloud/docs/tinymce/8/). -* For the TinyMCE Angular Quick Start, see: [TinyMCE Documentation - Angular Integration](https://www.tiny.cloud/docs/tinymce/8/angular-cloud/). -* For the TinyMCE Angular Technical Reference, see: [TinyMCE Documentation - TinyMCE Angular Technical Reference](https://www.tiny.cloud/docs/tinymce/8/angular-ref/). -* For our quick demos, check out the TinyMCE Angular [Storybook](https://tinymce.github.io/tinymce-angular/). +## Quickstart -### Support +### Cloud CDN + +In your Angular project: + +1. [Sign up for a Tiny Cloud account](https://www.tiny.cloud/pricing/) to receive a Tiny Cloud API key. +2. `npm install @tinymce/tinymce-angular` +3. Include the following code: + +```js +import { Component } from '@angular/core'; +import { EditorComponent } from '@tinymce/tinymce-angular'; + +@Component({ + selector: 'app-root', + imports: [EditorComponent], + template: ` +

TinyMCE Angular demo

+ + ` +}) +export class AppComponent { + init: EditorComponent['init'] = { + plugins: 'lists link image table code help wordcount' + }; +} +``` + +4. Update the `apiKey` option in the editor element to include your Tiny Cloud API key. + +For more information: [Using TinyMCE with Angular - Cloud CDN](https://www.tiny.cloud/docs/tinymce/latest/angular-cloud/) + +### 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](https://www.tiny.cloud/docs/tinymce/latest/angular-pm/) + +## Detailed documentation + +* [TinyMCE Angular Technical Reference](https://www.tiny.cloud/docs/tinymce/latest/angular-ref/). +* [TinyMCE Documentation](https://www.tiny.cloud/docs/tinymce/latest/). + +## Demos + +For our quick demos, check out the TinyMCE Angular [Storybook](https://tinymce.github.io/tinymce-angular/). + +## Version compatibility |Angular version|`tinymce-angular` version| |--- |--- | -|>=16.x <=21.x |8+ | +|>=16.x |8+ | |14+ |7.x | |13+ |6.x | |9+ |4.x | |<= 8 |3.x | |< 5 | Not supported | -### Zoneless Support -This wrapper supports Angular's zoneless change detection. No additional configuration is needed — the component works with both zone-based and zoneless applications. -### Issues +## Zoneless Support + +No additional configuration is needed — 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? +Have you found an issue with `tinymce-angular` or do you have a feature request? Open up an [issue](https://github.com/tinymce/tinymce-angular/issues) and let us know or submit a [pull request](https://github.com/tinymce/tinymce-angular/pulls). _Note: for issues concerning TinyMCE please visit the [TinyMCE repository](https://github.com/tinymce/tinymce)._ + + +## 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](https://www.npmjs.com/package/tinymce) for details. From 5eccccd095c52c89c174ac26d119e5eb959c0281 Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Mon, 21 Sep 2026 09:02:43 +0930 Subject: [PATCH 2/7] Update keywords and description --- package.json | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index f4eefe3e..b69ee6ed 100644 --- a/package.json +++ b/package.json @@ -2,9 +2,25 @@ "name": "@tinymce/tinymce-angular", "version": "9.1.2-rc", "private": true, - "description": "Official TinyMCE Angular Component", + "description": "Official Angular Component for TinyMCE - A rich text editor", "license": "MIT", "author": "Ephox Corporation DBA Tiny Technologies, Inc.", + "keywords": [ + "tinymce", + "angular", + "zoneless", + "angular2", + "ng", + "ngx", + "component", + "wysiwyg", + "rich text", + "javascript", + "html", + "contenteditable", + "editor", + "tiny" + ], "scripts": { "build": "yarn run clean && ng-packagr -p tinymce-angular-component/ng-package.json && json -I -f dist/tinymce-angular/package.json -e 'this.version=process.env.npm_package_version' && copyfiles README.md dist/tinymce-angular/", "build-storybook": "ng run angular:build-storybook", From 2ab6b1ebdbe5ab09898ab1cb105f5f00e3fa095a Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Mon, 21 Sep 2026 10:04:52 +0930 Subject: [PATCH 3/7] Update contributing.md --- CONTRIBUTING.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b561e52d..a9a21486 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,5 @@ # Contributing -This project follows the [beehive-flow](https://github.com/tinymce/beehive-flow/) branching process ("Basic process - release from main branch"). -Please read the [beehive-flow readme](https://github.com/tinymce/beehive-flow/blob/main/README.md) for more information. -This mainly affects branching and merging for Tiny staff. - External contributors are free to submit PRs against the `main` branch. -Note that contributions will require signing of our Contributor License Agreement. + +In order for Tiny to accept your contribution, we will need legal permission from you to use your code. Please email `legal@tiny.cloud` with the subject `CLA request for [your Github username]`. Our legal team will send you a Contributors License Agreement (CLA) which you will need to sign and return. From 7d62d2e434665d5f40f4a89f695053a467d3abbe Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Mon, 21 Sep 2026 10:47:32 +0930 Subject: [PATCH 4/7] Change package description --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b69ee6ed..23107b81 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@tinymce/tinymce-angular", "version": "9.1.2-rc", "private": true, - "description": "Official Angular Component for TinyMCE - A rich text editor", + "description": "Official Angular Component for TinyMCE, a rich text editor", "license": "MIT", "author": "Ephox Corporation DBA Tiny Technologies, Inc.", "keywords": [ From 9b0e3883aa9be30ff23aba1843cd47d4ec768ff2 Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Mon, 21 Sep 2026 11:11:55 +0930 Subject: [PATCH 5/7] Improve readme --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 81fd309f..4be57eb7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## About -Official Angular component for [TinyMCE](https://www.npmjs.com/package/tinymce) to make it easy to integrate into your Angular applications + Official Angular component for TinyMCE, the rich text editor. It makes it easy to integrate TinyMCE into your Angular applications, with full support for both zone-based and zoneless change detection. ## Quickstart @@ -44,15 +44,16 @@ For more information: [Using TinyMCE with Angular - Cloud CDN](https://www.tiny. 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](https://www.tiny.cloud/docs/tinymce/latest/angular-pm/) -## Detailed documentation - -* [TinyMCE Angular Technical Reference](https://www.tiny.cloud/docs/tinymce/latest/angular-ref/). -* [TinyMCE Documentation](https://www.tiny.cloud/docs/tinymce/latest/). ## Demos For our quick demos, check out the TinyMCE Angular [Storybook](https://tinymce.github.io/tinymce-angular/). +## Detailed documentation + +* [TinyMCE Angular Technical Reference](https://www.tiny.cloud/docs/tinymce/latest/angular-ref/). +* [TinyMCE Documentation](https://www.tiny.cloud/docs/tinymce/latest/). + ## Version compatibility |Angular version|`tinymce-angular` version| @@ -64,10 +65,7 @@ For our quick demos, check out the TinyMCE Angular [Storybook](https://tinymce.g |<= 8 |3.x | |< 5 | Not supported | - -## Zoneless Support - -No additional configuration is needed — the component works with both zone-based and zoneless applications. +**Note**: The component works with both zone-based and zoneless applications. ## Issues From 029f9b9a11348b0a5f67a7f943eea29c7d9aa385 Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Mon, 21 Sep 2026 13:27:32 +0930 Subject: [PATCH 6/7] Update package description --- README.md | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4be57eb7..53d839d1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## About - Official Angular component for TinyMCE, the rich text editor. It makes it easy to integrate TinyMCE into your Angular applications, with full support for both zone-based and zoneless change detection. +Official React component for TinyMCE, the rich text editor. It makes integrating TinyMCE into Angular applications easy and seamless. ## Quickstart diff --git a/package.json b/package.json index 23107b81..465da617 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@tinymce/tinymce-angular", "version": "9.1.2-rc", "private": true, - "description": "Official Angular Component for TinyMCE, a rich text editor", + "description": "Official Angular component for TinyMCE, a rich text editor.", "license": "MIT", "author": "Ephox Corporation DBA Tiny Technologies, Inc.", "keywords": [ From 8ca791bd7d708e79bf242e8395a8dfdfa3017c53 Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Mon, 21 Sep 2026 13:31:52 +0930 Subject: [PATCH 7/7] Update keywords --- package.json | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 465da617..cfeb147e 100644 --- a/package.json +++ b/package.json @@ -14,12 +14,10 @@ "ngx", "component", "wysiwyg", - "rich text", - "javascript", + "rich-text-editor", "html", "contenteditable", - "editor", - "tiny" + "editor" ], "scripts": { "build": "yarn run clean && ng-packagr -p tinymce-angular-component/ng-package.json && json -I -f dist/tinymce-angular/package.json -e 'this.version=process.env.npm_package_version' && copyfiles README.md dist/tinymce-angular/",