Compatibility with .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.
# Using CKEditor 5 Builder
The easiest way to use CKEditor 5 in your .NET project is preparing an editor preset with CKEditor 5 Builder and including it into your project. Builder offers an easy-to-use user interface to help you configure, preview, and download the editor suited to your needs. You can easily select:
- the features you need,
- the preferred framework (React, Angular, Vue or Vanilla JS),
- the preferred distribution method.
You get ready-to-use code tailored to your needs!
# Setting up the project
For the purpose of this guide, we will use a basic ASP.NET Core project created with dotnet new webapp
. You can refer to the ASP.NET Core documentation to learn how to set up a project in the framework.
# Integrating from CDN
Once the project has been prepared, create an assets/vendor/ckeditor5.js
file in the existing wwwroot
directory in your app. Your folder structure should resemble this one:
├── bin
├── obj
├── Pages
├── Properties
├── wwwroot
│ ├── assets
| ├── vendor
| └── ckeditor.js
│ ├── css
│ ├── js
│ ├── lib
│ └── favicon.ico
├── appsettings.Development.json
├── appsettings.json
└── ...
Inside the file, paste the JavaScript code from CKEditor 5 Builder. The code will differ depending on your chosen preset and features. But it should look similar to this:
import {
ClassicEditor,
AccessibilityHelp,
Autosave,
Bold,
Essentials,
Italic,
Mention,
Paragraph,
SelectAll,
Undo
} from 'ckeditor5';
import { SlashCommand } from 'ckeditor5-premium-features';
const editorConfig = {
toolbar: {
items: ['undo', 'redo', '|', 'selectAll', '|', 'bold', 'italic', '|', 'accessibilityHelp'],
shouldNotGroupWhenFull: false
},
placeholder: 'Type or paste your content here!',
plugins: [AccessibilityHelp, Autosave, Bold, Essentials, Italic, Mention, Paragraph, SelectAll, SlashCommand, Undo],
licenseKey: '<YOUR_LICENSE_KEY>',
mention: {
feeds: [
{
marker: '@',
feed: [
/* See: https://ckeditor.com/docs/ckeditor5/latest/features/mentions.html */
]
}
]
},
initialData: "<h2>Congratulations on setting up CKEditor 5! 🎉</h2>"
};
ClassicEditor
.create( document.querySelector( '#editor' ), editorConfig )
.then( editor => {
console.log( editor );
} )
.catch( error => {
console.error( error );
} );
Then, modify the Index.cshtml
file in the Pages
directory to include the CKEditor 5 scripts. All necessary scripts and links are in the HTML snippet from CKEditor 5 Builder. You can copy and paste them into your template. It should look similar to the one below:
@page
@model IndexModel
@{
ViewData["Title"] = "Home page";
}
<div class="text-center">
<div id="editor"></div>
<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/42.0.0/ckeditor5.css" />
<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5-premium-features/42.0.0/ckeditor5-premium-features.css" />
<script type="importmap">
{
"imports": {
"ckeditor5": "https://cdn.ckeditor.com/ckeditor5/42.0.0/ckeditor5.js",
"ckeditor5/": "https://cdn.ckeditor.com/ckeditor5/42.0.0/",
"ckeditor5-premium-features": "https://cdn.ckeditor.com/ckeditor5-premium-features/42.0.0/ckeditor5-premium-features.js",
"ckeditor5-premium-features/": "https://cdn.ckeditor.com/ckeditor5-premium-features/42.0.0/"
}
}
</script>
<script type="module" src="assets/vendor/ckeditor.js"></script>
</div>
Finally, in the root directory of your .NET project, run dotnet watch run
to see the app in action.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.