Report an issue
Class

CKEDITOR.config

class singleton

Stores default configuration settings. Changes to this object are reflected in all editor instances, if not specified otherwise for a particular instance.

Read more about setting CKEditor configuration in the documentation.

Filtering

Config options

  • allowedContent : allowedContentRules | Boolean

    since 4.1

    Allowed content rules. This setting is used when instantiating CKEDITOR.editor.filter.

    The following values are accepted:

    In all cases filter configuration may be extended by extraAllowedContent. This option may be especially useful when you want to use the default allowedContent value along with some additional rules.

    CKEDITOR.replace( 'textarea_id', {
        allowedContent: 'p b i; a[!href]',
        on: {
            instanceReady: function( evt ) {
                var editor = evt.editor;
    
                editor.filter.check( 'h1' ); // -> false
                editor.setData( '<h1><i>Foo</i></h1><p class="left"><span>Bar</span> <a href="http://foo.bar">foo</a></p>' );
                // Editor contents will be:
                '<p><i>Foo</i></p><p>Bar <a href="http://foo.bar">foo</a></p>'
            }
        }
    } );
    

    It is also possible to disallow some already allowed content. It is especially useful when you want to "trim down" the content allowed by default by editor features. To do that, use the disallowedContent option.

    Read more in the documentation and see the SDK sample.

    Defaults to null

  • autoEmbed_widget : String | Function

    since 4.5

    Specifies the widget to use to automatically embed a link. The default value of this option defines that either the Media Embed or Semantic Media Embed widgets will be used, depending on which is enabled.

    The general behavior:

    • If a string (widget names separated by commas) is provided, then the first of the listed widgets which is registered will be used. For example, if 'foo,bar,bom' is set and widgets 'bar' and 'bom' are registered, then 'bar' will be used.
    • If a callback is specified, then it will be executed with the URL to be embedded and it should return the name of the widget to be used. It allows to use different embed widgets for different URLs.

    Example:

    // Defines that embedSemantic should be used (regardless of whether embed is defined).
    config.autoEmbed_widget = 'embedSemantic';
    

    Using with custom embed widgets:

    config.autoEmbed_widget = 'customEmbed';
    

    Note: Plugin names are always lower case, while widget names are not, so widget names do not have to equal plugin names. For example, there is the embedsemantic plugin and the embedSemantic widget.

    Read more in the documentation and see the SDK sample.

    Defaults to 'embed,embedSemantic'

  • autoGrow_bottomSpace : Number

    since 3.6.2

    Extra vertical space to be added between the content and the editor bottom bar when adjusting editor height to content by using the Auto Grow feature. This option accepts a value in pixels, without the unit (for example: 50).

    Read more in the documentation and see the SDK sample.

    config.autoGrow_bottomSpace = 50;
    

    Defaults to 0

  • autoGrow_maxHeight : Number

    since 3.4

    The maximum height that the editor can assume when adjusting to content by using the Auto Grow feature. This option accepts a value in pixels, without the unit (for example: 600). Zero (0) means that the maximum height is not limited and the editor will expand infinitely.

    Read more in the documentation and see the SDK sample.

    config.autoGrow_maxHeight = 400;
    

    Defaults to 0

  • autoGrow_minHeight : Number

    since 3.4

    The minimum height that the editor can assume when adjusting to content by using the Auto Grow feature. This option accepts a value in pixels, without the unit (for example: 300).

    Read more in the documentation and see the SDK sample.

    config.autoGrow_minHeight = 300;
    

    Defaults to 200

  • autoGrow_onStartup : Boolean

    since 3.6.2

    Whether automatic editor height adjustment brought by the Auto Grow feature should happen on editor creation.

    Read more in the documentation and see the SDK sample.

    config.autoGrow_onStartup = true;
    

    Defaults to false

  • autoParagraph : Boolean

    since 3.6 deprecated

    Whether to automatically create wrapping blocks around inline content inside the document body. This helps to ensure the integrity of the block Enter mode.

    Note: This option is deprecated. Changing the default value might introduce unpredictable usability issues and is highly unrecommended.

    config.autoParagraph = false;
    

    Defaults to true

  • autoUpdateElement : Boolean

    Whether the element replaced by the editor (usually a <textarea>) is to be updated automatically when posting the form containing the editor.

    Defaults to true

  • autocomplete_commitKeystrokes : Number | Number[]

    since 4.10.0

    The autocomplete keystrokes used to finish autocompletion with the selected view item. This setting will set completing keystrokes for each autocomplete plugin respectively.

    To change completing keystrokes individually use the CKEDITOR.plugins.autocomplete.commitKeystrokes plugin property.

    // Default configuration (9 = Tab, 13 = Enter).
    config.autocomplete_commitKeystrokes = [ 9, 13 ];
    

    Commit keystroke can also be disabled by setting it to an empty array.

    // Disable autocomplete commit keystroke.
    config.autocomplete_commitKeystrokes = [];
    

    Defaults to [9, 13]

  • The Auto Link plugin keystrokes used to finish link completion.

    // Default configuration (13 = Enter, 32 = space).
    config.autolink_commitKeystrokes = [ 9, 13 ];
    

    Commit keystrokes can be also disabled by setting it to an empty array.

    // Disable autolink commit keystrokes.
    config.autolink_commitKeystrokes = [];
    

    Defaults to [ 13, 32 ]

  • Regex used by the Auto Link plugin to match email adresses.

    Defaults to /^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/

  • Regex used by the Auto Link plugin to match URL adresses.

    Defaults to /^(https?|ftp):\/\/(-\.)?([^\s\/?\.#]+\.?)+(\/[^\s]*)?[^\s\.,]$/i

  • baseFloatZIndex : Number

    The base Z-index for floating dialog windows and popups.

    config.baseFloatZIndex = 2000;
    

    Defaults to 10000

  • baseHref : String

    The base href URL used to resolve relative and absolute URLs in the editor content.

    config.baseHref = 'http://www.example.com/path/';
    

    Defaults to ''

  • basicEntities : Boolean

    Whether to escape basic HTML entities in the document, including:

    • &nbsp;
    • &gt;
    • &lt;
    • &amp;

    Note: This option should not be changed unless when outputting a non-HTML data format like BBCode.

    config.basicEntities = false;
    

    Defaults to true

  • blockedKeystrokes : Array

    The keystrokes that are blocked by default as the browser implementation is buggy. These default keystrokes are handled by the editor.

    // Default setting.
    config.blockedKeystrokes = [
        CKEDITOR.CTRL + 66, // Ctrl+B
        CKEDITOR.CTRL + 73, // Ctrl+I
        CKEDITOR.CTRL + 85 // Ctrl+U
    ];
    

    Defaults to see example

  • bodyClass : String

    since 3.1

    Sets the class attribute to be used on the body element of the editing area. This can be useful when you intend to reuse the original CSS file you are using on your live website and want to assign the editor the same class as the section that will include the contents. In this way class-specific CSS rules will be enabled.

    config.bodyClass = 'contents';
    

    Note: The editor needs to load stylesheets containing contents styles. You can either copy them to the contents.css file that the editor loads by default or set the contentsCss option.

    Note: This setting only applies to classic editor (the one that uses iframe).

    Defaults to ''

  • bodyId : String

    since 3.1

    Sets the id attribute to be used on the body element of the editing area. This can be useful when you intend to reuse the original CSS file you are using on your live website and want to assign the editor the same ID as the section that will include the contents. In this way ID-specific CSS rules will be enabled.

    config.bodyId = 'contents_id';
    

    Defaults to ''

  • browserContextMenuOnCtrl : Boolean

    since 3.0.2

    Whether to show the browser native context menu when the Ctrl or Meta (Mac) key is pressed on opening the context menu with the right mouse button click or the Menu key.

    config.browserContextMenuOnCtrl = false;
    

    Defaults to true

  • clipboard_defaultContentType : 'html' | 'text'

    since 4.0

    The default content type that is used when pasted data cannot be clearly recognized as HTML or text.

    For example: 'foo' may come from a plain text editor or a website. It is not possible to recognize the content type in this case, so the default type will be used. At the same time it is clear that '<b>example</b> text' is HTML and its origin is a web page, email or another rich text editor.

    Note: If content type is text, then styles of the paste context are preserved.

    CKEDITOR.config.clipboard_defaultContentType = 'text';
    

    See also the CKEDITOR.editor.paste event and read more about the integration with clipboard in the Clipboard Deep Dive guide.

    Defaults to 'html'

  • clipboard_notificationDuration : Number

    since 4.7.0

    Duration of the notification displayed after pasting was blocked by the browser.

    Defaults to 10000

  • cloudServices_tokenUrl : String

    since 4.9.0

    The URL to the security token endpoint in your application. The role of this endpoint is to securely authorize the end users of your application to use CKEditor Cloud Services, only if they should have access e.g. to upload files with Easy Image.

    You can find more information about token endpoints in the Easy Image - Quick Start and Cloud Services - Creating token endpoint documentation.

    Without a properly working token endpoint (token URL) CKEditor plugins will not be able to connect to CKEditor Cloud Services.

    CKEDITOR.replace( 'editor', {
        extraPlugins: 'easyimage',
        cloudServices_tokenUrl: 'https://example.com/cs-token-endpoint',
        cloudServices_uploadUrl: 'https://your-organization-id.cke-cs.com/easyimage/upload/'
    } );
    

    Defaults to ''

  • cloudServices_uploadUrl : String

    since 4.9.0

    The endpoint URL for CKEditor Cloud Services uploads. This option must be set for Easy Image to work correctly.

    The upload URL is unique for each customer and can be found in the CKEditor Ecosystem dashboard after subscribing to the Easy Image service. To learn how to start using Easy Image, refer to the Easy Image Integration documentation.

    Note: Make sure to also set the cloudServices_tokenUrl configuration option.

    CKEDITOR.replace( 'editor', {
        extraPlugins: 'easyimage',
        cloudServices_tokenUrl: 'https://example.com/cs-token-endpoint',
        cloudServices_uploadUrl: 'https://your-organization-id.cke-cs.com/easyimage/upload/'
    } );
    

    Defaults to ''

  • codeSnippetGeshi_url : String

    Sets GeSHi URL which, once queried with Ajax, will return highlighted code.

    Check the Code Snippet GeSHi documentation for more information.

    config.codeSnippetGeshi_url = 'http:\/\/example.com\/geshi\/colorize.php';
    

    Defaults to null

  • codeSnippet_codeClass : String

    since 4.4

    A CSS class of the <code> element used internally for styling (by default highlight.js themes, see config.codeSnippet_theme), which means that it is not present in the editor output data.

    // Changes the class to "myCustomClass".
    config.codeSnippet_codeClass = 'myCustomClass';
    

    Note: The class might need to be changed when you are using a custom highlighter (the default is highlight.js). See CKEDITOR.plugins.codesnippet.highlighter to read more.

    Read more in the documentation and see the SDK sample.

    Defaults to 'hljs'

  • codeSnippet_languages : Object

    since 4.4

    Restricts languages available in the "Code Snippet" dialog window. An empty value is always added to the list.

    Note: If using a custom highlighter library (the default is highlight.js), you may need to refer to external documentation to set config.codeSnippet_languages properly.

    Read more in the documentation and see the SDK sample.

    // Restricts languages to JavaScript and PHP.
    config.codeSnippet_languages = {
        javascript: 'JavaScript',
        php: 'PHP'
    };
    

    Defaults to null

  • codeSnippet_theme : String

    since 4.4

    A theme used to render code snippets. See available themes.

    Note: This will only work with the default highlighter (highlight.js).

    Read more in the documentation and see the SDK sample.

    // Changes the theme to "pojoaque".
    config.codeSnippet_theme = 'pojoaque';
    

    Defaults to 'default'

  • colorButton_backStyle : Object

    Stores the style definition that applies the text background color.

    Read more in the documentation and see the SDK sample.

    // This is actually the default value.
    config.colorButton_backStyle = {
        element: 'span',
        styles: { 'background-color': '#(color)' }
    };
    

    Defaults to see source

  • colorButton_colors : String

    Defines the colors to be displayed in the color selectors. This is a string containing hexadecimal notation for HTML colors, without the '#' prefix.

    Since 3.3: A color name may optionally be defined by prefixing the entries with a name and the slash character. For example, 'FontColor1/FF9900' will be displayed as the color #FF9900 in the selector, but will be output as 'FontColor1'.

    Since 4.6.2: The default color palette has changed. It contains fewer colors in more pastel shades than the previous one.

    Read more in the documentation and see the SDK sample.

    // Brazil colors only.
    config.colorButton_colors = '00923E,F8C100,28166F';
    
    config.colorButton_colors = 'FontColor1/FF9900,FontColor2/0066CC,FontColor3/F00';
    
    // CKEditor color palette available before version 4.6.2.
    config.colorButton_colors =
        '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,' +
        'B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,' +
        'F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,' +
        'FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,' +
        'FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF';
    

    Defaults to see source

  • colorButton_colorsPerRow : Number

    since 4.6.2

    Defines how many colors will be shown per row in the color selectors.

    Read more in the documentation and see the SDK sample.

    config.colorButton_colorsPerRow = 8;
    

    Defaults to 6

  • colorButton_enableAutomatic : Boolean

    Whether to enable the Automatic button in the color selectors.

    Read more in the documentation and see the SDK sample.

    config.colorButton_enableAutomatic = false;
    

    Defaults to true

  • colorButton_enableMore : Boolean

    Whether to enable the More Colors button in the color selectors.

    Read more in the documentation and see the SDK sample.

    config.colorButton_enableMore = false;
    

    Defaults to true

  • colorButton_foreStyle : Object

    Stores the style definition that applies the text foreground color.

    Read more in the documentation and see the SDK sample.

    // This is actually the default value.
    config.colorButton_foreStyle = {
        element: 'span',
        styles: { color: '#(color)' }
    };
    

    Defaults to see source

  • colorButton_normalizeBackground : Boolean

    since 4.6.1

    Whether the plugin should convert background CSS properties with color only, to a background-color property, allowing the Color Button plugin to edit these styles.

    config.colorButton_normalizeBackground = false;
    

    Defaults to true

  • contentsCss : String | Array

    The CSS file(s) to be used to apply style to editor content. It should reflect the CSS used in the target pages where the content is to be displayed.

    Note: This configuration value is ignored by inline editor as it uses the styles that come directly from the page that CKEditor is rendered on. It is also ignored in the full page mode in which the developer has full control over the page HTML code.

    Read more in the documentation and see the SDK sample.

    config.contentsCss = '/css/mysitestyles.css';
    config.contentsCss = [ '/css/mysitestyles.css', '/css/anotherfile.css' ];
    

    Defaults to CKEDITOR.getUrl( 'contents.css' )

  • contentsLangDirection : String

    The writing direction of the language which is used to create editor content. Allowed values are:

    • '' (an empty string) – Indicates that content direction will be the same as either the editor UI direction or the page element direction depending on the editor type:
      • Classic editor – The same as the user interface language direction.
      • Inline editor– The same as the editable element text direction.
    • 'ltr' – Indicates a Left-To-Right text direction (like in English).
    • 'rtl' – Indicates a Right-To-Left text direction (like in Arabic).

    See the SDK sample.

    Example:

    config.contentsLangDirection = 'rtl';
    

    Defaults to ''

  • contentsLanguage : String

    Language code of the writing language which is used to author the editor content. This option accepts one single entry value in the format defined in the Tags for Identifying Languages (BCP47) IETF document and is used in the lang attribute.

    config.contentsLanguage = 'fr';
    

    Defaults to same value with editor's UI language

  • contextmenu_contentsCss : String | String[]

    since 4.11.0

    The CSS file(s) to be used to apply the style to the context menu content.

    config.contextmenu_contentsCss = '/css/myfile.css';
    config.contextmenu_contentsCss = [ '/css/myfile.css', '/css/anotherfile.css' ];
    

    Defaults to CKEDITOR.skin.getPath( 'editor' )

  • copyFormatting_allowRules : String

    since 4.6.0

    Defines rules for the elements from which the styles should be fetched. If set to true, it will disable filtering.

    This property is using Advanced Content Filter syntax. You can learn more about it in the Content Filtering (ACF) documentation.

    config.copyFormatting_allowRules = 'span(*)[*]{*}'; // Allows only spans.
    config.copyFormatting_allowRules = true; // Disables filtering.
    

    Read more in the documentation and see the SDK sample.

    Defaults to 'b; s; u; strong; span; p; div; table; thead; tbody; ' + 'tr; td; th; ol; ul; li; (*)[*]{*}'

  • copyFormatting_allowedContexts : Boolean | String[]

    since 4.6.0

    Defines which contexts should be enabled in the Copy Formatting plugin. Available contexts are:

    • 'text' – Plain text context.
    • 'list' – List context.
    • 'table' – Table context.

    Examples:

    // Enables only plain text context.
    config.copyFormatting_allowedContexts = [ 'text' ];
    
    // If set to "true", enables all contexts.
    config.copyFormatting_allowedContexts = true;
    

    Read more in the documentation and see the SDK sample.

    Defaults to true

  • copyFormatting_disallowRules : String

    since 4.6.0

    Defines rules for the elements from which fetching styles is explicitly forbidden (eg. widgets).

    This property is using Advanced Content Filter syntax. You can learn more about it in the Content Filtering (ACF) documentation.

    config.copyFormatting_disallowRules = 'span(important)'; // Disallows spans with "important" class.
    

    Read more in the documentation and see the SDK sample.

    Defaults to '*[data-cke-widget*,data-widget*,data-cke-realelement](cke_widget*)'

  • copyFormatting_keystrokeCopy : Number

    since 4.6.0

    Defines the keyboard shortcut for copying styles.

    config.copyFormatting_keystrokeCopy = CKEDITOR.CTRL + CKEDITOR.SHIFT + 66; // Ctrl+Shift+B
    

    The keyboard shortcut can also be switched off:

    config.copyFormatting_keystrokeCopy = false;
    

    Read more in the documentation and see the SDK sample.

    Defaults to CKEDITOR.CTRL + CKEDITOR.SHIFT + 67

  • copyFormatting_keystrokePaste : Number

    since 4.6.0

    Defines the keyboard shortcut for applying styles.

    config.copyFormatting_keystrokePaste = CKEDITOR.CTRL + CKEDITOR.SHIFT + 77; // Ctrl+Shift+M
    

    The keyboard shortcut can also be switched off:

    config.copyFormatting_keystrokePaste = false;
    

    Read more in the documentation and see the SDK sample.

    Defaults to CKEDITOR.CTRL + CKEDITOR.SHIFT + 86

  • copyFormatting_outerCursor : Boolean

    since 4.6.0

    Defines if the "disabled" cursor should be attached to the whole page when the Copy Formatting plugin is active.

    "Disabled" cursor indicates that Copy Formatting will not work in the place where the mouse cursor is placed.

    config.copyFormatting_outerCursor = false;
    

    Read more in the documentation and see the SDK sample.

    Defaults to true

  • coreStyles_bold : Object

    The style definition that applies the bold style to the text.

    Read more in the documentation and see the SDK sample.

    config.coreStyles_bold = { element: 'b', overrides: 'strong' };
    
    config.coreStyles_bold = {
        element: 'span',
        attributes: { 'class': 'Bold' }
    };
    

    Defaults to {element: 'strong', overrides: 'b'}

  • coreStyles_italic : Object

    The style definition that applies the italics style to the text.

    Read more in the documentation and see the SDK sample.

    config.coreStyles_italic = { element: 'i', overrides: 'em' };
    
    CKEDITOR.config.coreStyles_italic = {
        element: 'span',
        attributes: { 'class': 'Italic' }
    };
    

    Defaults to {element: 'em', overrides: 'i'}

  • coreStyles_strike : Object

    The style definition that applies the strikethrough style to the text.

    Read more in the documentation and see the SDK sample.

    CKEDITOR.config.coreStyles_strike = {
        element: 'span',
        attributes: { 'class': 'Strikethrough' },
        overrides: 'strike'
    };
    

    Defaults to {element: 's', overrides: 'strike'}

  • coreStyles_subscript : Object

    The style definition that applies the subscript style to the text.

    Read more in the documentation and see the SDK sample.

    CKEDITOR.config.coreStyles_subscript = {
        element: 'span',
        attributes: { 'class': 'Subscript' },
        overrides: 'sub'
    };
    

    Defaults to {element: 'sub'}

  • coreStyles_superscript : Object

    The style definition that applies the superscript style to the text.

    Read more in the documentation and see the SDK sample.

    CKEDITOR.config.coreStyles_superscript = {
        element: 'span',
        attributes: { 'class': 'Superscript' },
        overrides: 'sup'
    };
    

    Defaults to {element: 'sup'}

  • coreStyles_underline : Object

    The style definition that applies the underline style to the text.

    Read more in the documentation and see the SDK sample.

    CKEDITOR.config.coreStyles_underline = {
        element: 'span',
        attributes: { 'class': 'Underline' }
    };
    

    Defaults to {element: 'u'}

  • customConfig : String

    The URL path to the custom configuration file to be loaded. If not overwritten with inline configuration, it defaults to the config.js file present in the root of the CKEditor installation directory.

    CKEditor will recursively load custom configuration files defined inside other custom configuration files.

    Read more about setting CKEditor configuration in the documentation.

    // Load a specific configuration file.
    CKEDITOR.replace( 'myfield', { customConfig: '/myconfig.js' } );
    
    // Do not load any custom configuration file.
    CKEDITOR.replace( 'myfield', { customConfig: '' } );
    

    Defaults to "<CKEditor folder>/config.js"

  • dataIndentationChars : String

    The characters to be used for indenting HTML output produced by the editor. Using characters different from ' ' (space) and '\t' (tab) is not recommended as it will mess the code.

    // No indentation.
    CKEDITOR.config.dataIndentationChars = '';
    
    // Use two spaces for indentation.
    CKEDITOR.config.dataIndentationChars = '  ';
    

    Defaults to '\t'

  • defaultLanguage : String

    The language to be used if the language setting is left empty and it is not possible to localize the editor to the user language.

    Read more in the documentation and see the SDK sample.

    config.defaultLanguage = 'it';
    

    Defaults to 'en'

  • devtools_styles : String

    since 3.6

    A setting that stores CSS rules to be injected into the page with styles to be applied to the tooltip element.

    Read more in the documentation and see the SDK sample.

    // This is actually the default value.
    CKEDITOR.config.devtools_styles =
        '#cke_tooltip { padding: 5px; border: 2px solid #333; background: #ffffff }' +
        '#cke_tooltip h2 { font-size: 1.1em; border-bottom: 1px solid; margin: 0; padding: 1px; }' +
        '#cke_tooltip ul { padding: 0pt; list-style-type: none; }';
    

    Defaults to see example

  • devtools_textCallback : Function

    since 3.6

    A function that returns the text to be displayed inside the Developer Tools tooltip when hovering over a dialog UI element.

    Read more in the documentation and see the SDK sample.

    // This is actually the default value.
    // Show dialog window name, tab ID, and element ID.
    config.devtools_textCallback = function( editor, dialog, element, tabName ) {
        var lang = editor.lang.devtools,
            link = '<a href="https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_dialog_definition_' +
                ( element ? ( element.type == 'text' ? 'textInput' : element.type ) : 'content' ) +
                '.html" target="_blank">' + ( element ? element.type : 'content' ) + '</a>',
            str =
                '<h2>' + lang.title + '</h2>' +
                '<ul>' +
                    '<li><strong>' + lang.dialogName + '</strong> : ' + dialog.getName() + '</li>' +
                    '<li><strong>' + lang.tabName + '</strong> : ' + tabName + '</li>';
    
        if ( element )
            str += '<li><strong>' + lang.elementId + '</strong> : ' + element.id + '</li>';
    
        str += '<li><strong>' + lang.elementType + '</strong> : ' + link + '</li>';
    
        return str + '</ul>';
    };
    

    Defaults to see example

  • dialog_backgroundCoverColor : String

    The color of the dialog background cover. It should be a valid CSS color string.

    config.dialog_backgroundCoverColor = 'rgb(255, 254, 253)';
    

    Defaults to 'white'

  • dialog_backgroundCoverOpacity : Number

    The opacity of the dialog background cover. It should be a number within the range [0.0, 1.0].

    config.dialog_backgroundCoverOpacity = 0.7;
    

    Defaults to 0.5

  • dialog_buttonsOrder : String

    since 3.5

    The guideline to follow when generating the dialog buttons. There are 3 possible options:

    • 'OS' - the buttons will be displayed in the default order of the user's OS;
    • 'ltr' - for Left-To-Right order;
    • 'rtl' - for Right-To-Left order.

    Example:

    config.dialog_buttonsOrder = 'rtl';
    

    Defaults to 'OS'

  • dialog_magnetDistance : Number

    The distance of magnetic borders used in moving and resizing dialogs, measured in pixels.

    config.dialog_magnetDistance = 30;
    

    Defaults to 20

  • dialog_noConfirmCancel : Boolean

    since 4.3

    Tells if user should not be asked to confirm close, if any dialog field was modified. By default it is set to false meaning that the confirmation dialog will be shown.

    config.dialog_noConfirmCancel = true;
    

    Defaults to false

  • dialog_startupFocusTab : Boolean

    If the dialog has more than one tab, put focus into the first tab as soon as dialog is opened.

    config.dialog_startupFocusTab = true;
    

    Defaults to false

  • disableNativeSpellChecker : Boolean

    Disables the built-in spell checker if the browser provides one.

    Note: Although word suggestions provided natively by the browsers will not appear in CKEditor's default context menu, users can always reach the native context menu by holding the Ctrl key when right-clicking if browserContextMenuOnCtrl is enabled or you are simply not using the context menu plugin.

    config.disableNativeSpellChecker = false;
    

    Defaults to true

  • disableNativeTableHandles : Boolean

    Disables the "table tools" offered natively by the browser (currently Firefox only) to perform quick table editing operations, like adding or deleting rows and columns.

    config.disableNativeTableHandles = false;
    

    Defaults to true

  • disableObjectResizing : Boolean

    Disables the ability to resize objects (images and tables) in the editing area.

    config.disableObjectResizing = true;
    

    Note: Because of incomplete implementation of editing features in browsers this option does not work for inline editors (see ticket #10197), does not work in Internet Explorer 11+ (see #9317 and IE11+ issue). In Internet Explorer 8-10 this option only blocks resizing, but it is unable to hide the resize handles.

    Defaults to false

  • disableReadonlyStyling : Boolean

    since 3.5

    Disables inline styling on read-only elements.

    Defaults to false

  • disallowedContent : disallowedContentRules

    since 4.4

    Disallowed content rules. They have precedence over allowed content rules. Read more in the Disallowed Content guide.

    Read more in the documentation and see the SDK sample. See also allowedContent and extraAllowedContent.

  • div_wrapTable : Boolean

    Whether to wrap the entire table instead of individual cells when creating a <div> in a table cell.

    config.div_wrapTable = true;
    

    Defaults to false

  • docType : String

    Sets the DOCTYPE to be used when loading the editor content as HTML.

    // Set the DOCTYPE to the HTML 4 (Quirks) mode.
    config.docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">';
    

    Defaults to '<!DOCTYPE html>'

  • easyimage_class : String | null

    since 4.9.0

    A CSS class applied to all Easy Image widgets. If set to null, all <figure> elements are converted into widgets.

    // Changes the class to "my-image".
    config.easyimage_class = 'my-image';
    
    // This will cause the plugin to convert any figure into a widget.
    config.easyimage_class = null;
    

    Defaults to 'easyimage'

  • easyimage_defaultStyle : String | null

    since 4.9.0

    The default style to be applied to Easy Image widgets, based on keys in easyimage_styles.

    If set to null, no default style is applied.

    // Make side image a default style.
    config.easyimage_defaultStyle = 'side';
    

    Defaults to 'full'

  • easyimage_styles : Object.<String, Object>

    since 4.9.0

    Custom styles that could be applied to the Easy Image widget. All styles must be valid style definitions. There are three additional properties for each style definition:

    • label – A string used as a button label in the balloon toolbar for the widget.
    • icon – The path to the icon used in the balloon toolbar.
    • iconHiDpi – The path to the high DPI version of the icon.

    A few styles are available by default:

    • full – Adding an easyimage-full class to the figure element.
    • side – Adding an easyimage-side class to the figure element.
    • alignLeft – Adding an easyimage-align-left class to the figure element.
    • alignCenter – Adding an easyimage-align-center class to the figure element.
    • alignRight – Adding an easyimage-align-right class to the figure element.

    Every style added by this configuration variable will result in adding the EasyImage<name> button and the easyimage<name> command, where <name> is the name of the style in Pascal case. For example, the left style would produce an EasyImageLeft button and an easyimageLeft command.

    // Adds a custom alignment style.
    config.easyimage_styles = {
        left: {
            attributes: {
                'class': 'left'
            },
            label: 'Align left',
            icon: '/my/example/icons/left.png',
            iconHiDpi: '/my/example/icons/hidpi/left.png'
        }
    };
    

    The following example changes the class added by the full style and adds more border styles:

    config.easyimage_styles = {
        full: {
            // Changes just the class name, icon label remains unchanged.
            attributes: {
                'class': 'my-custom-full-class'
            }
        },
        skipBorder: {
            attributes: {
                'class': 'skip-border'
            },
            group: 'borders',
            label: 'Skip border'
        },
        thickBorder: {
            attributes: {
                'class': 'thick-border'
            },
            group: 'borders',
            label: 'Thick border'
        }
    };
    

    Defaults to {}

  • easyimage_toolbar : String[] | String

    since 4.9.0

    A list of buttons to be displayed in the balloon toolbar for the Easy Image widget.

    If the Context Menu plugin is enabled, this configuration option will also be used to add items to the context menu for the Easy Image widget.

    You can find the list of available styles in easyimage_styles.

    // Change toolbar to alignment commands.
    config.easyimage_toolbar = [ 'EasyImageAlignLeft', 'EasyImageAlignCenter', 'EasyImageAlignRight' ];
    

    Defaults to [ 'EasyImageFull', 'EasyImageSide', 'EasyImageAlt' ]

  • emailProtection : String

    since 3.1

    The e-mail address anti-spam protection option. The protection will be applied when creating or modifying e-mail links through the editor interface.

    Two methods of protection can be chosen:

    1. The e-mail parts (name, domain, and any other query string) are assembled into a function call pattern. Such function must be provided by the developer in the pages that will use the contents.
    2. Only the e-mail address is obfuscated into a special string that has no meaning for humans or spam bots, but which is properly rendered and accepted by the browser.

    Both approaches require JavaScript to be enabled.

    // href="mailto:tester@ckeditor.com?subject=subject&body=body"
    config.emailProtection = '';
    
    // href="<a href=\"javascript:void(location.href=\'mailto:\'+String.fromCharCode(116,101,115,116,101,114,64,99,107,101,100,105,116,111,114,46,99,111,109)+\'?subject=subject&body=body\')\">e-mail</a>"
    config.emailProtection = 'encode';
    
    // href="javascript:mt('tester','ckeditor.com','subject','body')"
    config.emailProtection = 'mt(NAME,DOMAIN,SUBJECT,BODY)';
    

    Defaults to '' (empty string = disabled)

  • embed_provider : String

    since 4.5

    A template for the URL of the provider endpoint. This URL will be queried for each resource to be embedded.

    It uses the following parameters:

    • url – The URL of the requested media, e.g. https://twitter.com/ckeditor/status/401373919157821441.
    • callback – The name of the globally available callback used for JSONP requests.

    For example:

    config.embed_provider = '//example.com/api/oembed-proxy?resource-url={url}&callback={callback}';
    

    By default CKEditor does not use any provider, although there is a ready-to-use URL available via Iframely:

    config.embed_provider = '//ckeditor.iframe.ly/api/oembed?url={url}&callback={callback}'
    

    However, this endpoint contains certain limitations, e.g. it cannot embed Google Maps content. It is recommended to set up an account on the Iframely service for better control over embedded content.

    Read more in the documentation and see the SDK sample.

    Refer to CKEDITOR.plugins.embedBase.baseDefinition.providerUrl for more information about content providers.

    Important note: Prior to version 4.7 this configuration option defaulted to the //ckeditor.iframe.ly/api/oembed?url={url}&callback={callback} string.

    Defaults to ''

  • emoji_emojiListUrl : String

    since 4.10.0

    Address of the JSON file containing the emoji list. The file is downloaded through the CKEDITOR.ajax.load method and the URL address is processed by CKEDITOR.getUrl. Emoji list has to be an array of objects with the id and symbol properties. These keys represent the text to match and the UTF symbol for its replacement. An emoji has to start with the : (colon) symbol.

    [
        {
            "id": ":grinning_face:",
            "symbol":"😀"
        },
        {
            "id": ":bug:",
            "symbol":"🐛"
        },
        {
            "id": ":star:",
            "symbol":"⭐"
        }
    ]
    
        editor.emoji_emojiListUrl = 'https://my.custom.domain/ckeditor/emoji.json';
    

    Defaults to 'plugins/emoji/emoji.json'

  • emoji_minChars : Number

    since 4.10.0

    A number that defines how many characters are required to start displaying emoji's autocomplete suggestion box. Delimiter :, which activates the emoji suggestion box, is not included in this value.

        editor.emoji_minChars = 0; // Emoji suggestion box appears after typing ':'.
    

    Defaults to 2

  • enableContextMenu : Boolean

    since 4.7.0

    Whether to enable the context menu. Regardless of the setting the Context Menu plugin is still loaded.

    config.enableContextMenu = false;
    

    Defaults to true

  • enableTabKeyTools : Boolean

    Allow context-sensitive Tab key behaviors, including the following scenarios:

    When selection is anchored inside table cells:

    • If Tab is pressed, select the content of the "next" cell. If in the last cell in the table, add a new row to it and focus its first cell.
    • If Shift+Tab is pressed, select the content of the "previous" cell. Do nothing when it is in the first cell.

    Example:

    config.enableTabKeyTools = false;
    

    Defaults to true

  • enterMode : Number

    Sets the behavior of the Enter key. It also determines other behavior rules of the editor, like whether the <br> element is to be used as a paragraph separator when indenting text. The allowed values are the following constants that cause the behavior outlined below:

    Note: It is recommended to use the CKEDITOR.ENTER_P setting because of its semantic value and correctness. The editor is optimized for this setting.

    Read more in the documentation and see the SDK sample.

    // Not recommended.
    config.enterMode = CKEDITOR.ENTER_BR;
    

    Defaults to CKEDITOR.ENTER_P

  • entities : Boolean

    Whether to use HTML entities in the editor output.

    config.entities = false;
    

    Defaults to true

  • entities_additional : String

    A comma-separated list of additional entities to be used. Entity names or numbers must be used in a form that excludes the '&amp;' prefix and the ';' ending.

    config.entities_additional = '#1049'; // Adds Cyrillic capital letter Short I (Й).
    

    Defaults to '#39' (The single quote (') character)

  • entities_greek : Boolean

    Whether to convert some symbols, mathematical symbols, and Greek letters to HTML entities. This may be more relevant for users typing text written in Greek. The list of entities can be found in the W3C HTML 4.01 Specification, section 24.3.1.

    config.entities_greek = false;
    

    Defaults to true

  • entities_latin : Boolean

    Whether to convert some Latin characters (Latin alphabet No. 1, ISO 8859-1) to HTML entities. The list of entities can be found in the W3C HTML 4.01 Specification, section 24.2.1.

    config.entities_latin = false;
    

    Defaults to true

  • entities_processNumerical : Boolean | String

    Whether to convert all remaining characters not included in the ASCII character table to their relative decimal numeric representation of HTML entity. When set to force, it will convert all entities into this format.

    For example the phrase: 'This is Chinese: 汉语.' would be output as: 'This is Chinese: &#27721;&#35821;.'

    config.entities_processNumerical = true;
    config.entities_processNumerical = 'force'; // Converts from '&nbsp;' into '&#160;';
    

    Defaults to false

  • extraAllowedContent : Object | String

    since 4.1

    This option makes it possible to set additional allowed content rules for CKEDITOR.editor.filter.

    It is especially useful in combination with the default allowedContent value:

    CKEDITOR.replace( 'textarea_id', {
        plugins: 'wysiwygarea,toolbar,format',
        extraAllowedContent: 'b i',
        on: {
            instanceReady: function( evt ) {
                var editor = evt.editor;
    
                editor.filter.check( 'h1' ); // -> true (thanks to Format combo)
                editor.filter.check( 'b' ); // -> true (thanks to extraAllowedContent)
                editor.setData( '<h1><i>Foo</i></h1><p class="left"><b>Bar</b> <a href="http://foo.bar">foo</a></p>' );
                // Editor contents will be:
                '<h1><i>Foo</i></h1><p><b>Bar</b> foo</p>'
            }
        }
    } );
    

    Read more in the documentation and see the SDK sample. See also allowedContent for more details.

  • extraPlugins : String | String[]

    A list of additional plugins to be loaded. This setting makes it easier to add new plugins without having to touch the plugins setting.

    Note: The most recommended way to add CKEditor plugins is through CKEditor Builder. Read more in the documentation.

    config.extraPlugins = 'myplugin,anotherplugin';
    

    Defaults to ''

  • fileTools_defaultFileName : String

    since 4.5.3

    The default file name (without extension) that will be used for files created from a Base64 data string (for example for files pasted into the editor). This name will be combined with the MIME type to create the full file name with the extension.

    If fileTools_defaultFileName is set to default-name and data's MIME type is image/png, the resulting file name will be default-name.png.

    If fileTools_defaultFileName is not set, the file name will be created using only its MIME type. For example for image/png the file name will be image.png.

    Defaults to ''

  • fileTools_requestHeaders : Object

    since 4.9.0

    Allows to add extra headers for every request made using the CKEDITOR.fileTools API.

    Note that headers can still be customized per a single request, using the fileUploadRequest event.

    config.fileTools_requestHeaders = {
        'X-Requested-With': 'XMLHttpRequest',
        'Custom-Header': 'header value'
    };
    
  • filebrowserBrowseUrl : String

    since 3.0

    The location of an external file manager that should be launched when the Browse Server button is pressed. If configured, the Browse Server button will appear in the Link, Image, and Flash dialog windows.

    Read more in the documentation and see the SDK sample.

    config.filebrowserBrowseUrl = '/browser/browse.php';
    

    Defaults to '' (empty string = disabled)

  • filebrowserFlashBrowseUrl : String

    since 3.0

    The location of an external file browser that should be launched when the Browse Server button is pressed in the Flash dialog window.

    If not set, CKEditor will use filebrowserBrowseUrl.

    Read more in the documentation and see the SDK sample.

    config.filebrowserFlashBrowseUrl = '/browser/browse.php?type=Flash';
    

    Defaults to '' (empty string = disabled)

  • filebrowserFlashUploadUrl : String

    since 3.0

    The location of the script that handles file uploads in the Flash dialog window.

    If not set, CKEditor will use filebrowserUploadUrl.

    Read more in the documentation and see the SDK sample.

    config.filebrowserFlashUploadUrl = '/uploader/upload.php?type=Flash';(empty string = disabled)]
    

    Defaults to ''

  • filebrowserImageBrowseLinkUrl : String

    since 3.2

    The location of an external file manager that should be launched when the Browse Server button is pressed in the Link tab of the Image dialog window.

    If not set, CKEditor will use filebrowserBrowseUrl.

    Read more in the documentation and see the SDK sample.

    config.filebrowserImageBrowseLinkUrl = '/browser/browse.php';
    

    Defaults to '' (empty string = disabled)

  • filebrowserImageBrowseUrl : String

    since 3.0

    The location of an external file manager that should be launched when the Browse Server button is pressed in the Image dialog window.

    If not set, CKEditor will use filebrowserBrowseUrl.

    Read more in the documentation and see the SDK sample.

    config.filebrowserImageBrowseUrl = '/browser/browse.php?type=Images';
    

    Defaults to '' (empty string = disabled)

  • filebrowserImageUploadUrl : String

    since 3.0

    The location of the script that handles file uploads in the Image dialog window.

    If not set, CKEditor will use filebrowserUploadUrl.

    Read more in the documentation and see the SDK sample.

    config.filebrowserImageUploadUrl = '/uploader/upload.php?type=Images';
    

    Note: This is a configuration setting for a file browser/uploader. To configure uploading dropped or pasted files use the uploadUrl or imageUploadUrl configuration option.

    Defaults to '' (empty string = disabled)

  • filebrowserUploadMethod : String

    since 4.9.0

    Defines a preferred option for file uploading in the File Browser plugin.

    Available values:

    • 'xhr' – XMLHttpRequest is used to upload the file. Using this option allows to set additional XHR headers with the fileTools_requestHeaders option.
    • 'form' – The file is uploaded by submitting a traditional <form> element. Note: That was the only option available until CKEditor 4.9.0.

    Example:

    // All browsers will use a plain form element to upload the file.
    config.filebrowserUploadMethod = 'form';
    

    Defaults to 'xhr'

  • filebrowserUploadUrl : String

    since 3.0

    The location of the script that handles file uploads. If set, the Upload tab will appear in the Link, Image, and Flash dialog windows.

    Read more in the documentation and see the SDK sample.

    config.filebrowserUploadUrl = '/uploader/upload.php';
    

    Note: This is a configuration setting for a file browser/uploader. To configure uploading dropped or pasted files use the uploadUrl configuration option.

    Defaults to '' (empty string = disabled)

  • filebrowserWindowFeatures : String

    since 3.4.1

    The features to use in the file manager popup window.

    config.filebrowserWindowFeatures = 'resizable=yes,scrollbars=no';
    

    Defaults to 'location=no,menubar=no,toolbar=no,dependent=yes,minimizable=no,modal=yes,alwaysRaised=yes,resizable=yes,scrollbars=yes'

  • filebrowserWindowHeight : Number | String

    The height of the file manager popup window. It can be a number denoting a value in pixels or a percent string.

    Read more in the documentation and see the SDK sample.

    config.filebrowserWindowHeight = 580;
    
    config.filebrowserWindowHeight = '50%';
    

    Defaults to '70%'

  • filebrowserWindowWidth : Number | String

    The width of the file manager popup window. It can be a number denoting a value in pixels or a percent string.

    Read more in the documentation and see the SDK sample.

    config.filebrowserWindowWidth = 750;
    
    config.filebrowserWindowWidth = '50%';
    

    Defaults to '80%'

  • fillEmptyBlocks : Boolean | Function

    since 3.5

    Whether a filler text (non-breaking space entity — &nbsp;) will be inserted into empty block elements in HTML output. This is used to render block elements properly with line-height. When a function is specified instead, it will be passed a CKEDITOR.htmlParser.element to decide whether adding the filler text by expecting a Boolean return value.

    config.fillEmptyBlocks = false; // Prevent filler nodes in all empty blocks.
    
    // Prevent filler node only in float cleaners.
    config.fillEmptyBlocks = function( element ) {
        if ( element.attributes[ 'class' ].indexOf( 'clear-both' ) != -1 )
            return false;
    };
    

    Defaults to true

  • find_highlight : Object

    Defines the style to be used to highlight results with the find dialog.

    // Highlight search results with blue on yellow.
    config.find_highlight = {
        element: 'span',
        styles: { 'background-color': '#ff0', color: '#00f' }
    };
    

    Defaults to {element: 'span', styles: {'background-color': '#004', color: '#fff'}}

  • flashAddEmbedTag : Boolean

    Add <embed> tag as alternative: <object><embed></embed></object>.

    Defaults to false

  • flashConvertOnEdit : Boolean

    Use flashEmbedTagOnly and flashAddEmbedTag values on edit.

    Defaults to false

  • flashEmbedTagOnly : Boolean

    Save as <embed> tag only. This tag is unrecommended.

    Defaults to false

  • floatSpaceDockedOffsetX : Number

    Along with floatSpaceDockedOffsetY it defines the amount of offset (in pixels) between the float space and the editable left/right boundaries when the space element is docked on either side of the editable.

    config.floatSpaceDockedOffsetX = 10;
    

    Defaults to 0

  • floatSpaceDockedOffsetY : Number

    Along with floatSpaceDockedOffsetX it defines the amount of offset (in pixels) between the float space and the editable top/bottom boundaries when the space element is docked on either side of the editable.

    config.floatSpaceDockedOffsetY = 10;
    

    Defaults to 0

  • floatSpacePinnedOffsetX : Number

    Along with floatSpacePinnedOffsetY it defines the amount of offset (in pixels) between the float space and the viewport boundaries when the space element is pinned.

    config.floatSpacePinnedOffsetX = 20;
    

    Defaults to 0

  • floatSpacePinnedOffsetY : Number

    Along with floatSpacePinnedOffsetX it defines the amount of offset (in pixels) between the float space and the viewport boundaries when the space element is pinned.

    config.floatSpacePinnedOffsetY = 20;
    

    Defaults to 0

  • floatSpacePreferRight : Boolean

    since 4.5

    Indicates that the float space should be aligned to the right side of the editable area rather than to the left (if possible).

    config.floatSpacePreferRight = true;
    

    Defaults to false

  • fontSize_defaultLabel : String

    The text to be displayed in the Font Size combo is none of the available values matches the current cursor position or text selection.

    // If the default site font size is 12px, we may making it more explicit to the end user.
    config.fontSize_defaultLabel = '12px';
    

    Defaults to ''

  • fontSize_sizes : String

    The list of fonts size to be displayed in the Font Size combo in the toolbar. Entries are separated by semi-colons (';').

    Any kind of "CSS like" size can be used, like '12px', '2.3em', '130%', 'larger' or 'x-small'.

    A display name may be optionally defined by prefixing the entries with the name and the slash character. For example, 'Bigger Font/14px' will be displayed as 'Bigger Font' in the list, but will be outputted as '14px'.

    config.fontSize_sizes = '16/16px;24/24px;48/48px;';
    
    config.fontSize_sizes = '12px;2.3em;130%;larger;x-small';
    
    config.fontSize_sizes = '12 Pixels/12px;Big/2.3em;30 Percent More/130%;Bigger/larger;Very Small/x-small';
    

    Defaults to see source

  • fontSize_style : Object

    The style definition to be used to apply the font size in the text.

    // This is actually the default value for it.
    config.fontSize_style = {
        element:        'span',
        styles:         { 'font-size': '#(size)' },
        overrides:      [ { element: 'font', attributes: { 'size': null } } ]
    };
    

    Defaults to see example

  • font_defaultLabel : String

    The text to be displayed in the Font combo is none of the available values matches the current cursor position or text selection.

    // If the default site font is Arial, we may making it more explicit to the end user.
    config.font_defaultLabel = 'Arial';
    

    Defaults to ''

  • font_names : String

    The list of fonts names to be displayed in the Font combo in the toolbar. Entries are separated by semi-colons (';'), while it's possible to have more than one font for each entry, in the HTML way (separated by comma).

    A display name may be optionally defined by prefixing the entries with the name and the slash character. For example, 'Arial/Arial, Helvetica, sans-serif' will be displayed as 'Arial' in the list, but will be outputted as 'Arial, Helvetica, sans-serif'.

    config.font_names =
        'Arial/Arial, Helvetica, sans-serif;' +
        'Times New Roman/Times New Roman, Times, serif;' +
        'Verdana';
    
    config.font_names = 'Arial;Times New Roman;Verdana';
    

    Defaults to see source

  • font_style : Object

    The style definition to be used to apply the font in the text.

    // This is actually the default value for it.
    config.font_style = {
        element:        'span',
        styles:         { 'font-family': '#(family)' },
        overrides:      [ { element: 'font', attributes: { 'face': null } } ]
    };
    

    Defaults to see example

  • forceEnterMode : Boolean

    since 3.2.1

    Forces the use of enterMode as line break regardless of the context. If, for example, enterMode is set to CKEDITOR.ENTER_P, pressing the Enter key inside a <div> element will create a new paragraph with a <p> instead of a <div>.

    Read more in the documentation and see the SDK sample.

    // Not recommended.
    config.forceEnterMode = true;
    

    Defaults to false

  • forcePasteAsPlainText : Boolean | String

    Whether to force all pasting operations to insert plain text into the editor, losing any formatting information possibly available in the source text.

    This option accepts the following settings:

    • true – Pastes all content as plain text.
    • false – Preserves content formatting.
    • allow-word – Content pasted from Microsoft Word will keep its formatting while any other content will be pasted as plain text.

    Example:

    // All content will be pasted as plain text.
    config.forcePasteAsPlainText = true;
    
    // Only Microsoft Word content formatting will be preserved.
        config.forcePasteAsPlainText = 'allow-word';
    

    Defaults to false

  • forceSimpleAmpersand : Boolean

    Whether to force using '&' instead of '&amp;' in element attributes values. It is not recommended to change this setting for compliance with the W3C XHTML 1.0 standards (C.12, XHTML 1.0).

    // Use `'&'` instead of `'&amp;'`
    CKEDITOR.config.forceSimpleAmpersand = true;
    

    Defaults to false

  • format_address : Object

    The style definition to be used to apply the Address format.

    Read more in the documentation and see the SDK sample.

    config.format_address = { element: 'address', attributes: { 'class': 'styledAddress' } };
    

    Defaults to { element: 'address' }

  • format_div : Object

    The style definition to be used to apply the Normal (DIV) format.

    Read more in the documentation and see the SDK sample.

    config.format_div = { element: 'div', attributes: { 'class': 'normalDiv' } };
    

    Defaults to { element: 'div' }

  • format_h1 : Object

    The style definition to be used to apply the Heading 1 format.

    Read more in the documentation and see the SDK sample.

    config.format_h1 = { element: 'h1', attributes: { 'class': 'contentTitle1' } };
    

    Defaults to { element: 'h1' }

  • format_h2 : Object

    The style definition to be used to apply the Heading 2 format.

    Read more in the documentation and see the SDK sample.

    config.format_h2 = { element: 'h2', attributes: { 'class': 'contentTitle2' } };
    

    Defaults to { element: 'h2' }

  • format_h3 : Object

    The style definition to be used to apply the Heading 3 format.

    Read more in the documentation and see the SDK sample.

    config.format_h3 = { element: 'h3', attributes: { 'class': 'contentTitle3' } };
    

    Defaults to { element: 'h3' }

  • format_h4 : Object

    The style definition to be used to apply the Heading 4 format.

    Read more in the documentation and see the SDK sample.

    config.format_h4 = { element: 'h4', attributes: { 'class': 'contentTitle4' } };
    

    Defaults to { element: 'h4' }

  • format_h5 : Object

    The style definition to be used to apply the Heading 5 format.

    Read more in the documentation and see the SDK sample.

    config.format_h5 = { element: 'h5', attributes: { 'class': 'contentTitle5' } };
    

    Defaults to { element: 'h5' }

  • format_h6 : Object

    The style definition to be used to apply the Heading 6 format.

    Read more in the documentation and see the SDK sample.

    config.format_h6 = { element: 'h6', attributes: { 'class': 'contentTitle6' } };
    

    Defaults to { element: 'h6' }

  • format_p : Object

    The style definition to be used to apply the Normal format.

    Read more in the documentation and see the SDK sample.

    config.format_p = { element: 'p', attributes: { 'class': 'normalPara' } };
    

    Defaults to { element: 'p' }

  • format_pre : Object

    The style definition to be used to apply the Formatted format.

    Read more in the documentation and see the SDK sample.

    config.format_pre = { element: 'pre', attributes: { 'class': 'code' } };
    

    Defaults to { element: 'pre' }

  • format_tags : String

    A list of semicolon-separated style names (by default: tags) representing the style definition for each entry to be displayed in the Format drop-down list in the toolbar. Each entry must have a corresponding configuration in a setting named 'format_(tagName)'. For example, the 'p' entry has its definition taken from config.format_p.

    Read more in the documentation and see the SDK sample.

    config.format_tags = 'p;h2;h3;pre';
    

    Defaults to 'p;h1;h2;h3;h4;h5;h6;pre;address;div'

  • fullPage : Boolean

    since 3.1

    Indicates whether the content to be edited is being input as a full HTML page. A full page includes the <html>, <head>, and <body> elements. The final output will also reflect this setting, including the <body> content only if this setting is disabled.

    Read more in the documentation and see the SDK sample.

    config.fullPage = true;
    

    Defaults to false

  • grayt_autoStartup : Boolean

    since 4.5.6

    Enables Grammar As You Type (GRAYT) on SCAYT startup. When set to true, this option turns on GRAYT automatically after SCAYT started.

    Read more in the documentation and see the SDK sample.

    config.grayt_autoStartup = true;
    

    Defaults to false

  • height : Number | String

    The height of the editing area that includes the editor content. This configuration option accepts an integer (to denote a value in pixels) or any CSS-defined length unit except percent (%) values which are not supported.

    Note: This configuration option is ignored by inline editor.

    Read more in the documentation and see the SDK sample.

    config.height = 500;        // 500 pixels.
    config.height = '25em';     // CSS length.
    config.height = '300px';    // CSS length.
    

    Defaults to 200

  • htmlEncodeOutput : Boolean

    since 3.1

    Whether to escape HTML when the editor updates the original input element.

    config.htmlEncodeOutput = true;
    

    Defaults to false

  • ignoreEmptyParagraph : Boolean

    Whether the editor must output an empty value ('') if its content only consists of an empty paragraph.

    config.ignoreEmptyParagraph = false;
    

    Defaults to true

  • image2_alignClasses : String[]

    since 4.4

    CSS classes applied to aligned images. Useful to take control over the way the images are aligned, i.e. to customize output HTML and integrate external stylesheets.

    Classes should be defined in an array of three elements, containing left, center, and right alignment classes, respectively. For example:

    config.image2_alignClasses = [ 'align-left', 'align-center', 'align-right' ];
    

    Note: Once this configuration option is set, the plugin will no longer produce inline styles for alignment. It means that e.g. the following HTML will be produced:

    <img alt="My image" class="custom-center-class" src="foo.png" />
    

    instead of:

    <img alt="My image" style="float:left" src="foo.png" />
    

    Note: Once this configuration option is set, corresponding style definitions must be supplied to the editor:

    • For classic editor it can be done by defining additional styles in the stylesheets loaded by the editor. The same styles must be provided on the target page where the content will be loaded.
    • For inline editor the styles can be defined directly with <style> ... <style> or <link href="..." rel="stylesheet">, i.e. within the <head> of the page.

    For example, considering the following configuration:

    config.image2_alignClasses = [ 'align-left', 'align-center', 'align-right' ];
    

    CSS rules can be defined as follows:

    .align-left {
        float: left;
    }
    
    .align-right {
        float: right;
    }
    
    .align-center {
        text-align: center;
    }
    
    .align-center > figure {
        display: inline-block;
    }
    

    Read more in the documentation and see the SDK sample.

    Defaults to null

  • image2_altRequired : Boolean

    since 4.6.0

    Determines whether alternative text is required for the captioned image.

    config.image2_altRequired = true;
    

    Read more in the documentation and see the SDK sample.

    Defaults to false

  • image2_captionedClass : String

    A CSS class applied to the <figure> element of a captioned image.

    Read more in the documentation and see the SDK sample.

    // Changes the class to "captionedImage".
    config.image2_captionedClass = 'captionedImage';
    

    Defaults to 'image'

  • image2_disableResizer : Boolean

    since 4.5

    Disables the image resizer. By default the resizer is enabled.

    Read more in the documentation and see the SDK sample.

    config.image2_disableResizer = true;
    

    Defaults to false

  • image2_prefillDimensions : Boolean

    since 4.5

    Determines whether dimension inputs should be automatically filled when the image URL changes in the Enhanced Image plugin dialog window.

    Read more in the documentation and see the SDK sample.

    config.image2_prefillDimensions = false;
    

    Defaults to true

  • imageUploadUrl : String

    since 4.5

    The URL where images should be uploaded.

    Defaults to '' (empty string = disabled)

  • image_prefillDimensions : Boolean

    since 4.5

    Determines whether dimension inputs should be automatically filled when the image URL changes in the Image plugin dialog window.

    config.image_prefillDimensions = false;
    

    Defaults to true

  • image_previewText : String

    Padding text to set off the image in the preview area.

    config.image_previewText = CKEDITOR.tools.repeat( '___ ', 100 );
    

    Defaults to 'Lorem ipsum dolor...' (placeholder text)

  • image_removeLinkByEmptyURL : Boolean

    Whether to remove links when emptying the link URL field in the Image dialog window.

    config.image_removeLinkByEmptyURL = false;
    

    Defaults to true

  • indentClasses : Array

    A list of classes to use for indenting the contents. If set to null, no classes will be used and instead the indentUnit and indentOffset properties will be used.

    // Use the 'Indent1', 'Indent2', 'Indent3' classes.
    config.indentClasses = ['Indent1', 'Indent2', 'Indent3'];
    

    Defaults to null

  • indentOffset : Number

    The size in indentation units of each indentation step.

    config.indentOffset = 4;
    

    Defaults to 40

  • indentUnit : String

    The unit used for indentation offset.

    config.indentUnit = 'em';
    

    Defaults to 'px'

  • jqueryOverrideVal : Boolean

    Allows CKEditor to override jQuery.fn.val(). When set to true, the val() function used on textarea elements replaced with CKEditor uses the CKEditor API.

    This configuration option is global and is executed during the loading of the jQuery Adapter. It cannot be customized across editor instances.

    Read more in the documentation.

    <script>
        CKEDITOR.config.jqueryOverrideVal = true;
    </script>
    
    <!-- Important: The jQuery Adapter is loaded *after* setting jqueryOverrideVal. -->
    <script src="/ckeditor/adapters/jquery.js"></script>
    
    <script>
        $( 'textarea' ).ckeditor();
        // ...
        $( 'textarea' ).val( 'New content' );
    </script>
    

    Defaults to true

  • justifyClasses : Array

    List of classes to use for aligning the contents. If it's null, no classes will be used and instead the corresponding CSS values will be used.

    The array should contain 4 members, in the following order: left, center, right, justify.

    // Use the classes 'AlignLeft', 'AlignCenter', 'AlignRight', 'AlignJustify'
    config.justifyClasses = [ 'AlignLeft', 'AlignCenter', 'AlignRight', 'AlignJustify' ];
    

    Defaults to null

  • keystrokes : Array

    A list associating keystrokes with editor commands. Each element in the list is an array where the first item is the keystroke, and the second is the name of the command to be executed.

    This setting should be used to define (as well as to overwrite or remove) keystrokes set by plugins (like link and basicstyles). If you want to set a keystroke for your plugin or during the runtime, use CKEDITOR.editor.setKeystroke instead.

    Since default keystrokes are set by the CKEDITOR.editor.setKeystroke method, by default config.keystrokes is an empty array.

    See CKEDITOR.editor.setKeystroke documentation for more details regarding the start up order.

    // Change default Ctrl+L keystroke for 'link' command to Ctrl+Shift+L.
    config.keystrokes = [
        ...
        [ CKEDITOR.CTRL + CKEDITOR.SHIFT + 76, 'link' ],    // Ctrl+Shift+L
        ...
    ];
    

    To reset a particular keystroke, the following approach can be used:

    // Disable default Ctrl+L keystroke which executes the 'link' command by default.
    config.keystrokes = [
        ...
        [ CKEDITOR.CTRL + 76, null ],                       // Ctrl+L
        ...
    ];
    

    In order to reset all default keystrokes, a CKEDITOR.instanceReady callback should be used. This is since editor defaults are merged rather than overwritten by user keystrokes.

    Note: This can be potentially harmful for the editor. Avoid this unless you are aware of the consequences.

    // Reset all default keystrokes.
    config.on.instanceReady = function() {
        this.keystrokeHandler.keystrokes = [];
    };
    

    Defaults to []

  • language : String

    The user interface language localization to use. If left empty, the editor will automatically be localized to the user language. If the user language is not supported, the language specified in the defaultLanguage configuration setting is used.

    Read more in the documentation and see the SDK sample.

    // Load the German interface.
    config.language = 'de';
    

    Defaults to ''

  • language_list : Array

    Specifies the list of languages available in the Language plugin. Each entry should be a string in the following format:

    <languageCode>:<languageLabel>[:<textDirection>]
    
    • languageCode: The language code used for the lang attribute in ISO 639 format. Language codes can be found here. You can use both 2-letter ISO-639-1 codes and 3-letter ISO-639-2 codes, though for consistency it is recommended to stick to ISO-639-1 2-letter codes.
    • languageLabel: The label to show for this language in the list.
    • textDirection: (optional) One of the following values: rtl or ltr, indicating the reading direction of the language. Defaults to ltr.

    See the SDK sample.

    config.language_list = [ 'he:Hebrew:rtl', 'pt:Portuguese', 'de:German' ];
    

    Defaults to [ 'ar:Arabic:rtl', 'fr:French', 'es:Spanish' ]

  • linkJavaScriptLinksAllowed : Boolean

    since 4.4.1

    Whether JavaScript code is allowed as a href attribute in an anchor tag. With this option enabled it is possible to create links like:

    <a href="javascript:alert('Hello world!')">hello world</a>
    

    By default JavaScript links are not allowed and will not pass the Link dialog window validation.

    Defaults to false

  • linkPhoneMsg : String

    since 4.11.0

    Optional message for the alert popup used when the phone number in the Link dialog does not pass the validation.

    config.linkPhoneMsg = "Invalid number";
    
  • linkPhoneRegExp : RegExp

    since 4.11.0

    Optional JavaScript regular expression used whenever phone numbers in the Link dialog should be validated.

    config.linkPhoneRegExp = /^[0-9]{9}$/;
    
  • linkShowAdvancedTab : Boolean

    Whether to show the Advanced tab in the Link dialog window.

    Defaults to true

  • linkShowTargetTab : Boolean

    Whether to show the Target tab in the Link dialog window.

    Defaults to true

  • magicline_color : String

    Defines the color of the magic line. The color may be adjusted to enhance readability.

    Read more in the documentation and see the SDK sample.

    // Changes magic line color to blue.
    CKEDITOR.config.magicline_color = '#0000FF';
    

    Defaults to '#FF0000'

  • magicline_everywhere : Boolean

    Activates the special all-encompassing mode that considers all focus spaces between CKEDITOR.dtd.$block elements as accessible by the magic line.

    Read more in the documentation and see the SDK sample.

    // Enables the greedy "put everywhere" mode.
    CKEDITOR.config.magicline_everywhere = true;
    

    Defaults to false

  • magicline_holdDistance : Number

    Defines the distance between the mouse pointer and the box within which the magic line stays revealed and no other focus space is offered to be accessed. This value is relative to magicline_triggerOffset.

    Read more in the documentation and see the SDK sample.

    // Increases the distance to 80% of CKEDITOR.config.magicline_triggerOffset.
    CKEDITOR.config.magicline_holdDistance = .8;CKEDITOR.config.magicline_triggerOffset
    

    Defaults to 0.5

  • magicline_keystrokeNext : Number

    Defines the default keystroke that accesses the closest unreachable focus space after the caret (start of the selection). If there is no focus space available, the selection remains unchanged.

    Read more in the documentation and see the SDK sample.

    // Changes keystroke to "Ctrl + .".
    CKEDITOR.config.magicline_keystrokeNext = CKEDITOR.CTRL + 190;
    

    Defaults to CKEDITOR.CTRL + CKEDITOR.SHIFT + 52 (CTRL + SHIFT + 4)

  • magicline_keystrokePrevious : Number

    Defines the default keystroke that accesses the closest unreachable focus space before the caret (start of the selection). If there is no focus space available, the selection remains unchanged.

    Read more in the documentation and see the SDK sample.

    // Changes the default keystroke to "Ctrl + ,".
    CKEDITOR.config.magicline_keystrokePrevious = CKEDITOR.CTRL + 188;
    

    Defaults to CKEDITOR.CTRL + CKEDITOR.SHIFT + 51 (CTRL + SHIFT + 3)

  • magicline_tabuList : Number

    Defines a list of attributes that, if assigned to some elements, prevent the magic line from being used within these elements.

    Read more in the documentation and see the SDK sample.

    // Adds the "data-tabu" attribute to the magic line tabu list.
    CKEDITOR.config.magicline_tabuList = [ 'data-tabu' ];
    

    Defaults to [ 'data-widget-wrapper' ]

  • magicline_triggerOffset : Number

    Sets the default vertical distance between the edge of the element and the mouse pointer that causes the magic line to appear. This option accepts a value in pixels, without the unit (for example: 15 for 15 pixels).

    Read more in the documentation and see the SDK sample.

    // Changes the offset to 15px.
    CKEDITOR.config.magicline_triggerOffset = 15;CKEDITOR.config.magicline_holdDistance
    

    Defaults to 30

  • mathJaxClass : String

    Sets the default class for span elements that will be converted into Mathematical Formulas widgets.

    If you set it to the following:

    config.mathJaxClass = 'my-math';
    

    The code below will be recognized as a Mathematical Formulas widget.

    <span class="my-math">\( \sqrt{4} = 2 \)</span>
    

    Read more in the documentation and see the SDK sample.

    Defaults to 'math-tex'

  • mathJaxLib : String

    since 4.3

    Sets the path to the MathJax library. It can be both a local resource and a location different than the default CDN.

    Please note that this must be a full or absolute path.

    Read more in the documentation and see the SDK sample.

    config.mathJaxLib = '//cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS_HTML';
    

    Note: Since CKEditor 4.5 this option does not have a default value, so it must be set in order to enable the MathJax plugin.

  • mentions : configDefinition[]

    since 4.10.0

    A list of mentions configuration objects.

    For each configuration object a new mentions plugin instance will be created and attached to the editor.

    config.mentions = [
        { feed: [ 'Anna', 'Thomas', 'Jack' ], minChars: 0 },
        { feed: backendApiFunction, marker: '#' },
        { feed: '/users?query={encodedQuery}', marker: '$' }
    ];
    
  • menu_groups : String

    A comma separated list of items group names to be displayed in the context menu. The order of items will reflect the order specified in this list if no priority was defined in the groups.

    config.menu_groups = 'clipboard,table,anchor,link,image';
    

    Defaults to see source

  • menu_subMenuDelay : Number

    The amount of time, in milliseconds, the editor waits before displaying submenu options when moving the mouse over options that contain submenus, like the "Cell Properties" entry for tables.

    // Remove the submenu delay.
    config.menu_subMenuDelay = 0;
    

    Defaults to 400

  • newpage_html : String

    The HTML to load in the editor when the "new page" command is executed.

    config.newpage_html = '<p>Type your text here.</p>';
    

    Defaults to ''

  • notification_duration : Number

    since 4.5

    After how many milliseconds the notification of the info and success type should close automatically. 0 means that notifications will not close automatically. Note that warning and progress notifications will never close automatically.

    Refer to the Notifications article for more information about this feature.

    Defaults to 5000

  • on : Object

    Sets listeners on editor events.

    Note: This property can only be set in the config object passed directly to CKEDITOR.replace, CKEDITOR.inline, and other creators.

    CKEDITOR.replace( 'editor1', {
        on: {
            instanceReady: function() {
                alert( this.name ); // 'editor1'
            },
    
            key: function() {
                // ...
            }
        }
    } );
    
  • pasteFilter : String

    since 4.5

    Defines a filter which is applied to external data pasted or dropped into the editor. Possible values are:

    • 'plain-text' – Content will be pasted as a plain text.
    • 'semantic-content' – Known tags (except div, span) with all attributes (except style and class) will be kept.
    • 'h1 h2 p div' – Custom rules compatible with CKEDITOR.filter.
    • null – Content will not be filtered by the paste filter (but it still may be filtered by Advanced Content Filter). This value can be used to disable the paste filter in Chrome and Safari, where this option defaults to 'semantic-content'.

    Example:

    config.pasteFilter = 'plain-text';
    

    Custom setting:

    config.pasteFilter = 'h1 h2 p ul ol li; img[!src, alt]; a[!href]';
    

    Based on this configuration option, a proper CKEDITOR.filter instance will be defined and assigned to the editor as a CKEDITOR.editor.pasteFilter. You can tweak the paste filter settings on the fly on this object as well as delete or replace it.

    var editor = CKEDITOR.replace( 'editor', {
        pasteFilter: 'semantic-content'
    } );
    
    editor.on( 'instanceReady', function() {
        // The result of this will be that all semantic content will be preserved
        // except tables.
        editor.pasteFilter.disallow( 'table' );
    } );
    

    Note that the paste filter is applied only to external data. There are three data sources:

    • copied and pasted in the same editor (internal),
    • copied from one editor and pasted into another (cross-editor),
    • coming from all other sources like websites, MS Word, etc. (external).

    If Advanced Content Filter is not disabled, then it will also be applied to pasted and dropped data. The paste filter job is to "normalize" external data which often needs to be handled differently than content produced by the editor.

    This setting defaults to 'semantic-content' in Chrome, Opera and Safari (all Blink and Webkit based browsers) due to messy HTML which these browsers keep in the clipboard. In other browsers it defaults to null.

    Defaults to 'semantic-content' in Chrome and Safari and `null` in other browsers

  • pasteFromWordCleanupFile : String

    since 3.1

    The file that provides the Microsoft Word cleanup function for pasting operations.

    Note: This is a global configuration shared by all editor instances present on the page.

    // Load from the 'pastefromword' plugin 'filter' sub folder (custom.js file) using a path relative to the CKEditor installation folder.
    CKEDITOR.config.pasteFromWordCleanupFile = 'plugins/pastefromword/filter/custom.js';
    
    // Load from the 'pastefromword' plugin 'filter' sub folder (custom.js file) using a full path (including the CKEditor installation folder).
    CKEDITOR.config.pasteFromWordCleanupFile = '/ckeditor/plugins/pastefromword/filter/custom.js';
    
    // Load custom.js file from the 'customFilters' folder (located in server's root) using the full URL.
    CKEDITOR.config.pasteFromWordCleanupFile = 'http://my.example.com/customFilters/custom.js';
    

    Defaults to <plugin path> + 'filter/default.js'

  • pasteFromWordNumberedHeadingToList : Boolean

    since 3.1

    Whether to transform Microsoft Word outline numbered headings into lists.

    config.pasteFromWordNumberedHeadingToList = true;
    

    Defaults to false

  • pasteFromWordPromptCleanup : Boolean

    since 3.1

    Whether to prompt the user about the clean up of content being pasted from Microsoft Word.

    config.pasteFromWordPromptCleanup = true;
    

    Defaults to false

  • pasteFromWordRemoveFontStyles : Boolean

    since 3.1 deprecated 4.6.0

    Whether to ignore all font-related formatting styles, including:

    • font size;
    • font family;
    • font foreground and background color.

      config.pasteFromWordRemoveFontStyles = true;

    Important note: Prior to version 4.6.0 this configuration option defaulted to true.

    Defaults to false

  • pasteFromWordRemoveStyles : Boolean

    since 3.1

    Whether to remove element styles that cannot be managed with the editor. Note that this option does not handle font-specific styles, which depend on the pasteFromWordRemoveFontStyles setting instead.

    config.pasteFromWordRemoveStyles = false;
    

    Defaults to true

  • pasteFromWord_heuristicsEdgeList : Boolean

    since 4.6.2

    Activates a heuristic that helps detect lists pasted into the editor in Microsoft Edge.

    The reason why this heuristic is needed is that on pasting Microsoft Edge removes any Word-specific metadata allowing to identify lists.

    // Disables list heuristics for Edge.
    config.pasteFromWord_heuristicsEdgeList = false;
    

    Defaults to true

  • pasteFromWord_inlineImages : Boolean

    since 4.8.0

    Flag decides whether embedding images pasted with Word content is enabled or not.

    Note: Please be aware that embedding images requires Clipboard API support, available only in modern browsers, that is indicated by CKEDITOR.plugins.clipboard.isCustomDataTypesSupported flag.

    // Disable embedding images pasted from Word.
    config.pasteFromWord_inlineImages = false;
    

    Defaults to true

  • plugins : String | String[]

    Comma-separated list of plugins to be used in an editor instance. Note that the actual plugins that are to be loaded could still be affected by two other settings: extraPlugins and removePlugins.

    Defaults to "<default list of plugins>"

  • protectedSource : Array

    A list of regular expressions to be executed on input HTML, indicating HTML source code that when matched, must not be available in the WYSIWYG mode for editing.

    config.protectedSource.push( /<\?[\s\S]*?\?>/g );                                           // PHP code
    config.protectedSource.push( /<%[\s\S]*?%>/g );                                             // ASP code
    config.protectedSource.push( /(<asp:[^\>]+>[\s|\S]*?<\/asp:[^\>]+>)|(<asp:[^\>]+\/>)/gi );  // ASP.NET code
    

    Defaults to []

  • readOnly : Boolean

    since 3.6

    If true, makes the editor start in read-only state. Otherwise, it will check if the linked <textarea> element has the disabled attribute.

    Read more in the documentation and see the SDK sample.

    config.readOnly = true;CKEDITOR.editor.setReadOnly
    

    Defaults to false

  • removeButtons : String

    List of toolbar button names that must not be rendered. This will also work for non-button toolbar items, like the Font drop-down list.

    config.removeButtons = 'Underline,JustifyCenter';
    

    This configuration option should not be overused. The recommended way is to use the removePlugins setting to remove features from the editor or even better, create a custom editor build with just the features that you will use. In some cases though, a single plugin may define a set of toolbar buttons and removeButtons may be useful when just a few of them are to be removed.

  • removeDialogTabs : String

    since 3.5

    The dialog contents to removed. It's a string composed by dialog name and tab name with a colon between them.

    Separate each pair with semicolon (see example).

    Note: All names are case-sensitive.

    Note: Be cautious when specifying dialog tabs that are mandatory, like 'info', dialog functionality might be broken because of this!

    config.removeDialogTabs = 'flash:advanced;image:Link';
    

    Defaults to ''

  • removeFormatAttributes : String

    A comma separated list of elements attributes to be removed when executing the remove format command.

    Defaults to 'class,style,lang,width,height,align,hspace,valign'

  • removeFormatTags : String

    A comma separated list of elements to be removed when executing the remove format command. Note that only inline elements are allowed.

    Defaults to 'b,big,cite,code,del,dfn,em,font,i,ins,kbd,q,s,samp,small,span,strike,strong,sub,sup,tt,u,var'

  • removePlugins : String | String[]

    A list of plugins that must not be loaded. This setting makes it possible to avoid loading some plugins defined in the plugins setting without having to touch it.

    Note: A plugin required by another plugin cannot be removed and will cause an error to be thrown. So for example if contextmenu is required by tabletools, it can only be removed if tabletools is not loaded.

    config.removePlugins = 'elementspath,save,font';
    

    Defaults to ''

  • resize_dir : String

    since 3.3

    The dimensions for which the editor resizing is enabled. Possible values are both, vertical, and horizontal.

    Read more in the documentation and see the SDK sample.

    config.resize_dir = 'both';
    

    Defaults to 'vertical'

  • resize_enabled : Boolean

    Whether to enable the resizing feature. If this feature is disabled, the resize handle will not be visible.

    Read more in the documentation and see the SDK sample.

    config.resize_enabled = false;
    

    Defaults to true

  • resize_maxHeight : Number

    The maximum editor height, in pixels, when resizing the editor interface by using the resize handle.

    Read more in the documentation and see the SDK sample.

    config.resize_maxHeight = 600;
    

    Defaults to 3000

  • resize_maxWidth : Number

    The maximum editor width, in pixels, when resizing the editor interface by using the resize handle.

    Read more in the documentation and see the SDK sample.

    config.resize_maxWidth = 750;
    

    Defaults to 3000

  • resize_minHeight : Number

    The minimum editor height, in pixels, when resizing the editor interface by using the resize handle. Note: It falls back to editor's actual height if it is smaller than the default value.

    Read more in the documentation and see the SDK sample.

    config.resize_minHeight = 600;
    

    Defaults to 250

  • resize_minWidth : Number

    The minimum editor width, in pixels, when resizing the editor interface by using the resize handle. Note: It falls back to editor's actual width if it is smaller than the default value.

    Read more in the documentation and see the SDK sample.

    config.resize_minWidth = 500;
    

    Defaults to 750

  • scayt_autoStartup : Boolean

    Automatically enables SCAYT on editor startup. When set to true, this option turns on SCAYT automatically after loading the editor.

    Read more in the documentation and see the SDK sample.

    config.scayt_autoStartup = true;
    

    Defaults to false

  • scayt_contextCommands : String

    Customizes the display of SCAYT context menu commands ("Add Word", "Ignore", "Ignore All", "Options", "Languages", "Dictionaries" and "About"). This must be a string with one or more of the following words separated by a pipe character ('|'):

    • off – Disables all options.
    • all – Enables all options.
    • ignore – Enables the "Ignore" option.
    • ignoreall – Enables the "Ignore All" option.
    • add – Enables the "Add Word" option.
    • option – Enables the "Options" menu item.
    • language – Enables the "Languages" menu item.
    • dictionary – Enables the "Dictionaries" menu item.
    • about – Enables the "About" menu item.

    Please note that availability of the "Options", "Languages" and "Dictionaries" items also depends on the scayt_uiTabs option.

    Read more in the documentation and see the SDK sample.

    Example:

    // Show "Add Word", "Ignore" and "Ignore All" in the context menu.
    config.scayt_contextCommands = 'add|ignore|ignoreall';
    

    Defaults to 'ignoreall|add'

  • scayt_contextMenuItemsOrder : String

    Defines the order of SCAYT context menu items by groups. This must be a string with one or more of the following words separated by a pipe character ('|'):

    • suggest – The main suggestion word list.
    • moresuggest – The "More suggestions" word list.
    • control – SCAYT commands, such as "Ignore" and "Add Word".

    Read more in the documentation and see the SDK sample.

    Example:

    config.scayt_contextMenuItemsOrder = 'moresuggest|control|suggest';
    

    Defaults to 'suggest|moresuggest|control'

  • scayt_customDictionaryIds : String

    Links SCAYT to custom dictionaries. This is a string containing the dictionary IDs separated by commas (','). Available only for the licensed version.

    Refer to SCAYT documentation for more details.

    Read more in the documentation and see the SDK sample.

    config.scayt_customDictionaryIds = '3021,3456,3478';
    

    Defaults to ''

  • scayt_customPunctuation : String

    The parameter that receives a string with characters that will considered as separators.

    Read more in the documentation and see the SDK sample.

    // additional separator.
    config.scayt_customPunctuation  = '-';
    

    Defaults to ''

  • scayt_customerId : String

    Sets the customer ID for SCAYT. Used for hosted users only. Required for migration from free to trial or paid versions.

    Read more in the documentation and see the SDK sample.

    // Load SCAYT using my customer ID.
    config.scayt_customerId  = 'your-encrypted-customer-id';
    

    Defaults to '1:WvF0D4-UtPqN1-43nkD4-NKvUm2-daQqk3-LmNiI-z7Ysb4-mwry24-T8YrS3-Q2tpq2'

  • scayt_disableOptionsStorage : Array

    Disables storing of SCAYT options between sessions. Option storing will be turned off after a page refresh. The following settings can be used:

    • 'options' – Disables storing of all SCAYT Ignore options.
    • 'ignore-all-caps-words' – Disables storing of the "Ignore All-Caps Words" option.
    • 'ignore-domain-names' – Disables storing of the "Ignore Domain Names" option.
    • 'ignore-words-with-mixed-cases' – Disables storing of the "Ignore Words with Mixed Case" option.
    • 'ignore-words-with-numbers' – Disables storing of the "Ignore Words with Numbers" option.
    • 'lang' – Disables storing of the SCAYT spell check language.
    • 'all' – Disables storing of all SCAYT options.

    Read more in the documentation and see the SDK sample.

    Example:

    // Disabling one option.
    config.scayt_disableOptionsStorage = 'all';
    
    // Disabling several options.
    config.scayt_disableOptionsStorage = ['lang', 'ignore-domain-names', 'ignore-words-with-numbers'];
    

    Defaults to ''

  • scayt_elementsToIgnore : String

    Specifies the names of tags that will be skipped while spell checking. This is a string containing tag names separated by commas (','). Please note that the 'style' tag would be added to specified tags list.

    Read more in the documentation and see the SDK sample.

    config.scayt_elementsToIgnore = 'del,pre';
    

    Defaults to 'style'

  • scayt_handleCheckDirty : String

    If set to true, it overrides the checkDirty functionality of CKEditor to fix SCAYT issues with incorrect checkDirty behavior. If set to false, it provides better performance on big preloaded text.

    Read more in the documentation and see the SDK sample.

    config.scayt_handleCheckDirty = 'false';
    

    Defaults to 'true'

  • scayt_handleUndoRedo : String

    Configures undo/redo behavior of SCAYT in CKEditor. If set to true, it overrides the undo/redo functionality of CKEditor to fix SCAYT issues with incorrect undo/redo behavior. If set to false, it provides better performance on text undo/redo.

    Read more in the documentation and see the SDK sample.

    config.scayt_handleUndoRedo = 'false';
    

    Defaults to 'true'

  • scayt_ignoreAllCapsWords : Boolean

    since 4.5.6

    Enables the "Ignore All-Caps Words" option by default. You may need to disable option storing for this setting to be effective because option storage has a higher priority.

    Read more in the documentation and see the SDK sample.

    config.scayt_ignoreAllCapsWords = true;
    

    Defaults to false

  • scayt_ignoreDomainNames : Boolean

    since 4.5.6

    Enables the "Ignore Domain Names" option by default. You may need to disable option storing for this setting to be effective because option storage has a higher priority.

    Read more in the documentation and see the SDK sample.

    config.scayt_ignoreDomainNames = true;
    

    Defaults to false

  • scayt_ignoreWordsWithMixedCases : Boolean

    since 4.5.6

    Enables the "Ignore Words with Mixed Case" option by default. You may need to disable option storing for this setting to be effective because option storage has a higher priority.

    Read more in the documentation and see the SDK sample.

    config.scayt_ignoreWordsWithMixedCases = true;
    

    Defaults to false

  • scayt_ignoreWordsWithNumbers : Boolean

    since 4.5.6

    Enables the "Ignore Words with Numbers" option by default. You may need to disable option storing for this setting to be effective because option storage has a higher priority.

    Read more in the documentation and see the SDK sample.

    config.scayt_ignoreWordsWithNumbers = true;
    

    Defaults to false

  • scayt_inlineModeImmediateMarkup : Boolean

    since 4.5.6

    Enables SCAYT initialization when inline CKEditor is not focused. When set to true, SCAYT markup is displayed in both inline editor states, focused and unfocused, so the SCAYT instance is not destroyed.

    Read more in the documentation and see the SDK sample.

     config.scayt_inlineModeImmediateMarkup = true;
    

    Defaults to false

  • scayt_maxSuggestions : Number

    Defines the number of SCAYT suggestions to show in the main context menu. Possible values are:

    • 0 (zero) – No suggestions are shown in the main context menu. All entries will be listed in the "More Suggestions" sub-menu.
    • Positive number – The maximum number of suggestions to show in the context menu. Other entries will be shown in the "More Suggestions" sub-menu.
    • Negative number – Five suggestions are shown in the main context menu. All other entries will be listed in the "More Suggestions" sub-menu.

    Read more in the documentation and see the SDK sample.

    Examples:

    // Display only three suggestions in the main context menu.
    config.scayt_maxSuggestions = 3;
    
    // Do not show the suggestions directly.
    config.scayt_maxSuggestions = 0;
    

    Defaults to 3

  • scayt_minWordLength : Number

    Defines the minimum length of words that will be collected from the editor content for spell checking. Possible value is any positive number.

    Read more in the documentation and see the SDK sample.

    Examples:

    // Set the minimum length of words that will be collected from editor text.
    config.scayt_minWordLength = 5;
    

    Defaults to 3

  • scayt_moreSuggestions : String

    Enables and disables the "More Suggestions" sub-menu in the context menu. Possible values are 'on' and 'off'.

    Read more in the documentation and see the SDK sample.

    // Disables the "More Suggestions" sub-menu.
    config.scayt_moreSuggestions = 'off';
    

    Defaults to 'on'

  • scayt_multiLanguageMode : Boolean

    Enables multi-language support in SCAYT. If set to true, turns on SCAYT multi-language support after loading the editor.

    Read more in the documentation and see the SDK sample.

    config.scayt_multiLanguageMode = true;
    

    Defaults to false

  • scayt_multiLanguageStyles : Object

    Defines additional styles for misspellings for specified languages. Styles will be applied only if the scayt_multiLanguageMode option is set to true and the Language plugin is included and loaded in the editor. By default, all misspellings will still be underlined with the red waveline.

    Read more in the documentation and see the SDK sample.

    Example:

    // Display misspellings in French language with green color and underlined with red waveline.
    config.scayt_multiLanguageStyles = {
        'fr': 'color: green'
    };
    
    // Display misspellings in Italian language with green color and underlined with red waveline
    // and German misspellings with red color only.
    config.scayt_multiLanguageStyles = {
        'it': 'color: green',
        'de': 'background-image: none; color: red'
    };
    

    Defaults to {}

  • scayt_sLang : String

    Sets the default spell checking language for SCAYT. Possible values are: 'da_DK', 'de_DE', 'el_GR', 'en_CA', 'en_GB', 'en_US', 'es_ES', 'fi_FI', 'fr_CA', 'fr_FR', 'it_IT', 'nb_NO' 'nl_NL', 'sv_SE'.

    Customers with dedicated SCAYT license may also set 'pt_BR' and 'pt_PT'.

    Read more in the documentation and see the SDK sample.

    // Sets SCAYT to German.
    config.scayt_sLang = 'de_DE';
    

    Defaults to 'en_US'

  • scayt_serviceHost : String

    Sets the host for the WebSpellChecker service (ssrv.cgi) full path.

    Read more in the documentation and see the SDK sample.

    // Defines the host for the WebSpellChecker service (ssrv.cgi) path.
    config.scayt_serviceHost = 'my-host';
    

    Defaults to 'svc.webspellchecker.net'

  • scayt_servicePath : String

    Sets the path to the WebSpellChecker service (ssrv.cgi).

    Read more in the documentation and see the SDK sample.

    // Defines the path to the WebSpellChecker service (ssrv.cgi).
    config.scayt_servicePath = 'my-path/ssrv.cgi';
    

    Defaults to 'spellcheck31/script/ssrv.cgi'

  • scayt_servicePort : String

    Sets the port for the WebSpellChecker service (ssrv.cgi) full path.

    Read more in the documentation and see the SDK sample.

    // Defines the port for the WebSpellChecker service (ssrv.cgi) path.
    config.scayt_servicePort = '2330';
    

    Defaults to '80'

  • scayt_serviceProtocol : String

    Sets the protocol for the WebSpellChecker service (ssrv.cgi) full path.

    Read more in the documentation and see the SDK sample.

    // Defines the protocol for the WebSpellChecker service (ssrv.cgi) path.
    config.scayt_serviceProtocol = 'https';
    

    Defaults to 'http'

  • scayt_srcUrl : String

    Sets the URL to SCAYT core. Required to switch to the licensed version of SCAYT.

    Refer to SCAYT documentation for more details.

    Read more in the documentation and see the SDK sample.

    config.scayt_srcUrl = "http://my-host/spellcheck/lf/scayt/scayt.js";
    

    Defaults to '//svc.webspellchecker.net/spellcheck31/wscbundle/wscbundle.js'

  • scayt_uiTabs : String

    Customizes the SCAYT dialog and SCAYT toolbar menu to show particular tabs and items. This setting must contain a 1 (enabled) or 0 (disabled) value for each of the following entries, in this precise order, separated by a comma (','): 'Options', 'Languages', and 'Dictionary'.

    Read more in the documentation and see the SDK sample.

    // Hides the "Languages" tab.
    config.scayt_uiTabs = '1,0,1';
    

    Defaults to '1,1,1'

  • scayt_userDictionaryName : String

    Activates a User Dictionary in SCAYT. The user dictionary name must be used. Available only for the licensed version.

    Refer to SCAYT documentation for more details.

    Read more in the documentation and see the SDK sample.

    config.scayt_userDictionaryName = 'MyDictionary';
    

    Defaults to ''

  • sharedSpaces : Object

    Makes it possible to place some of the editor UI blocks, like the toolbar and the elements path, in any element on the page.

    The elements used to store the UI blocks can be shared among several editor instances. In that case only the blocks relevant to the active editor instance will be displayed.

    Read more in the documentation and see the SDK sample.

    // Place the toolbar inside the element with an ID of "someElementId" and the
    // elements path into the element with an  ID of "anotherId".
    config.sharedSpaces = {
        top: 'someElementId',
        bottom: 'anotherId'
    };
    
    // Place the toolbar inside the element with an ID of "someElementId". The
    // elements path will remain attached to the editor UI.
    config.sharedSpaces = {
        top: 'someElementId'
    };
    
    // (Since 4.5)
    // Place the toolbar inside a DOM element passed by a reference. The
    // elements path will remain attached to the editor UI.
    var htmlElement = document.getElementById( 'someElementId' );
    config.sharedSpaces = {
        top: htmlElement
    };
    

    Note: The Maximize and Editor Resize features are not supported in the shared space environment and should be disabled in this context.

    config.removePlugins = 'maximize,resize';
    
  • shiftEnterMode : Number

    Similarly to the enterMode setting, it defines the behavior of the Shift+Enter key combination.

    The allowed values are the following constants that cause the behavior outlined below:

    Read more in the documentation and see the SDK sample.

    Example:

    config.shiftEnterMode = CKEDITOR.ENTER_P;
    

    Defaults to CKEDITOR.ENTER_BR

  • skin : String

    The editor skin name. Note that it is not possible to have editors with different skin settings in the same page. In such case just one of the skins will be used for all editors.

    This is a shortcut to CKEDITOR.skinName.

    It is possible to install skins outside the default skin folder in the editor installation. In that case, the absolute URL path to that folder should be provided, separated by a comma ('skin_name,skin_path').

    config.skin = 'moono';
    
    config.skin = 'myskin,/customstuff/myskin/';
    
  • smiley_columns : Number

    since 3.3.2

    The number of columns to be generated by the smilies matrix.

    config.smiley_columns = 6;
    

    Defaults to 8

  • smiley_descriptions : Array

    The description to be used for each of the smileys defined in the smiley_images setting. Each entry in this array list must match its relative pair in the smiley_images setting.

    // Default settings.
    config.smiley_descriptions = [
        'smiley', 'sad', 'wink', 'laugh', 'frown', 'cheeky', 'blush', 'surprise',
        'indecision', 'angry', 'angel', 'cool', 'devil', 'crying', 'enlightened', 'no',
        'yes', 'heart', 'broken heart', 'kiss', 'mail'
    ];
    
    // Use textual emoticons as description.
    config.smiley_descriptions = [
        ':)', ':(', ';)', ':D', ':/', ':P', ':*)', ':-o',
        ':|', '>:(', 'o:)', '8-)', '>:-)', ';(', '', '', '',
        '', '', ':-*', ''
    ];
    

    Defaults to ['smiley', 'sad', 'wink', 'laugh', 'frown', 'cheeky', 'blush', 'surprise', 'indecision', 'angry', 'angel', 'cool', 'devil', 'crying', 'enlightened', 'no', 'yes', 'heart', 'broken heart', 'kiss', 'mail']

  • smiley_images : Array

    The file names for the smileys to be displayed. These files must be contained inside the URL path defined with the smiley_path setting.

    // This is actually the default value.
    config.smiley_images = [
        'regular_smile.png','sad_smile.png','wink_smile.png','teeth_smile.png','confused_smile.png','tongue_smile.png',
        'embarrassed_smile.png','omg_smile.png','whatchutalkingabout_smile.png','angry_smile.png','angel_smile.png','shades_smile.png',
        'devil_smile.png','cry_smile.png','lightbulb.png','thumbs_down.png','thumbs_up.png','heart.png',
        'broken_heart.png','kiss.png','envelope.png'
    ];
    

    Defaults to ['regular_smile.png', 'sad_smile.png', 'wink_smile.png', 'teeth_smile.png', 'confused_smile.png', 'tongue_smile.png', 'embarrassed_smile.png', 'omg_smile.png', 'whatchutalkingabout_smile.png', 'angry_smile.png', 'angel_smile.png', 'shades_smile.png', 'devil_smile.png', 'cry_smile.png', 'lightbulb.png', 'thumbs_down.png', 'thumbs_up.png', 'heart.png', 'broken_heart.png', 'kiss.png', 'envelope.png']

  • smiley_path : String

    The base path used to build the URL for the smiley images. It must end with a slash.

    config.smiley_path = 'http://www.example.com/images/smileys/';
    
    config.smiley_path = '/images/smileys/';
    

    Defaults to CKEDITOR.basePath + 'plugins/smiley/images/'

  • sourceAreaTabSize : Number

    Controls the tab-size CSS property of the source editing area. Use it to set the width of the tab character in the source view. Enter an integer to denote the number of spaces that the tab will contain.

    Note: Works only with dataIndentationChars set to '\t'. Please consider that not all browsers support the tab-size CSS property yet.

    // Set tab-size to 10 characters.
    config.sourceAreaTabSize = 10;CKEDITOR.config.dataIndentationChars
    

    Defaults to 4

  • specialChars : Array

    The list of special characters visible in the "Special Character" dialog window.

    config.specialChars = [ '&quot;', '&rsquo;', [ '&custom;', 'Custom label' ] ];
    config.specialChars = config.specialChars.concat( [ '&quot;', [ '&rsquo;', 'Custom label' ] ] );
    

    Defaults to ['!', '&quot;', '#', '$', '%', '&amp;', "'", '(', ')', '*', '+', '-', '.', '/', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', ':', ';', '&lt;', '=', '&gt;', '?', '@', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '[', ']', '^', '_', '`', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '{', '|', '}', '~', '&euro;', '&lsquo;', '&rsquo;', '&ldquo;', '&rdquo;', '&ndash;', '&mdash;', '&iexcl;', '&cent;', '&pound;', '&curren;', '&yen;', '&brvbar;', '&sect;', '&uml;', '&copy;', '&ordf;', '&laquo;', '&not;', '&reg;', '&macr;', '&deg;', '&sup2;', '&sup3;', '&acute;', '&micro;', '&para;', '&middot;', '&cedil;', '&sup1;', '&ordm;', '&raquo;', '&frac14;', '&frac12;', '&frac34;', '&iquest;', '&Agrave;', '&Aacute;', '&Acirc;', '&Atilde;', '&Auml;', '&Aring;', '&AElig;', '&Ccedil;', '&Egrave;', '&Eacute;', '&Ecirc;', '&Euml;', '&Igrave;', '&Iacute;', '&Icirc;', '&Iuml;', '&ETH;', '&Ntilde;', '&Ograve;', '&Oacute;', '&Ocirc;', '&Otilde;', '&Ouml;', '&times;', '&Oslash;', '&Ugrave;', '&Uacute;', '&Ucirc;', '&Uuml;', '&Yacute;', '&THORN;', '&szlig;', '&agrave;', '&aacute;', '&acirc;', '&atilde;', '&auml;', '&aring;', '&aelig;', '&ccedil;', '&egrave;', '&eacute;', '&ecirc;', '&euml;', '&igrave;', '&iacute;', '&icirc;', '&iuml;', '&eth;', '&ntilde;', '&ograve;', '&oacute;', '&ocirc;', '&otilde;', '&ouml;', '&divide;', '&oslash;', '&ugrave;', '&uacute;', '&ucirc;', '&uuml;', '&yacute;', '&thorn;', '&yuml;', '&OElig;', '&oelig;', '&#372;', '&#374', '&#373', '&#375;', '&sbquo;', '&#8219;', '&bdquo;', '&hellip;', '&trade;', '&#9658;', '&bull;', '&rarr;', '&rArr;', '&hArr;', '&diams;', '&asymp;']

  • startupFocus : String | Boolean

    Whether an editable element should have focus when the editor is loading for the first time.

    // Focus at the beginning of the editable.
    config.startupFocus = true;
    

    Since CKEditor 4.9.0, startupFocus can be explicitly set to either the start or the end of the editable:

    // Focus at the beginning of the editable.
    config.startupFocus = 'start';
    
    // Focus at the end of the editable.
    config.startupFocus = 'end';
    

    Defaults to false

  • startupMode : String

    The mode to load at the editor startup. It depends on the plugins loaded. By default, the wysiwyg and source modes are available.

    config.startupMode = 'source';
    

    Defaults to 'wysiwyg'

  • startupOutlineBlocks : Boolean

    Whether to automaticaly enable the show block" command when the editor loads.

    config.startupOutlineBlocks = true;
    

    Defaults to false

  • startupShowBorders : Boolean

    Whether to automatically enable the "show borders" command when the editor loads.

    config.startupShowBorders = false;
    

    Defaults to true

  • stylesSet : String | Array | Boolean

    since 3.3

    The "styles definition set" to use in the editor. They will be used in the styles combo and the style selector of the div container.

    The styles may be defined in the page containing the editor, or can be loaded on demand from an external file. In the second case, if this setting contains only a name, the styles.js file will be loaded from the CKEditor root folder (what ensures backward compatibility with CKEditor 4.0).

    Otherwise, this setting has the name:url syntax, making it possible to set the URL from which the styles file will be loaded. Note that the name has to be equal to the name used in CKEDITOR.stylesSet.add while registering the styles set.

    Note: Since 4.1 it is possible to set stylesSet to false to prevent loading any styles set.

    Read more in the documentation and see the SDK sample.

    // Do not load any file. The styles set is empty.
    config.stylesSet = false;
    
    // Load the 'mystyles' styles set from the styles.js file.
    config.stylesSet = 'mystyles';
    
    // Load the 'mystyles' styles set from a relative URL.
    config.stylesSet = 'mystyles:/editorstyles/styles.js';
    
    // Load the 'mystyles' styles set from a full URL.
    config.stylesSet = 'mystyles:http://www.example.com/editorstyles/styles.js';
    
    // Load from a list of definitions.
    config.stylesSet = [
        { name: 'Strong Emphasis', element: 'strong' },
        { name: 'Emphasis', element: 'em' },
        ...
    ];
    

    Defaults to 'default'

  • stylesheetParser_skipSelectors : RegExp

    since 3.6

    A regular expression that defines whether a CSS rule will be skipped by the Stylesheet Parser plugin. A CSS rule matching the regular expression will be ignored and will not be available in the Styles drop-down list.

    Read more in the documentation and see the SDK sample.

    // Ignore rules for body and caption elements, classes starting with "high", and any class defined for no specific element.
    config.stylesheetParser_skipSelectors = /(^body\.|^caption\.|\.high|^\.)/i;CKEDITOR.config.stylesheetParser_validSelectors
    

    Defaults to /(^body\.|^\.)/i

  • stylesheetParser_validSelectors : RegExp

    since 3.6

    A regular expression that defines which CSS rules will be used by the Stylesheet Parser plugin. A CSS rule matching the regular expression will be available in the Styles drop-down list.

    Read more in the documentation and see the SDK sample.

    // Only add rules for p and span elements.
    config.stylesheetParser_validSelectors = /\^(p|span)\.\w+/;CKEDITOR.config.stylesheetParser_skipSelectors
    

    Defaults to /\w+\.\w+/

  • tabIndex : Number

    The editor tabindex value.

    Read more in the documentation and see the SDK sample.

    config.tabIndex = 1;
    

    Defaults to 0

  • tabSpaces : Number

    Intructs the editor to add a number of spaces (&nbsp;) to the text when hitting the Tab key. If set to zero, the Tab key will be used to move the cursor focus to the next element in the page, out of the editor focus.

    config.tabSpaces = 4;
    

    Defaults to 0

  • templates : String

    The templates definition set to use. It accepts a list of names separated by comma. It must match definitions loaded with the templates_files setting.

    config.templates = 'my_templates';
    

    Defaults to 'default'

  • templates_files : String[]

    The list of templates definition files to load.

    config.templates_files = [
        '/editor_templates/site_default.js',
        'http://www.example.com/user_templates.js'
    ];
    

    For a sample template file see templates/default.js.

  • templates_replaceContent : Boolean

    Whether the "Replace actual contents" checkbox is checked by default in the Templates dialog.

    config.templates_replaceContent = false;
    

    Defaults to true

  • title : String | Boolean

    since 4.2

    Customizes the human-readable title of this editor. This title is displayed in tooltips and impacts various accessibility aspects, e.g. it is commonly used by screen readers for distinguishing editor instances and for navigation. Accepted values are a string or false.

    Note: When config.title is set globally, the same value will be applied to all editor instances loaded with this config. This may adversely affect accessibility as screen reader users will be unable to distinguish particular editor instances and navigate between them.

    Note: Setting config.title = false may also impair accessibility in a similar way.

    Note: Please do not confuse this property with CKEDITOR.editor.name which identifies the instance in the CKEDITOR.instances literal.

    // Sets the title to 'My WYSIWYG editor.'. The original title of the element (if it exists)
    // will be restored once the editor instance is destroyed.
    config.title = 'My WYSIWYG editor.';
    
    // Do not touch the title. If the element already has a title, it remains unchanged.
    // Also if no `title` attribute exists, nothing new will be added.
    config.title = false;
    

    See also:

    Defaults to based on editor.name

  • toolbar : Array | String

    The toolbox (alias toolbar) definition. It is a toolbar name or an array of toolbars (strips), each one being also an array, containing a list of UI items.

    If set to null, the toolbar will be generated automatically using all available buttons and toolbarGroups as a toolbar groups layout.

    In CKEditor 4.5+ you can generate your toolbar customization code by using the visual toolbar configurator.

    // Defines a toolbar with only one strip containing the "Source" button, a
    // separator, and the "Bold" and "Italic" buttons.
    config.toolbar = [
        [ 'Source', '-', 'Bold', 'Italic' ]
    ];
    
    // Similar to the example above, defines a "Basic" toolbar with only one strip containing three buttons.
    // Note that this setting is composed by "toolbar_" added to the toolbar name, which in this case is called "Basic".
    // This second part of the setting name can be anything. You must use this name in the CKEDITOR.config.toolbar setting
    // in order to instruct the editor which `toolbar_(name)` setting should be used.
    config.toolbar_Basic = [
        [ 'Source', '-', 'Bold', 'Italic' ]
    ];
    // Load toolbar_Name where Name = Basic.
    config.toolbar = 'Basic';
    

    Defaults to null

  • toolbarCanCollapse : Boolean

    Whether the toolbar can be collapsed by the user. If disabled, the Collapse Toolbar button will not be displayed.

    config.toolbarCanCollapse = true;
    

    Defaults to false

  • toolbarGroupCycling : Boolean

    since 3.6

    When enabled, causes the Arrow keys navigation to cycle within the current toolbar group. Otherwise the Arrow keys will move through all items available in the toolbar. The Tab key will still be used to quickly jump among the toolbar groups.

    config.toolbarGroupCycling = false;
    

    Defaults to true

  • toolbarGroups : Array

    The toolbar groups definition.

    If the toolbar layout is not explicitly defined by the toolbar setting, then this setting is used to group all defined buttons (see CKEDITOR.ui.addButton). Buttons are associated with toolbar groups by the toolbar property in their definition objects.

    New groups may be dynamically added during the editor and plugin initialization by CKEDITOR.ui.addToolbarGroup. This is only possible if the default setting was used.

    // Default setting.
    config.toolbarGroups = [
        { name: 'document',    groups: [ 'mode', 'document', 'doctools' ] },
        { name: 'clipboard',   groups: [ 'clipboard', 'undo' ] },
        { name: 'editing',     groups: [ 'find', 'selection', 'spellchecker' ] },
        { name: 'forms' },
        '/',
        { name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ] },
        { name: 'paragraph',   groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ] },
        { name: 'links' },
        { name: 'insert' },
        '/',
        { name: 'styles' },
        { name: 'colors' },
        { name: 'tools' },
        { name: 'others' },
        { name: 'about' }
    ];
    

    Defaults to see example

  • toolbarLocation : String

    The part of the user interface where the toolbar will be rendered. For the default editor implementation, the recommended options are 'top' and 'bottom'.

    Please note that this option is only applicable to classic (iframe-based) editor. In case of inline editor the toolbar position is set dynamically depending on the position of the editable element on the screen.

    Read more in the documentation and see the SDK sample.

    config.toolbarLocation = 'bottom';
    

    Defaults to 'top'

  • toolbarStartupExpanded : Boolean

    Whether the toolbar must start expanded when the editor is loaded.

    Setting this option to false will affect the toolbar only when toolbarCanCollapse is set to true:

    config.toolbarCanCollapse = true;
    config.toolbarStartupExpanded = false;
    

    Defaults to true

  • uiColor : String

    The base user interface color to be used by the editor. Not all skins are compatible with this setting.

    Read more in the documentation and see the SDK sample.

    // Using a color code.
    config.uiColor = '#AADC6E';
    
    // Using an HTML color name.
    config.uiColor = 'Gold';
    
  • undoStackSize : Number

    The number of undo steps to be saved. The higher value is set, the more memory is used for it.

    config.undoStackSize = 50;
    

    Defaults to 20

  • uploadUrl : String

    since 4.5

    The URL where files should be uploaded.

    An empty string means that the option is disabled.

    Defaults to ''

  • useComputedState : Boolean

    since 3.4

    Indicates that some of the editor features, like alignment and text direction, should use the "computed value" of the feature to indicate its on/off state instead of using the "real value".

    If enabled in a Left-To-Right written document, the "Left Justify" alignment button will be shown as active, even if the alignment style is not explicitly applied to the current paragraph in the editor.

    config.useComputedState = false;
    

    Defaults to true

  • width : String | Number

    The editor UI outer width. This configuration option accepts an integer (to denote a value in pixels) or any CSS-defined length unit.

    Unlike the height setting, this one will set the outer width of the entire editor UI, not for the editing area only.

    Note: This configuration option is ignored by inline editor.

    Read more in the documentation and see the SDK sample.

    config.width = 850;     // 850 pixels wide.
    config.width = '75%';   // CSS unit.
    

    Defaults to ''

  • wsc_cmd : String

    The parameter sets the active tab, when the WSC dialog is opened. Possible values are: 'spell', 'thes', 'grammar'.

    // Sets active tab thesaurus.
    config.wsc_cmd  = 'thes';
    

    Defaults to 'spell'

  • wsc_customDictionaryIds : String

    It links WSC to custom dictionaries. It should be a string with dictionary IDs separated by commas (','). Available only for the licensed version.

    Further details at http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:customdictionaries:licensed

    config.wsc_customDictionaryIds = '1,3001';
    

    Defaults to ''

  • wsc_customLoaderScript : String

    The parameter sets the URL to WSC file. It is required to the licensed version of WSC application.

    Further details available at http://wiki.webspellchecker.net/doku.php?id=migration:hosredfreetolicensedck

    config.wsc_customLoaderScript = "http://my-host/spellcheck/lf/22/js/wsc_fck2plugin.js";
    

    Defaults to ''

  • wsc_customerId : String

    The parameter sets the customer ID for WSC. It is used for hosted users only. It is required for migration from free to trial or paid versions.

    config.wsc_customerId  = 'encrypted-customer-id';
    

    Defaults to '1:ua3xw1-2XyGJ3-GWruD3-6OFNT1-oXcuB1-nR6Bp4-hgQHc-EcYng3-sdRXG3-NOfFk'

  • wsc_height : String

    The parameter sets height of the WSC pop-up window. Specified in pixels.

    // Set the pop-up height.
    config.wsc_height = 800;
    

    Defaults to Content based.

  • wsc_lang : String

    The parameter sets the default spellchecking language for WSC. Possible values are: 'da_DK', 'de_DE', 'el_GR', 'en_CA', 'en_GB', 'en_US', 'es_ES', 'fi_FI', 'fr_CA', 'fr_FR', 'it_IT', 'nb_NO' 'nl_NL', 'sv_SE'.

    Customers with dedicated WebSpellChecker license may also set 'pt_BR' and 'pt_PT'.

    Further details available at http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:supportedlanguages

    config.wsc_lang = 'de_DE';
    

    Defaults to 'en_US'

  • wsc_left : String

    The parameter sets left margin of the WSC pop-up window. Specified in pixels.

    // Set left margin.
    config.wsc_left = 0;
    

    Defaults to In the middle of the screen.

  • wsc_top : String

    The parameter sets top margin of the WSC pop-up window. Specified in pixels.

    // Sets top margin.
    config.wsc_top = 0;
    

    Defaults to In the middle of the screen.

  • wsc_userDictionaryName : String

    It activates a user dictionary for WSC. The user dictionary name should be used. Available only for the licensed version.

    config.wsc_userDictionaryName = 'MyUserDictionaryName';
    

    Defaults to ''

  • wsc_width : String

    The parameter sets width of the WSC pop-up window. Specified in pixels.

    // Set the pop-up width.
    config.wsc_width = 800;
    

    Defaults to 580