TinyMCE 6 API changes

Preparing for Confluence 8.2

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

See TinyMCE’s guide for migrating from TinyMCE 5 to TinyMCE 6.

What's changing?

The Confluence editor will be upgraded from TinyMCE 5 to TinyMCE 6 in Confluence 8.3. This page provides a summary of the changes we've made to prepare for the upgrade.

(info) We recommend you make these changes now before they become required when we upgrade to TinyMCE 6. The changes are compatible with both versions of the editor.

Confluence API changes

RemovedDescription
tinymce.pluginsAs a result of removing tinymce.create(), most of our manually declared global variables under tinymce.plugins object have also been removed. Don't use these as APIs.

TinyMCE API changes

RemovedDescription
tinymce.create()

The create() method is deprecated and will be removed in TinyMCE 6. You can still use it safely in Confluence 8.2, but we recommend you remove it in preparation for the editor upgrade. 

Previous pattern
// `tinymce` AMD module comes from `com.atlassian.confluence.plugins.confluence-editor-plugin:core` web-resource
import tinymce from 'tinymce'; // Alternativelly, const tinymce = require('tinymce');
 
const plugin = {
    init: function(editor) {
        ... plugin code ...
    }
}
 
tinymce.create('tinymce.plugins.MyPlugin', plugin);
tinymce.PluginManager.add('my-plugin-name', tinymce.plugins.MyPlugin);
New pattern
// `tinymce` AMD module comes from `com.atlassian.confluence.plugins.confluence-editor-plugin:core` web-resource
import tinymce from 'tinymce'; // Alternativelly, const tinymce = require('tinymce');
 
function plugin() {
    return {
        init: function(editor) {
            ... plugin code ...
        }
    }
}
 
// OR
 
function plugin(editor) {
    ... plugin code ...
}
 
tinymce.PluginManager.add('my-plugin-name', plugin);


Learn more about creating TinyMCE plugins.

Last modified on Apr 13, 2023

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.