Merge ee93cf6 into b2a8189

ckeditor · Jan 21, 2020 · 28976a6 · 28976a6
2 parents b2a8189 + ee93cf6
commit 28976a6
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 20 deletions.
diff --git a/docs/_snippets/framework/extending-content-custom-figure-attributes.js b/docs/_snippets/framework/extending-content-custom-figure-attributes.js
@@ -3,23 +3,40 @@
  * For licensing, see LICENSE.md.
  */
 
-/* globals ClassicEditor, console, window, document */
+/* globals ClassicEditor,  console, window, document */
 
 import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';
 
 /**
  * Plugin that converts custom attributes for elements that are wrapped in <figure> in the view.
  */
-function CustomFigureAttributes( editor ) {
-	// Define on which elements the CSS classes should be preserved:
-	setupCustomClassConversion( 'img', 'image', editor );
-	setupCustomClassConversion( 'table', 'table', editor );
-
-	editor.conversion.for( 'upcast' ).add( upcastCustomClasses( 'figure' ), { priority: 'low' } );
-
-	// Define custom attributes that should be preserved.
-	setupCustomAttributeConversion( 'img', 'image', 'id', editor );
-	setupCustomAttributeConversion( 'table', 'table', 'id', editor );
+class CustomFigureAttributes {
+	/**
+	 * Plugin's constructor - receives editor instance on creation.
+	 */
+	constructor( editor ) {
+		// Save reference to the editor.
+		this.editor = editor;
+	}
+
+	/**
+	 * Setups conversion and extends table & image features schema.
+	 *
+	 * Schema extending must be done in the “afterInit()” call because plugins define their schema in “init()“.
+	 */
+	afterInit() {
+		const editor = this.editor;
+
+		// Define on which elements the CSS classes should be preserved:
+		setupCustomClassConversion( 'img', 'image', editor );
+		setupCustomClassConversion( 'table', 'table', editor );
+
+		editor.conversion.for( 'upcast' ).add( upcastCustomClasses( 'figure' ), { priority: 'low' } );
+
+		// Define custom attributes that should be preserved.
+		setupCustomAttributeConversion( 'img', 'image', 'id', editor );
+		setupCustomAttributeConversion( 'table', 'table', 'id', editor );
+	}
 }
 
 /**

diff --git a/docs/framework/guides/deep-dive/conversion-preserving-custom-content.md b/docs/framework/guides/deep-dive/conversion-preserving-custom-content.md
@@ -290,16 +290,33 @@ The sample below is extensible. To add your own attributes to preserve, just add
 /**
  * Plugin that converts custom attributes for elements that are wrapped in <figure> in the view.
  */
-function CustomFigureAttributes( editor ) {
-	// Define on which elements the CSS classes should be preserved:
-	setupCustomClassConversion( 'img', 'image', editor );
-	setupCustomClassConversion( 'table', 'table', editor );
+class CustomFigureAttributes {
+	/**
+	 * Plugin's constructor - receives editor instance on creation.
+	 */
+	constructor( editor ) {
+		// Save reference to the editor.
+		this.editor = editor;
+}
+
+	/**
+	 * Setups conversion and extends table & image features schema.
+	 *
+	 * Schema extending must be done in the “afterInit()” call because plugins define their schema in “init()“.
+	 */
+	afterInit() {
+		const editor = this.editor;
+
+		// Define on which elements the CSS classes should be preserved:
+		setupCustomClassConversion( 'img', 'image', editor );
+		setupCustomClassConversion( 'table', 'table', editor );
 
-	editor.conversion.for( 'upcast' ).add( upcastCustomClasses( 'figure' ), { priority: 'low' } );
+		editor.conversion.for( 'upcast' ).add( upcastCustomClasses( 'figure' ), { priority: 'low' } );
 
-	// Define custom attributes that should be preserved.
-	setupCustomAttributeConversion( 'img', 'image', 'id', editor );
-	setupCustomAttributeConversion( 'table', 'table', 'id', editor );
+		// Define custom attributes that should be preserved.
+		setupCustomAttributeConversion( 'img', 'image', 'id', editor );
+		setupCustomAttributeConversion( 'table', 'table', 'id', editor );
+	}
 }
 
 /**
@@ -451,4 +468,4 @@ ClassicEditor
 
 ## What's next?
 
-If you would like to read more about how to extend the output of existing CKEditor 5 features, refer to the {@link framework/guides/deep-dive/conversion-extending-output Extending the editor output} guide.
+If you would like to read more about how to extend the output of existing CKEditor 5 features, refer to the {@link framework/guides/deep-dive/conversion-extending-output Extending the editor output} guide.