Docs: integrations cleanup. #16217
Docs: integrations cleanup. #16217
Conversation
|
Ustawiam blokery, żeby uniknąć nadpisania zmian po tej stronie. |
| @@ -9,52 +9,27 @@ menu-title: .NET | |||
|
|
|||
| As a pure JavaScript/TypeScript application, CKEditor 5 will work inside any environment that supports such components. While we do not offer official integrations for any non-JavaScript frameworks, you can include a custom build of CKEditor 5 in a non-JS framework of your choice, for example, Microsoft's [.NET](https://dotnet.microsoft.com/). | |||
|
|
|||
| To integrate CKEditor 5 with .NET, we will create a custom CKEditor 5 build using the [online builder](https://ckeditor.com/ckeditor-5/online-builder/), and then import it into the .NET project. | |||
| ## Using the Builder | |||
There was a problem hiding this comment.
Using CKEditor 5 Builder or Using Builder. This needs to change everywhere.
There was a problem hiding this comment.
We have 26 results for Builder, but only 8 out of these are CKEditor 5 Builder.
There was a problem hiding this comment.
I can unify the occurrences to "CKEditor 5 Builder." For me, it sounds better than bare-bones "Builder."
There was a problem hiding this comment.
It's ok to use Builder in the context of CKE5, but then don't use the.
There was a problem hiding this comment.
Can we, however, make it on epic, to no longer postpone this branch?
|
|
||
| ```bash | ||
| npm install --save @ckeditor/ckeditor5-core @ckeditor/ckeditor5-engine @ckeditor/ckeditor5-utils @ckeditor/ckeditor5-watchdog | ||
| npm install @ckeditor/ckeditor5-core @ckeditor/ckeditor5-engine @ckeditor/ckeditor5-utils @ckeditor/ckeditor5-watchdog |
There was a problem hiding this comment.
Do we need to keep it? This is not needed with ckeditor5.
There was a problem hiding this comment.
Without those dependencies, I got typescript errors that "those types are not assignable to others." But I was testing earlier alpha. Let me check for the new version.
There was a problem hiding this comment.
Nope, for the newest nightly version, the errors still occurs. They occur in the template, and it is a type mismatch:
Type 'typeof ClassicEditor' is not assignable to type '{ create(sourceElementOrData: string | HTMLElement, config?: EditorConfig | undefined): Promise<Editor>; }'
Type '{ toolbar: string[]; plugins: (typeof Bold | typeof Essentials | typeof Italic | typeof Paragraph | typeof Undo)[]; }' is not assignable to type 'EditorConfig'.
Those dependencies are for the @ckeditor/ckeditor5-angular package. So, if we want to remove them, the integration itself would need to change, probably.
There was a problem hiding this comment.
Yep, we will change the integration, I would act as this would not be needed and let's remove this right now. We will review this as we have new versions of integrations.
| import { Component } from '@angular/core'; | ||
| import Editor from 'ckeditor5-custom-build/build/ckeditor'; | ||
| import 'ckeditor5/index.css'; | ||
| import 'ckeditor5-premium-features/index.css'; |
There was a problem hiding this comment.
Just a cautionary comment, as I'm a bit lost, should dist be here or not?
There was a problem hiding this comment.
Isn't dist only in HTML calls? Not in JS calls?
There was a problem hiding this comment.
AFAIK we needed the dist prefix in some earlier alpha versions. But, there was a change to the paths. We don't need it for npm, but it's required for the CDN, though.
| ├── app | ||
| ├── bootstrap | ||
| ├── config | ||
| ├── database | ||
| ├── public | ||
| │ ├── assets | ||
| | ├── vendor | ||
| | └── ckeditor5 | ||
| | └── ckeditor.js |
There was a problem hiding this comment.
This whole block is not needed. File will be downloaded via CDN script (as below).
There was a problem hiding this comment.
In the current form of this guide - it is needed. I recommended putting there the code from the Builder (JS snippet). Scripts from the snippet below will download the editor and styles, but we also need to create the editor in our project.
I could put everything in one HTML file. I tested it, and it works. But it looked cluttered to me.
There was a problem hiding this comment.
Gotcha, sorry missed that! You're right!
Suggested merge commit message (convention)
Docs: integrations cleanup.
Additional information
Follow this document.