CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

media-embed/utils

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

module

Filtering

Functions

  • createMediaFigureElement( writer, registry, url, options = { [options.elementName], [options.useSemanticWrapper], [options.renderForEditingView] } ) → ContainerElement

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

    See source
    <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 : DowncastWriter
    registry : MediaRegistry
    url : String
    options : Object
    Properties
    [ options.elementName ] : String
    [ options.useSemanticWrapper ] : Boolean
    [ options.renderForEditingView ] : Boolean

    Returns

    ContainerElement

  • getSelectedMediaModelWidget( selection ) → Element | null

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

    See source

    Parameters

    selection : Selection

    Returns

    Element | null

  • getSelectedMediaViewWidget( selection ) → Element | null

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

    See source

    Parameters

    selection : Selection | DocumentSelection

    Returns

    Element | null

  • insertMedia( model, url, [ insertRange ], findOptimalPosition )

    Creates a media element and inserts it into the model.

    See source

    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.

    [ insertRange ] : Range

    The range to insert the media. If not specified, the default behavior of model.insertContent() will be applied.

    findOptimalPosition : Boolean

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

  • isMediaWidget( viewElement ) → Boolean

    Checks if a given view element is a media widget.

    See source

    Parameters

    viewElement : Element

    Returns

    Boolean

  • toMediaWidget( viewElement, writer, label ) → Element

    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