Skip to content

quick-start.md

Latest commit

 

History

History
437 lines (367 loc) · 15.6 KB

quick-start.md

File metadata and controls

437 lines (367 loc) · 15.6 KB
Raw
menu-title Vanilla JS
meta-title Vanilla JS CKEditor 5 installation - quick start from CDN | CKEditor 5 Documentation
meta-description Install, integrate, and configure CKEditor 5 using Vanilla JS with CDN. Follow step-by-step instructions for fast installation and setup.
category cloud
order 20
modified_at 2026-02-13

Installing Vanilla JS CKEditor 5 from CDN

This guide shows the fastest way to add CKEditor 5 to your web application from the CDN.

{@snippet getting-started/use-builder}

Installing CKEditor 5 from CDN

To use our Cloud CDN services, [create a free account](https://portal.ckeditor.com/checkout?plan=free). Learn more about {@link getting-started/licensing/license-key-and-activation license key activation}.

CDN is an alternative method of running CKEditor 5. You can start using it in just a few steps and with a few tags.

Start by attaching a link to style sheets. They contain all styles for the editor's UI and content. You can also include your styles if you like. Refer to the {@link getting-started/setup/css#styling-the-published-content content styles} guide for more information.

<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.css" />
If you would not rather use the global variables presented below, you can continue from here and use an alternative, [more advanced setup with import maps](#advanced-setup-with-import-maps).

Then, you need to attach the script with the JavaScript code.

<script src="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.umd.js"></script>

Import the selected {@link getting-started/setup/editor-types editor type} and plugins. The included script exposes the global variable named CKEDITOR. You can use object destructuring, shown below, to access the editor class and plugins.

const {
	ClassicEditor,
	Essentials,
	Bold,
	Italic,
	Font,
	Paragraph
} = CKEDITOR;

ClassicEditor
	.create( {
		attachTo: document.querySelector( '#editor' ),
		licenseKey: '<YOUR_LICENSE_KEY>',
		plugins: [ Essentials, Bold, Italic, Font, Paragraph ],
		toolbar: [
			'undo', 'redo', '|', 'bold', 'italic', '|',
			'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor'
		],
		root: {
			placeholder: 'Type here...'
		}
	} )
	.then( /* ... */ )
	.catch( /* ... */ );

Lastly, add a tag for the editor to attach to. Ensure the query selector matches the HTML element ID (or class).

<div id="editor">
	<p>Hello from CKEditor 5!</p>
</div>

A simple HTML page with the CKEditor may look like the one below.

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="UTF-8" />
		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
		<title>CKEditor 5 - Quick start CDN</title>
		<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.css" />
	</head>
	<body>
		<div id="editor">
			<p>Hello from CKEditor 5!</p>
		</div>

		<script src="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.umd.js"></script>

		<script>
			const {
				ClassicEditor,
				Essentials,
				Bold,
				Italic,
				Font,
				Paragraph
			} = CKEDITOR;

			ClassicEditor
				.create( {
					attachTo: document.querySelector( '#editor' ),
					licenseKey: '<YOUR_LICENSE_KEY>',
					plugins: [ Essentials, Bold, Italic, Font, Paragraph ],
					toolbar: [
						'undo', 'redo', '|', 'bold', 'italic', '|',
						'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor'
					],
					root: {
						placeholder: 'Type here...'
					}
				} )
				.then( /* ... */ )
				.catch( /* ... */ );
		</script>
	</body>
</html>
The multi-root editor requires a {@link getting-started/setup/editor-types#multi-root-editor more advanced configuration} of the roots.

Installing premium features from CDN

Just like with open-source features, start by attaching a link to style sheets. They contain all styles for the editor's UI and content. The styles are in two separate style sheets – for open-source and premium plugins. You can also include your styles if you like. Refer to the {@link getting-started/setup/css#styling-the-published-content content styles} guide for more information.

<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.css" />

<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.css" />
If you do not want to use the global variables presented below, you can continue from here and use an alternative, [more advanced setup with import maps](#advanced-setup-with-import-maps).

Then, you need to attach the script tags with the JavaScript code. Similar to style sheets, there are separate scripts for open-source and premium plugins.

<script src="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.umd.js"></script>

<script src="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.umd.js"></script>

Both included scripts expose global variables named CKEDITOR and CKEDITOR_PREMIUM_FEATURES. You can use object destructuring, shown below, to access the editor class and plugins. Open-source and premium features are in the respective global variables.

<script>
	const {
		ClassicEditor,
		Essentials,
		Bold,
		Italic,
		Font,
		Paragraph
	} = CKEDITOR;
	const { FormatPainter } = CKEDITOR_PREMIUM_FEATURES;

	ClassicEditor
		.create( {
			attachTo: document.querySelector( '#editor' ),
			licenseKey: '<YOUR_LICENSE_KEY>',
			plugins: [ Essentials, Bold, Italic, Font, Paragraph, FormatPainter ],
			toolbar: [
				'undo', 'redo', '|', 'bold', 'italic', '|',
				'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor', '|',
				'formatPainter'
			]
		} )
		.then( /* ... */ )
		.catch( /* ... */ );
</script>

Lastly, add a tag for the editor to attach to. Ensure the query selector matches the HTML element ID (or class).

<div id="editor">
	<p>Hello from CKEditor 5!</p>
</div>

A simple HTML page with the CKEditor may look like the one below.

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="UTF-8" />
		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
		<title>CKEditor 5 - Quick start CDN</title>
		<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.css" />
		<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.css" />
	</head>
	<body>
		<div id="editor">
			<p>Hello from CKEditor 5!</p>
		</div>

		<script src="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.umd.js"></script>
		<script src="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.umd.js"></script>

		<script>
			const {
				ClassicEditor,
				Essentials,
				Bold,
				Italic,
				Font,
				Paragraph
			} = CKEDITOR;
			const { FormatPainter } = CKEDITOR_PREMIUM_FEATURES;

			ClassicEditor
				.create( {
					attachTo: document.querySelector( '#editor' ),
					licenseKey: '<YOUR_LICENSE_KEY>',
					plugins: [ Essentials, Bold, Italic, Font, Paragraph, FormatPainter ],
					toolbar: [
						'undo', 'redo', '|', 'bold', 'italic', '|',
						'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor', '|',
						'formatPainter'
					]
				} )
				.then( /* ... */ )
				.catch( /* ... */ );
		</script>
	</body>
</html>

Obtaining a premium features license key

To activate CKEditor 5 premium features, you will need a commercial license. The easiest way to get one is to sign up for the CKEditor Premium Features 14-day free trial.

You can also contact us to receive an offer tailored to your needs. To obtain an activation key, please follow the {@link getting-started/licensing/license-key-and-activation License key and activation} guide.

Advanced setup with import maps

To simplify imports, you can use the feature available in browsers – the import map. It allows us to map an easy-to-remember specifier (like ckeditor5 or ckeditor5-premium-features) to the full URL of the file from the CDN. We use this browser feature to share an editor engine code between plugins. Open source and premium plugins have their respective specifiers. Add mapping for premium features only if you use them.

<script type="importmap">
	{
		"imports": {
			"ckeditor5": "https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.js",
			"ckeditor5/": "https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/",
			"ckeditor5-premium-features": "https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.js",
			"ckeditor5-premium-features/": "https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/"
		}
	}
</script>

Once you have added the import map, you can access the editor and its plugins using the defined specifiers. Now, you can use standard ESM imports from the ckeditor5 and ckeditor5-premium-features packages, like import { ClassicEditor } from 'ckeditor5';. Please note that to use premium features, you need to activate them with a proper license key, as mentioned in the Obtaining a license key section.

You must run your code on a local server to use import maps. Opening the HTML file directly in your browser will trigger security rules. These rules (CORS policy) ensure loading modules from the same source. Therefore, set up a local server, like `nginx`, `caddy`, or `http-server`, to serve your files over HTTP or HTTPS.

In the following script tag, import the desired plugins and add them to the plugins array, and add toolbar items where applicable. Note that both script tags (this and the previous) have the appropriate type values.

<script type="module">
	import {
		ClassicEditor,
		Essentials,
		Bold,
		Italic,
		Font,
		Paragraph
	} from 'ckeditor5';
	import { FormatPainter } from 'ckeditor5-premium-features';

	ClassicEditor
		.create( {
			attachTo: document.querySelector( '#editor' ),
			licenseKey: '<YOUR_LICENSE_KEY>',
			plugins: [ Essentials, Bold, Italic, Font, Paragraph, FormatPainter ],
			toolbar: [
				'undo', 'redo', '|', 'bold', 'italic', '|',
				'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor', '|', 'formatPainter'
			]
		} )
		.then( /* ... */ )
		.catch( /* ... */ );
</script>

Your final page should look similar to the one below.

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="UTF-8" />
		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
		<title>CKEditor 5 - Quick start CDN</title>
		<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.css" />
		<link rel="stylesheet" href="https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.css" />
	</head>
	<body>
		<div id="editor">
			<p>Hello from CKEditor 5!</p>
		</div>

		<script type="importmap">
			{
				"imports": {
					"ckeditor5": "https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/ckeditor5.js",
					"ckeditor5/": "https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/",
					"ckeditor5-premium-features": "https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/ckeditor5-premium-features.js",
					"ckeditor5-premium-features/": "https://cdn.ckeditor.com/ckeditor5-premium-features/{@var ckeditor5-version}/"
				}
			}
		</script>

		<script type="module">
			import {
				ClassicEditor,
				Essentials,
				Bold,
				Italic,
				Font,
				Paragraph
			} from 'ckeditor5';
			import { FormatPainter } from 'ckeditor5-premium-features';

			ClassicEditor
				.create( {
					attachTo: document.querySelector( '#editor' ),
					licenseKey: '<YOUR_LICENSE_KEY>',
					plugins: [ Essentials, Bold, Italic, Font, Paragraph, FormatPainter ],
					toolbar: [
						'undo', 'redo', '|', 'bold', 'italic', '|',
						'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor', '|', 'formatPainter'
					]
				} )
				.then( /* ... */ )
				.catch( /* ... */ );
		</script>
	</body>
</html>

Additional setup for Vite

If you use UMD imports, you do not need to use any bundler. However, if your tooling enforces a Vite bundler or for some other reason you need one, follow the next steps.

Due to Vite limitations, using it with the cloud version of CKEditor 5 and ESM imports requires additional configuration. Vite does not fully support native import maps and external ESM modules (see Vite Issue #6582). Vite resolves imports at build time. Importing the editor using standard ESM syntax may force Vite to fall back to the UMD bundle, or it may cause errors.

To solve this issue, we can add a custom Vite plugin that externalizes CKEditor imports. This way, they can be resolved at runtime by the browser's import map instead of being processed by Vite's bundler. Below is the code of this plugin.

export function viteCKEditorExternalize() {
	return {
		name: 'ckeditor5-externalize',
		enforce: 'pre',
		config: ( config ) => {
			if ( config.optimizeDeps?.exclude && !Array.isArray( config.optimizeDeps.exclude ) ) {
				throw new Error( 'ckeditor5-externalize: config.optimizeDeps.exclude is not an array' );
			}

			if ( config.build?.rollupOptions?.external && !Array.isArray( config.build.rollupOptions.external ) ) {
				throw new Error( 'ckeditor5-externalize: config.build.rollupOptions.external is not an array' );
			}

			config.optimizeDeps ??= {};
			config.optimizeDeps.exclude = [
				...( ( config.optimizeDeps.exclude ?? [] ) ),
				'ckeditor5',
				'ckeditor5-premium-features'
			];

			config.build ??= {};
			config.build.rollupOptions ??= {};
			config.build.rollupOptions.external = [
				...( ( config.build.rollupOptions.external ?? [] ) ),
				'ckeditor5',
				'ckeditor5-premium-features',
				/^ckeditor5\/.*/,
				/^ckeditor5-premium-features\/.*/
			];
		},
		configResolved: ( resolvedConfig ) => {
			( resolvedConfig.plugins ).push( {
				name: 'remove-id-prefix',
				transform: ( code ) => {
					if ( typeof code === 'string' ) {
						return code.replace( /\/@id\/ckeditor5/g, 'ckeditor5' );
					}
					return null;
				}
			} );
		},
		resolveId: ( id ) => {
			if (
				id === 'ckeditor5' ||
				id === 'ckeditor5-premium-features' ||
				id.startsWith( 'ckeditor5/' ) ||
				id.startsWith( 'ckeditor5-premium-features/' )
			) {
				return {
					id,
					external: true
				};
			}
			return null;
		}
	};
}

You need to add the plugin to the plugins array in the Vite config to use it in your project.

// vite.config.js
import { viteCKEditorExternalize } from './plugins/vite-ckeditor-externalize.js';

export default {
	plugins: [ viteCKEditorExternalize() ]
};

The workaround should solve the issue and ensure a unified ESM development experience. Using this plugin, you can write clean ESM integration code regardless of the distribution channel.

Next steps

  • See how to manipulate the editor's data in the {@link getting-started/setup/getting-and-setting-data Getting and setting data} guide.
  • Refer to further guides in the {@link getting-started/setup/configuration setup section} to see how to customize your editor further.
  • Check the {@link features/index features category} to learn more about individual features.