media-embed/utils

@ckeditor/ckeditor5-media-embed/src/utils

Type Definitions

• MediaOptionsmodule:media-embed/utils~MediaOptions

Functions

• internal

  createMediaFigureElement( writer, registry, url, options ) → ViewContainerElementmodule:media-embed/utils~createMediaFigureElement

  See source

  Creates a view element representing the media. Either a "semantic" one for the data pipeline:

  <figure class="media">
  	<oembed url="foo"></oembed>
  </figure>
  

  or a "non-semantic" (for the editing view pipeline):

  <figure class="media">
  	<div data-oembed-url="foo">[ non-semantic media preview for "foo" ]</div>
  </figure>
  

  Parameters

  writer : ViewDowncastWriter

  registry : MediaRegistry

  url : string

  options : MediaOptions

  Returns

  ViewContainerElement

• internal

  getSelectedMediaModelWidget( selection ) → null | ModelElementmodule:media-embed/utils~getSelectedMediaModelWidget

  See source

  Returns a selected media element in the model, if any.

  Parameters

  selection : ModelSelection | ModelDocumentSelection

  Returns

  null | ModelElement

• internal

  getSelectedMediaViewWidget( selection ) → null | ViewElementmodule:media-embed/utils~getSelectedMediaViewWidget

  See source

  Returns a media widget editing view element if one is selected.

  Parameters

  selection : ViewDocumentSelection

  Returns

  null | ViewElement

• internal

  insertMedia( model, url, selectable, findOptimalPosition ) → voidmodule:media-embed/utils~insertMedia

  See source

  Creates a media element and inserts it into the model.

  Note: This method will use model.insertContent() logic of inserting content if no insertPosition is passed.

  Parameters

  model : Model

  url : string

  An URL of an embeddable media.

  selectable : ModelSelectable

  findOptimalPosition : boolean

  If true it will try to find optimal position to insert media without breaking content in which a selection is.

  Returns

  void

• internal

  isMediaWidget( viewElement ) → booleanmodule:media-embed/utils~isMediaWidget

  See source

  Checks if a given view element is a media widget.

  Parameters

  viewElement : ViewElement

  Returns

  boolean

• internal

  toMediaWidget( viewElement, writer, label ) → ViewElementmodule:media-embed/utils~toMediaWidget

  See source

  Converts a given ViewElement to a media embed widget:

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

  Parameters

  viewElement : ViewElement

  writer : ViewDowncastWriter

  An instance of the view writer.

  label : string

  The element's label.

  Returns

  ViewElement