{"id":13473127,"url":"https://github.com/ckeditor/ckeditor5-angular","last_synced_at":"2025-10-20T08:21:06.263Z","repository":{"id":33152988,"uuid":"133376841","full_name":"ckeditor/ckeditor5-angular","owner":"ckeditor","description":"Official CKEditor 5 Angular 5+ component.","archived":false,"fork":false,"pushed_at":"2025-03-18T07:44:21.000Z","size":5833,"stargazers_count":211,"open_issues_count":46,"forks_count":114,"subscribers_count":24,"default_branch":"master","last_synced_at":"2025-04-18T00:37:59.778Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://ckeditor.com/ckeditor-5","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ckeditor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-14T14:48:44.000Z","updated_at":"2025-03-31T10:44:28.000Z","dependencies_parsed_at":"2024-04-16T23:41:50.516Z","dependency_job_id":"64bc04a8-ec17-4396-844e-e98e94b10c2e","html_url":"https://github.com/ckeditor/ckeditor5-angular","commit_stats":{"total_commits":357,"total_committers":20,"mean_commits":17.85,"dds":0.4229691876750701,"last_synced_commit":"2b3c88bf974a0c263a3a6b33123a2635dd2256b5"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor5-angular","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor5-angular/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor5-angular/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ckeditor%2Fckeditor5-angular/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ckeditor","download_url":"https://codeload.github.com/ckeditor/ckeditor5-angular/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251238328,"owners_count":21557441,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T16:01:01.041Z","updated_at":"2025-10-20T08:21:06.243Z","avatar_url":"https://github.com/ckeditor.png","language":"TypeScript","readme":"# CKEditor 5 rich text editor component for Angular\n\n[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-angular.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-angular)\n[![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5-angular.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5-angular?branch=master)\n[![Coverage Status](https://codecov.io/github/ckeditor/ckeditor5-angular/graph/badge.svg)](https://codecov.io/github/ckeditor/ckeditor5-angular)\n![Dependency Status](https://img.shields.io/librariesio/release/npm/@ckeditor/ckeditor5-angular)\n\nOfficial [CKEditor 5](https://ckeditor.com/ckeditor-5/) rich text editor component for Angular 13+.\n\n## [Developer Documentation](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/angular.html) 📖\n\nSee the [\"Rich text editor component for Angular\"](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/angular.html) guide in the [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest) to learn more:\n\n* [Quick start](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/angular.html#quick-start)\n* [Integration with `ngModel`](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/angular.html#integration-with-ngmodel)\n* [Supported `@Input` properties](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/angular.html#supported-input-properties)\n* [Supported `@Output` properties](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/angular.html#supported-output-properties)\n* [Styling](https://ckeditor.com/docs/ckeditor5/latest/getting-started/installation/angular.html#styling)\n* [Localization](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/angular.html#localization)\n\n## Supported Angular versions\n\nBecause of the breaking changes in the Angular library output format, the `@ckeditor/ckeditor5-angular` package is released in the following versions to support various Angular ecosystems:\n\n\u003ctable\u003e\n  \u003cthead\u003e\n    \u003ctr\u003e\n      \u003cth\u003ePackage\u0026nbsp;version\u003c/th\u003e\n      \u003cth\u003eAngular\u0026nbsp;version\u003c/th\u003e\n      \u003cth\u003eDetails\u003c/th\u003e\n    \u003c/tr\u003e\n  \u003c/thead\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd colspan=\"3\"\u003eActively supported versions\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^10\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e16+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eRequires CKEditor\u0026nbsp;5 in version \u003ca href=\"https://github.com/ckeditor/ckeditor5/releases/tag/v46.0.0\"\u003e46\u003c/a\u003e or higher.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd colspan=\"3\"\u003ePast releases (no longer maintained)\u003c/td\u003e\n    \u003c/tr\u003e\n\t\u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^9\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e16+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eMigration to TypeScript\u0026nbsp;5. Declaration files are not backward compatible. Requires CKEditor\u0026nbsp;5 in version \u003ca href=\"https://github.com/ckeditor/ckeditor5/releases/tag/v43.0.0\"\u003e43\u003c/a\u003e or higher.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^8\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e13+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eRequires CKEditor\u0026nbsp;5 at least in version \u003ca href=\"https://github.com/ckeditor/ckeditor5/releases/tag/v42.0.0\"\u003e42\u003c/a\u003e.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^7\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e13+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eChanges in peer dependencies. (\u003ca href=\"https://github.com/ckeditor/ckeditor5-angular/issues/376\"\u003eissue\u003c/a\u003e)\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^6\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e13+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eRequires CKEditor\u0026nbsp;5 at least in version \u003ca href=\"https://github.com/ckeditor/ckeditor5/releases/tag/v37.0.0\"\u003e37\u003c/a\u003e.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^5\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e13+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eRequires Angular at least in version 13+. Lower versions are no longer maintained.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^4\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e9.1+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eRequires CKEditor\u0026nbsp;5 at least in version \u003ca href=\"https://github.com/ckeditor/ckeditor5/releases/tag/v34.0.0\"\u003e34\u003c/a\u003e.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^3\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e9.1+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eRequires Node.js at least in version 14.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^2\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e9.1+\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eMigration to TypeScript\u0026nbsp;4. Declaration files are not backward compatible.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003e^1\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e\u003ccode\u003e5.x\u0026nbsp;-\u0026nbsp;8.x\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eAngular versions are no longer maintained.\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\nNote that the `package.json` file used in the main repository isn't published on npm (the production one is present in [`src/ckeditor/package.json`](https://github.com/ckeditor/ckeditor5-angular/blob/master/src/ckeditor/package.json)).\n\n## Contributing\n\n\u003e [!NOTE]\n\u003e This project requires **pnpm v10** or higher. You can check your version with `pnpm --version` and update if needed with `npm install -g pnpm@latest`.\n\nAfter cloning this repository, install necessary dependencies:\n\n```bash\npnpm install\n```\n\n### The structure of the repository\n\nThis repository contains the following code:\n\n* `./src/ckeditor` contains the implementation of the `\u003cckeditor\u003e` component,\n* `./src/app` is a demo application using the component.\n\n**Note:** The [npm package](https://www.npmjs.com/package/@ckeditor/ckeditor5-angular) contains a [packaged component](#packaging-the-component) only.\n\n### Testing the component (demo)\n\nTo open the demo application using the component, run:\n\n```bash\npnpm run start\n```\n\nTo test it in production, use:\n\n```bash\npnpm run start --configuration production\n```\n\nTo run unit tests, use:\n\n```bash\npnpm run test\n```\n\nTo run e2e tests, run:\n\n```bash\n# Prepare the server.\npnpm run start\n# Then, start tests.\npnpm run test:e2e\n```\n\nTo run coverage tests, run:\n\n```bash\npnpm run coverage\n```\n\nPlay with the application and make sure the component works properly.\n\n## Releasing package\n\nCircleCI automates the release process and can release both channels: stable (`X.Y.Z`) and pre-releases (`X.Y.Z-alpha.X`, etc.).\n\nBefore you start, you need to prepare the changelog entries.\n\n1. Make sure the `#master` branch is up-to-date: `git fetch \u0026\u0026 git checkout master \u0026\u0026 git pull`.\n1. Prepare a release branch: `git checkout -b release-[YYYYMMDD]` where `YYYYMMDD` is the current day.\n1. Generate the changelog entries: `pnpm run release:prepare-changelog`.\n\t* You can specify the release date by passing the `--date` option, e.g., `--date=2025-06-11`.\n\t* By passing the `--dry-run` option, you can check what the script will do without actually modifying the files.\n\t* Read all the entries, correct poor wording and other issues, wrap code names in backticks to format them, etc.\n\t* Add the missing `the/a` articles, `()` to method names, \"it's\" -\u003e \"its\", etc.\n\t* A newly introduced feature should have just one changelog entry – something like \"The initial implementation of the FOO feature.\" with a description of what it does.\n1. Commit all changes and prepare a new pull request targeting the `#master` branch.\n1. Ping the `@ckeditor/ckeditor-5-platform` team to review the pull request and trigger the release process.\n\n## License\n\nLicensed under a dual-license model, this software is available under:\n\n* the [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html),\n* or commercial license terms from CKSource Holding sp. z o.o.\n\nFor more information, see: [https://ckeditor.com/legal/ckeditor-licensing-options](https://ckeditor.com/legal/ckeditor-licensing-options).\n","funding_links":[],"categories":["基于 Angular","Awesome Angular [![Awesome TipeIO](https://img.shields.io/badge/Awesome%20Angular-@TipeIO-6C6AE7.svg)](https://github.com/gdi2290/awesome-angular) [![Awesome devarchy.com](https://img.shields.io/badge/Awesome%20Angular-@devarchy.com-86BDC1.svg)](https://github.com/brillout/awesome-angular-components)","Framework Interoperability","Integrations","For Angular"],"sub_categories":["Angular \u003ca id=\"angular\"\u003e\u003c/a\u003e","Wrappers"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckeditor%2Fckeditor5-angular","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fckeditor%2Fckeditor5-angular","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fckeditor%2Fckeditor5-angular/lists"}