Skip to content

Documentation in Angular guide about peer dependencies #14549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pomek merged 3 commits into from
Jul 10, 2023
Merged

Documentation in Angular guide about peer dependencies #14549

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
177b4d3
Docs for Angular guide that requires peer dependencies.
psmyrek Jul 10, 2023
706348a
Added note with versions requirement.
psmyrek Jul 10, 2023
4f6ced7
Make package names clickable.
pomek Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/installation/integrations/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,21 @@ This tutorial assumes that you picked [`@ckeditor/ckeditor5-build-classic`](http
npm install --save @ckeditor/ckeditor5-build-classic
```

The [`@ckeditor/ckeditor5-angular`](https://www.npmjs.com/package/@ckeditor/ckeditor5-angular) package requires the following peer dependencies, with a version of at least 37.0.0:

* [`@ckeditor/ckeditor5-core`](https://www.npmjs.com/package/@ckeditor/ckeditor5-core),
* [`@ckeditor/ckeditor5-engine`](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine),
* [`@ckeditor/ckeditor5-utils`](https://www.npmjs.com/package/@ckeditor/ckeditor5-utils),
* [`@ckeditor/ckeditor5-watchdog`](https://www.npmjs.com/package/@ckeditor/ckeditor5-watchdog).

Keep in mind that they {@link installation/plugins/installing-plugins#requirements must have the same version as the editor build}.

Install all the required peer dependencies:

```bash
npm install --save @ckeditor/ckeditor5-core @ckeditor/ckeditor5-engine @ckeditor/ckeditor5-utils @ckeditor/ckeditor5-watchdog
```

Now, add `CKEditorModule` to modules whose components will be using the `<ckeditor>` component in their templates.

```ts
Expand Down