media-embed/converters

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

Functions

• modelToViewUrlAttributeConverter( registry, options = { [options.renderMediaPreview], [options.renderForEditingView] } ) → functionmodule:media-embed/converters.modelToViewUrlAttributeConverter

  static

  Returns a function that converts the model "url" attribute to the view representation.

  See source

  Depending on the configuration, the view representation can be "semantic" (for the data pipeline):

  <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>

  Note: Changing the model "url" attribute replaces the entire content of the <figure> in the view.

  Parameters

  registry : MediaRegistry

  The registry providing the media and their content.

  options : Object

  Properties

  [ options.renderMediaPreview ] : String

  When true, the converter will create the view in the non-semantic form.

  [ options.renderForEditingView ] : String

  When true, the converter will create a view specific for the editing pipeline (e.g. including CSS classes, content placeholders).

  Returns

  function