image/image/utils

@ckeditor/ckeditor5-image/src/image/utils

Functions

• getSelectedImageWidget( selection ) → Element | nullmodule:image/image/utils.getSelectedImageWidget

  static

  Returns an image widget editing view element if one is selected.

  See source

  Parameters

  selection : Selection | DocumentSelection

  Returns

  Element | null

• getViewImgFromWidget( figureView ) → Elementmodule:image/image/utils.getViewImgFromWidget

  static

  Get view <img> element from the view widget (<figure>).

  See source

  Assuming that image is always a first child of a widget (ie. figureView.getChild( 0 )) is unsafe as other features might inject their own elements to the widget.

  Parameters

  figureView : Element

  Returns

  Element

• insertImage( writer, model, [ attributes ] )module:image/image/utils.insertImage

  static

  Handles inserting single file. This method unifies image insertion using findOptimalInsertionPosition method.

  See source

  model.change( writer => {
      insertImage( writer, model, { src: 'path/to/image.jpg' } );
  } );

  Parameters

  writer : Writer

  model : Model

  [ attributes ] : Object

  Attributes of inserted image

  Defaults to {}

• isImage( modelElement ) → Booleanmodule:image/image/utils.isImage

  static

  Checks if the provided model element is an image.

  See source

  Parameters

  modelElement : Element

  Returns

  Boolean

• isImageAllowed( model ) → Booleanmodule:image/image/utils.isImageAllowed

  static

  Checks if image can be inserted at current model selection.

  See source

  Parameters

  model : Model

  Returns

  Boolean

• isImageWidget( viewElement ) → Booleanmodule:image/image/utils.isImageWidget

  static

  Checks if a given view element is an image widget.

  See source

  Parameters

  viewElement : Element

  Returns

  Boolean

• toImageWidget( viewElement, writer, label ) → Elementmodule:image/image/utils.toImageWidget

  static

  Converts a given Element to an image widget:

  See source

  • Adds a custom property allowing to recognize the image widget element.
  • Calls the toWidget function with the proper element's label creator.

  Parameters

  viewElement : Element

  writer : DowncastWriter

  An instance of the view writer.

  label : String

  The element's label. It will be concatenated with the image alt attribute if one is present.

  Returns

  Element