CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

code-block/converters

@ckeditor/ckeditor5-code-block/src/converters

module

Filtering

Functions

  • dataViewToModelCodeBlockInsertion( editingView, languageDefs ) → function

    A view-to-model converter for <pre> with the <code> HTML.

    See source

    Sample input:

    <pre><code class="language-javascript">foo();\nbar();</code></pre>

    Sample output:

    <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>

    Parameters

    editingView : View
    languageDefs : Array.<CodeBlockLanguageDefinition>

    The normalized language configuration passed to the feature.

    Returns

    function

    Returns a conversion callback.

  • modelToDataViewSoftBreakInsertion( model ) → function

    A model-to-data view converter for the new line (softBreak) separator.

    See source

    Sample input:

    <codeBlock ...>foo();<softBreak></softBreak>bar();</codeBlock>

    Sample output:

    <pre><code ...>foo();\nbar();</code></pre>

    Parameters

    model : Model

    Returns

    function

    Returns a conversion callback.

  • modelToViewCodeBlockInsertion( model, languageDefs, [ useLabels ] ) → function

    A model-to-view (both editing and data) converter for the codeBlock element.

    See source

    Sample input:

    <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>

    Sample output (editing):

    <pre data-language="JavaScript"><code class="language-javascript">foo();<br />bar();</code></pre>

    Sample output (data, see modelToDataViewSoftBreakInsertion):

    <pre><code class="language-javascript">foo();\nbar();</code></pre>

    Parameters

    model : Model
    languageDefs : Array.<CodeBlockLanguageDefinition>

    The normalized language configuration passed to the feature.

    [ useLabels ] : Boolean

    When true, the <pre> element will get a data-language attribute with a human–readable label of the language. Used only in the editing.

    Defaults to false

    Returns

    function

    Returns a conversion callback.