CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Module

image/image/converters

@ckeditor/ckeditor5-image/src/image/converters

module

Filtering

Functions

  • downcastImageAttribute( imageUtils, imageType, attributeKey ) → function

    protected

    Converter used to convert a given image attribute from the model to the view.

    See source

    Parameters

    imageUtils : ImageUtils
    imageType : 'imageBlock' | 'imageInline'

    The type of the image.

    attributeKey : String

    The name of the attribute to convert.

    Returns

    function

  • downcastSourcesAttribute( imageUtils ) → function

    protected

    Converts the source model attribute to the <picture><source /><source />...<img /></picture> view structure.

    See source

    Parameters

    imageUtils : ImageUtils

    Returns

    function

  • downcastSrcsetAttribute( imageUtils, imageType ) → function

    protected

    Converter used to convert the srcset model image attribute to the srcset, sizes and width attributes in the view.

    See source

    Parameters

    imageUtils : ImageUtils
    imageType : 'imageBlock' | 'imageInline'

    The type of the image.

    Returns

    function

  • upcastImageFigure( imageUtils ) → function

    protected

    Returns a function that converts the image view representation:

    See source
    <figure class="image"><img src="..." alt="..."></img></figure>

    to the model representation:

    <imageBlock src="..." alt="..."></imageBlock>

    The entire content of the <figure> element except the first <img> is being converted as children of the <imageBlock> model element.

    Parameters

    imageUtils : ImageUtils

    Returns

    function

  • upcastPicture( imageUtils ) → function

    protected

    Returns a function that converts the image view representation:

    See source
    <picture><source ... /><source ... />...<img ... /></picture>

    to the model representation as the sources attribute:

    <image[Block|Inline] ... sources="..."></image[Block|Inline]>

    Parameters

    imageUtils : ImageUtils

    Returns

    function