Removing 'ckboxImageId' after replacing url: misc. fixes.

ckeditor · Oct 13, 2023 · 1981593 · 1981593
1 parent db8c25c
commit 1981593
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/packages/ckeditor5-ckbox/src/ckboxediting.ts b/packages/ckeditor5-ckbox/src/ckboxediting.ts
@@ -67,11 +67,6 @@ export default class CKBoxEditing extends Plugin {
  const isLibraryLoaded = !!window.CKBox;
 
  if ( replaceImageSourceCommand ) {
- // // After replacing image, "ckboxImageId" attribute will be removed.
- // replaceImageSourceCommand.registerImageCallback( ( writer, image ) => {
- // writer.removeAttribute( 'ckboxImageId', image );
- // } );
-
  this.listenTo<DecoratedMethodEvent<ReplaceImageSourceCommand, 'cleanupImage'>>(
  replaceImageSourceCommand,
  'cleanupImage',

diff --git a/packages/ckeditor5-image/src/image/replaceimagesourcecommand.ts b/packages/ckeditor5-image/src/image/replaceimagesourcecommand.ts
@@ -59,7 +59,18 @@ export default class ReplaceImageSourceCommand extends Command {
  }
 
  /**
- * Cleanup some image attributes.
+ * Cleanup image attributes that are not relevant to the new source.
+ *
+ * Removed attributes are: 'srcset', 'sizes', 'sources', 'width', 'height', 'alt'.
+ *
+ * This method is decorated, to allow custom cleanup logic.
+ * For example, to remove 'myImageId' attribute after 'src' has changed:
+ *
+ * ```ts
+ * replaceImageSourceCommand.on( 'cleanupImage', ( eventInfo, [ writer, image ] ) => {
+ * writer.removeAttribute( 'myImageId', image );
+ * } );
+ * ```
  */
  public cleanupImage( writer: Writer, image: Element ): void {
  writer.removeAttribute( 'srcset', image );