Interface

CodeBlockConfig (code-block)

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

interface

The configuration of the code block feature.

ClassicEditor
    .create( editorElement, {
        codeBlock:  ... // The code block feature configuration.
    } )
    .then( ... )
    .catch( ... );

See all editor options.

Filtering

Properties

  • indentSequence : String

    A sequence of characters inserted or removed from the code block lines when its indentation is changed by the user, for instance, using Tab and Shift+Tab keys.

    The default value is a single tab character (" ", \u0009 in Unicode).

    This configuration is used by indentCodeBlock and outdentCodeBlock commands (instances of IndentCodeBlockCommand).

    Note: Setting this configuration to false will disable the code block indentation commands and associated keystrokes.

  • languages : Array.<CodeBlockLanguageDefinition>

    The list of code languages available in the user interface to choose for a particular code block.

    The language of the code block is represented as a CSS class (by default prefixed by "language-") set on the <code> element, both when editing and in the editor data. The CSS class associated with the language can be used by third–party code syntax highlighters to detect and apply the correct highlighting.

    For instance, this language configuration:

    ClassicEditor
        .create( document.querySelector( '#editor' ), {
            codeBlock: {
                languages: [
                    // ...
                    { language: 'javascript', label: 'JavaScript' },
                    // ...
                ]
            }
    } )
    .then( ... )
    .catch( ... );

    will result in the following structure of JavaScript code blocks in the editor editing and data:

    <pre><code class="language-javascript">window.alert( 'Hello world!' )</code></pre>

    You can customize the CSS class by specifying an optional class property in the language definition:

    ClassicEditor
        .create( document.querySelector( '#editor' ), {
            codeBlock: {
                languages: [
                    // Do not render the CSS class for the plain text code blocks.
                    { language: 'plaintext', label: 'Plain text', class: '' },
    
                    // Use the "php-code" class for PHP code blocks.
                    { language: 'php', label: 'PHP', class: 'php-code' },
    
                    // Use the "js" class for JavaScript code blocks.
                    { language: 'javascript', label: 'JavaScript', class: 'js' },
    
                    // Python code blocks will have the default "language-python" CSS class.
                    { language: 'python', label: 'Python' }
                ]
            }
    } )
    .then( ... )
    .catch( ... );

    The default value of the language configuration is as follows:

    languages: [
        { language: 'plaintext', label: 'Plain text' }, // The default language.
        { language: 'c', label: 'C' },
        { language: 'cs', label: 'C#' },
        { language: 'cpp', label: 'C++' },
        { language: 'css', label: 'CSS' },
        { language: 'diff', label: 'Diff' },
        { language: 'xml', label: 'HTML/XML' },
        { language: 'java', label: 'Java' },
        { language: 'javascript', label: 'JavaScript' },
        { language: 'php', label: 'PHP' },
        { language: 'python', label: 'Python' },
        { language: 'ruby', label: 'Ruby' },
        { language: 'typescript', label: 'TypeScript' },
    ]

    Note: The first language defined in the configuration is considered the default one. This means it will be applied to code blocks loaded from the data that have no CSS class specified (or no matching class in the configuration). It will also be used when creating new code blocks using the main UI button. By default it is "Plain text".