media-embed/utils

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

Functions

• createMediaFigureElement( writer, registry, url, options = { [options.useSemanticWrapper], [options.renderForEditingView] } ) → ContainerElementmodule:media-embed/utils.createMediaFigureElement

  static

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

  See source

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

  or "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 : DowncastWriter

  registry : MediaRegistry

  url : String

  options : Object

  Properties

  [ options.useSemanticWrapper ] : String

  [ options.renderForEditingView ] : String

  Returns

  ContainerElement

• getSelectedMediaElement( selection ) → Element | nullmodule:media-embed/utils.getSelectedMediaElement

  static

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

  See source

  Parameters

  selection : Selection

  Returns

  Element | null

• toMediaWidget( viewElement, writer, label ) → Elementmodule:media-embed/utils.toMediaWidget

  static

  Converts a given Element to a media embed widget:

  See source

  • Adds a custom property allowing to recognize the media 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.

  Returns

  Element