Update imports paths in documentation snippets.

ckeditor · Mar 5, 2025 · f9b0f2f · f9b0f2f
1 parent a97beec
commit f9b0f2f
Show file tree

Hide file tree

Showing 309 changed files with 3,006 additions and 2,592 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -70,6 +70,9 @@ module.exports = {
 		},
 		{
 			files: [ '**/docs/**/*.js' ],
+			env: {
+				browser: true
+			},
 			rules: {
 				'ckeditor5-rules/ckeditor-imports': 'off'
 			}

diff --git a/docs/_snippets/build-balloon-block-source.html b/docs/_snippets/build-balloon-block-source.html
diff --git a/docs/_snippets/build-balloon-block-source.js b/docs/_snippets/build-balloon-block-source.js
diff --git a/docs/_snippets/build-balloon-block.js b/docs/_snippets/build-balloon-block.js
@@ -34,7 +34,7 @@ import {
 	CloudServices
 } from 'ckeditor5';
 
-export default class BalloonBlockEditor extends BalloonEditorBase {
+export class BalloonBlockEditor extends BalloonEditorBase {
 	static builtinPlugins = [
 		Essentials,
 		CKFinderUploadAdapter,

diff --git a/docs/_snippets/build-balloon-source.html b/docs/_snippets/build-balloon-source.html
diff --git a/docs/_snippets/build-balloon-source.js b/docs/_snippets/build-balloon-source.js
diff --git a/docs/_snippets/build-balloon.js b/docs/_snippets/build-balloon.js
@@ -33,7 +33,7 @@ import {
 	CloudServices
 } from 'ckeditor5';
 
-export default class BalloonEditor extends BalloonEditorBase {
+export class BalloonEditor extends BalloonEditorBase {
 	static builtinPlugins = [
 		Essentials,
 		Paragraph,

diff --git a/docs/_snippets/build-classic-source.html b/docs/_snippets/build-classic-source.html
diff --git a/docs/_snippets/build-classic-source.js b/docs/_snippets/build-classic-source.js
diff --git a/docs/_snippets/build-classic.js b/docs/_snippets/build-classic.js
@@ -28,10 +28,13 @@ import {
 	Table,
 	TableToolbar,
 	TextTransformation,
-	CloudServices
+	CloudServices,
+	AutoImage,
+	ImageInsert,
+	Bookmark
 } from 'ckeditor5';
 
-export default class ClassicEditor extends ClassicEditorBase {
+export class ClassicEditor extends ClassicEditorBase {
 	static builtinPlugins = [
 		Essentials,
 		Autoformat,
@@ -56,7 +59,10 @@ export default class ClassicEditor extends ClassicEditorBase {
 		PictureEditing,
 		Table,
 		TableToolbar,
-		TextTransformation
+		TextTransformation,
+		AutoImage,
+		ImageInsert,
+		Bookmark
 	];
 
 	static defaultConfig = {
@@ -86,7 +92,6 @@ export default class ClassicEditor extends ClassicEditorBase {
 				'mergeTableCells'
 			]
 		},
-		// This value must be kept in sync with the language defined in webpack.config.js.
 		language: 'en'
 	};
 }
diff --git a/docs/_snippets/build-decoupled-document.js b/docs/_snippets/build-decoupled-document.js
@@ -3,13 +3,6 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 
-/*
- * This is a JavaScript version of CKEditor 5 Decoupled Document build.
- * It is used for all snippets used in the documentation to avoid importing a build source from the `src/` directory.
- * See: https://github.com/ckeditor/ckeditor5/issues/13552 to learn why it is a problem.
- */
-
-// The editor creator to use.
 import {
 	DecoupledEditor as DecoupledEditorBase,
 	Essentials,
@@ -48,7 +41,7 @@ import {
 	CloudServices
 } from 'ckeditor5';
 
-export default class DecoupledEditor extends DecoupledEditorBase {
+export class DecoupledEditor extends DecoupledEditorBase {
 	static builtinPlugins = [
 		Essentials,
 		Alignment,
@@ -123,7 +116,6 @@ export default class DecoupledEditor extends DecoupledEditorBase {
 				reversed: true
 			}
 		},
-		// This value must be kept in sync with the language defined in webpack.config.js.
 		language: 'en'
 	};
 }
diff --git a/docs/_snippets/build-inline-source.html b/docs/_snippets/build-inline-source.html
diff --git a/docs/_snippets/build-inline-source.js b/docs/_snippets/build-inline-source.js
diff --git a/docs/_snippets/build-inline.js b/docs/_snippets/build-inline.js
@@ -4,13 +4,36 @@
  */
 
 import {
-	InlineEditor as InlineEditorBase, Essentials, CKFinderUploadAdapter, Autoformat, Bold,
-	Italic, BlockQuote, CKBox, CKFinder, EasyImage, Heading, Image, ImageCaption, ImageStyle,
-	ImageToolbar, ImageUpload, PictureEditing, Indent, Link, List, MediaEmbed, Paragraph,
-	PasteFromOffice, Table, TableToolbar, TextTransformation, CloudServices
+	InlineEditor as InlineEditorBase,
+	Essentials,
+	CKFinderUploadAdapter,
+	Autoformat,
+	Bold,
+	Italic,
+	BlockQuote,
+	CKBox,
+	CKFinder,
+	EasyImage,
+	Heading,
+	Image,
+	ImageCaption,
+	ImageStyle,
+	ImageToolbar,
+	ImageUpload,
+	PictureEditing,
+	Indent,
+	Link,
+	List,
+	MediaEmbed,
+	Paragraph,
+	PasteFromOffice,
+	Table,
+	TableToolbar,
+	TextTransformation,
+	CloudServices
 } from 'ckeditor5';
 
-export default class InlineEditor extends InlineEditorBase {
+export class InlineEditor extends InlineEditorBase {
 	static builtinPlugins = [
 		Essentials,
 		CKFinderUploadAdapter,

diff --git a/docs/_snippets/build-multi-root-source.html b/docs/_snippets/build-multi-root-source.html
diff --git a/docs/_snippets/build-multi-root-source.js b/docs/_snippets/build-multi-root-source.js
diff --git a/docs/_snippets/build-multi-root.js b/docs/_snippets/build-multi-root.js
@@ -4,13 +4,36 @@
  */
 
 import {
-	MultiRootEditor as MultiRootEditorBase, Essentials, CKFinderUploadAdapter, Autoformat,
-	Bold, Italic, BlockQuote, CKBox, CKFinder, EasyImage, Heading, Image, ImageCaption,
-	ImageStyle, ImageToolbar, ImageUpload, PictureEditing, Indent, Link, List, MediaEmbed,
-	Paragraph, PasteFromOffice, Table, TableToolbar, TextTransformation, CloudServices
+	MultiRootEditor as MultiRootEditorBase,
+	Essentials,
+	CKFinderUploadAdapter,
+	Autoformat,
+	Bold,
+	Italic,
+	BlockQuote,
+	CKBox,
+	CKFinder,
+	EasyImage,
+	Heading,
+	Image,
+	ImageCaption,
+	ImageStyle,
+	ImageToolbar,
+	ImageUpload,
+	PictureEditing,
+	Indent,
+	Link,
+	List,
+	MediaEmbed,
+	Paragraph,
+	PasteFromOffice,
+	Table,
+	TableToolbar,
+	TextTransformation,
+	CloudServices
 } from 'ckeditor5';
 
-export default class MultiRootEditor extends MultiRootEditorBase {
+export class MultiRootEditor extends MultiRootEditorBase {
 	static builtinPlugins = [
 		Essentials,
 		CKFinderUploadAdapter,

diff --git a/docs/_snippets/examples/balloon-block-editor.js b/docs/_snippets/examples/balloon-block-editor.js
@@ -3,16 +3,18 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 
-/* globals BalloonBlockEditor, console, window, document */
-
-import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
+import {
+	CS_CONFIG,
+	BalloonBlockEditor,
+	getViewportTopOffsetConfig
+} from '@snippets/index.js';
 
 BalloonBlockEditor
 	.create( document.querySelector( '#snippet-balloon-block-editor' ), {
 		cloudServices: CS_CONFIG,
 		ui: {
 			viewportOffset: {
-				top: window.getViewportTopOffsetConfig()
+				top: getViewportTopOffsetConfig()
 			}
 		}
 	} )

diff --git a/docs/_snippets/examples/balloon-editor.js b/docs/_snippets/examples/balloon-editor.js
@@ -3,16 +3,18 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 
-/* globals BalloonEditor, console, window, document */
-
-import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
+import {
+	CS_CONFIG,
+	BalloonEditor,
+	getViewportTopOffsetConfig
+} from '@snippets/index.js';
 
 BalloonEditor
 	.create( document.querySelector( '#snippet-balloon-editor' ), {
 		cloudServices: CS_CONFIG,
 		ui: {
 			viewportOffset: {
-				top: window.getViewportTopOffsetConfig()
+				top: getViewportTopOffsetConfig()
 			}
 		}
 	} )

diff --git a/docs/_snippets/examples/bottom-toolbar-editor.js b/docs/_snippets/examples/bottom-toolbar-editor.js
@@ -3,18 +3,19 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 
-/* globals console, window, document */
-
 import {
 	Plugin, IconFontColor, Font, Indent, List, Alignment, Autoformat, BlockQuote, DropdownView,
 	ToolbarView, createDropdown, EasyImage, Essentials, Heading, HorizontalLine, Image,
 	ImageInsert, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, ImageResize, Link,
 	MediaEmbed, Paragraph, RemoveFormat, Bold, Italic, Strikethrough, Superscript, Subscript,
 	Underline, Table, TableToolbar
 } from 'ckeditor5';
-import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
-
-import DecoupledEditor from '../build-decoupled-document.js';
+import {
+	CS_CONFIG,
+	DecoupledEditor,
+	attachTourBalloon,
+	findToolbarItem
+} from '@snippets/index.js';
 
 class FormattingOptions extends Plugin {
 	/**
@@ -203,9 +204,11 @@ DecoupledEditor
 		overrideTooltipPositions( editor.ui.view.toolbar );
 		overrideTooltipPositions( editor.plugins.get( 'FormattingOptions' ).toolbarView );
 
-		window.attachTourBalloon( {
-			target: window.findToolbarItem( editor.ui.view.toolbar,
-				item => item.label && item.label === 'Formatting options' ),
+		attachTourBalloon( {
+			target: findToolbarItem(
+				editor.ui.view.toolbar,
+				item => item.label && item.label === 'Formatting options'
+			),
 			text: 'Click to open formatting options.',
 			editor,
 			tippyOptions: {

diff --git a/docs/_snippets/examples/classic-editor-short.js b/docs/_snippets/examples/classic-editor-short.js
@@ -3,16 +3,14 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 
-/* globals ClassicEditor, console, window, document */
-
-import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
+import { CS_CONFIG, ClassicEditor, getViewportTopOffsetConfig } from '@snippets/index.js';
 
 ClassicEditor
 	.create( document.querySelector( '#snippet-classic-editor-short' ), {
 		cloudServices: CS_CONFIG,
 		ui: {
 			viewportOffset: {
-				top: window.getViewportTopOffsetConfig()
+				top: getViewportTopOffsetConfig()
 			}
 		}
 	} )

diff --git a/docs/_snippets/examples/classic-editor.js b/docs/_snippets/examples/classic-editor.js
@@ -3,9 +3,11 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 
-/* globals ClassicEditor, console, window, document */
-
-import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
+import {
+	CS_CONFIG,
+	ClassicEditor,
+	getViewportTopOffsetConfig
+} from '@snippets/index.js';
 
 ClassicEditor
 	.create( document.querySelector( '#snippet-classic-editor' ), {
@@ -21,7 +23,7 @@ ClassicEditor
 		},
 		ui: {
 			viewportOffset: {
-				top: window.getViewportTopOffsetConfig()
+				top: getViewportTopOffsetConfig()
 			}
 		}
 	} )

diff --git a/docs/_snippets/examples/document-editor.js b/docs/_snippets/examples/document-editor.js
@@ -3,12 +3,12 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 
-/* globals console, window, document */
-
 import { TableColumnResize } from 'ckeditor5';
-import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
-
-import DecoupledEditor from '../build-decoupled-document.js';
+import {
+	CS_CONFIG,
+	DecoupledEditor,
+	getViewportTopOffsetConfig
+} from '@snippets/index.js';
 
 DecoupledEditor
 	.create( document.querySelector( '.document-editor__editable' ), {
@@ -27,7 +27,7 @@ DecoupledEditor
 		},
 		ui: {
 			viewportOffset: {
-				top: window.getViewportTopOffsetConfig()
+				top: getViewportTopOffsetConfig()
 			}
 		}
 	} )