code-block/converters

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

Functions

• dataViewToModelCodeBlockInsertion( editingView, languageDefs ) → functionmodule:code-block/converters~dataViewToModelCodeBlockInsertion

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

  See source

  Sample input:

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

  Copy

  Sample output:

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

  Copy

  Parameters

  editingView : View

  languageDefs : Array.<CodeBlockLanguageDefinition>

  The normalized language configuration passed to the feature.

  Returns

  function

  Returns a conversion callback.

• dataViewToModelOrphanNodeConsumer() → functionmodule:code-block/converters~dataViewToModelOrphanNodeConsumer

  A view-to-model converter that handles orphan text nodes (white spaces, new lines, etc.) that surround <code> inside <pre>.

  See source

  Sample input:

  // White spaces
  <pre> <code>foo()</code> </pre>
  
  // White spaces
  <pre>      <code>foo()</code>      </pre>
  
  // White spaces
  <pre>			<code>foo()</code>			</pre>
  
  // New lines
  <pre>
  	<code>foo()</code>
  </pre>
  
  // Redundant text
  <pre>ABC<code>foo()</code>DEF</pre>
  

  Copy

  Unified output for each case:

  <codeBlock language="plaintext">foo()</codeBlock>

  Copy

  Returns

  function

  Returns a conversion callback.

• dataViewToModelTextNewlinesInsertion() → functionmodule:code-block/converters~dataViewToModelTextNewlinesInsertion

  A view-to-model converter for new line characters in <pre>.

  See source

  Sample input:

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

  Copy

  Sample output:

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

  Copy

  Returns

  function

  Returns a conversion callback.

• modelToDataViewSoftBreakInsertion( model ) → functionmodule:code-block/converters~modelToDataViewSoftBreakInsertion

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

  See source

  Sample input:

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

  Copy

  Sample output:

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

  Copy

  Parameters

  model : Model

  Returns

  function

  Returns a conversion callback.

• modelToViewCodeBlockInsertion( model, languageDefs, [ useLabels ] ) → functionmodule:code-block/converters~modelToViewCodeBlockInsertion

  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>
  

  Copy

  Sample output (editing):

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

  Copy

  Sample output (data, see modelToDataViewSoftBreakInsertion):

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

  Copy

  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.