image/image/utils

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

Functions

• internal

  createBlockImageViewElement( writer ) → ContainerElementmodule:image/image/utils~createBlockImageViewElement

  See source

  Creates a view element representing the block image.

  <figure class="image"><img></img></figure>
  

  Note that alt and src attributes are converted separately, so they are not included.

  Parameters

  writer : DowncastWriter

  Returns

  ContainerElement

• internal

  createInlineImageViewElement( writer ) → ContainerElementmodule:image/image/utils~createInlineImageViewElement

  See source

  Creates a view element representing the inline image.

  <span class="image-inline"><img></img></span>
  

  Note that alt and src attributes are converted separately, so they are not included.

  Parameters

  writer : DowncastWriter

  Returns

  ContainerElement

• internal

  determineImageTypeForInsertionAtSelection( schema, selection ) → 'imageBlock' | 'imageInline'module:image/image/utils~determineImageTypeForInsertionAtSelection

  See source

  Considering the current model selection, it returns the name of the model image element ('imageBlock' or 'imageInline') that will make most sense from the UX perspective if a new image was inserted (also: uploaded, dropped, pasted) at that selection.

  The assumption is that inserting images into empty blocks or on other block widgets should produce block images. Inline images should be inserted in other cases, e.g. in paragraphs that already contain some text.

  Parameters

  schema : Schema

  selection : Selection | DocumentSelection

  Returns

  'imageBlock' | 'imageInline'

• internal

  getImgViewElementMatcher( editor, matchImageType ) → MatcherPatternmodule:image/image/utils~getImgViewElementMatcher

  See source

  A function returning a MatcherPattern for a particular type of View images.

  Parameters

  editor : Editor

  matchImageType : 'imageBlock' | 'imageInline'

  The type of created image.

  Returns

  MatcherPattern

• getSizeValueIfInPx( size ) → number | nullmodule:image/image/utils~getSizeValueIfInPx

  See source

  Returns parsed value of the size, but only if it contains unit: px.

  Parameters

  size : undefined | string

  Returns

  number | null

• widthAndHeightStylesAreBothSet( viewElement ) → booleanmodule:image/image/utils~widthAndHeightStylesAreBothSet

  See source

  Returns true if both styles (width and height) are set.

  If both image styles: width & height are set, they will override the image width & height attributes in the browser. In this case, the image looks the same as if these styles were applied to attributes instead of styles. That's why we can upcast these styles to width & height attributes instead of resizedWidth and resizedHeight.

  Parameters

  viewElement : Element

  Returns

  boolean