Specify editor & plugin versions
Specifying the TinyMCE editor version deployed from Cloud
Use the URL provided to specify the TinyMCE version when deploying via Tiny Cloud. Refer to the TinyMCE editor via the Tiny Cloud for more information.
The following example is the default for loading TinyMCE 5 via Tiny Cloud. Substitute 'no-api-key' with your api key in the examples below.
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/5/tinymce.min.js" referrerpolicy="origin"></script>
This URL specifies the latest and quality assured release of TinyMCE.
Selecting specific version numbers
All Tiny Cloud channels are based on the TinyMCE Enterprise version. For information on the latest version of the Tiny Cloud 5 release channel, see: TinyMCE Release Notes. For a list of changes that may be present in the Tiny Cloud testing channel, see: TinyMCE Changelog.
|
5, 5-testing, and 5-dev release channels
Choose from the 5
, 5-testing
, or 5-dev
release channels to load the latest version of TinyMCE from Tiny Cloud.
These channels are updated automatically and provide the latest TinyMCE version that matches the criteria below.
5 release channel
This channel deploys the latest release of TinyMCE that has passed our quality assurance process. The current version of TinyMCE available through the /5
channel can be found on the Tiny Cloud TinyMCE 5 version page. The TinyMCE 5 channel can be loaded from https://cdn.tiny.cloud/1/no-api-key/tinymce/5/tinymce.min.js
.
5-testing release channel
This channel deploys the current release candidate for the 5
channel. The TinyMCE release candidate is undergoing quality assurance. The current version of TinyMCE available through the 5-testing
channel can be found on the Tiny Cloud TinyMCE 5-testing version page.
5-dev release channel
This channel deploys nightly builds of TinyMCE. This channel includes the unreleased changes documented in the TinyMCE changelog. The current version of TinyMCE available through the 5-dev
channel can be found on the Tiny Cloud TinyMCE 5-dev version page.
Specifying the version of premium plugins deployed from Tiny Cloud
Each TinyMCE version is bundled with a set of premium plugins, but it is possible to specify different versions of each premium plugin to use with TinyMCE. Use the URL query parameters to specify the version of each premium plugin to load. This approach works with both the TinyMCE editor and premium plugins deployment via Tiny Cloud or just the premium plugins deployment from Tiny Cloud.
The identifier
of the plugin is used as a query parameter. This table summarises the possible options.
Plugin | Identifier | Supported Versions |
---|---|---|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Specifying versions for the editor and premium plugin deployment
When deploying both the editor and premium plugins from Tiny Cloud, TinyMCE will load the premium plugins bundled with that version of the editor. To load a different version of a premium plugin, append the name of the plugin and the version to load as query parameters. The version must match one of the versions listed in the Supported Versions
link for the relevant plugin.
Combine multiple plugin specifications using &
in your query string. For example, to load:
-
mentions v2.2
-
powerpaste v5.5
-
all other premium plugins from those bundled with
5
Append ?mentions=2.2&powerpaste=5.5
, such as:
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/5/tinymce.min.js?mentions=2.2&powerpaste=5.5" referrerpolicy="origin"></script>
Specifying a self-hosted deployment of features/plugins
When deploying only premium plugins from Tiny Cloud, some features are served from Tiny Cloud and some features served from a self-hosted installation. There are two ways to achieve this: plugins.min.js
and cloud-plugins.min.js
.
plugins.min.js
Instead of loading tinymce.min.js
from Tiny Cloud, serve TinyMCE from a self-hosted server, and load plugins.min.js
from Tiny Cloud. TinyMCE which will attempt to load every premium plugin from Tiny Cloud, unless the version of the plugin is specified as the special version sdk
. The query string for plugins.min.js
works the same way as tinymce.min.js
, except for the addition of sdk
. For example, this script tag:
The following example:
-
Assumes TinyMCE has already been loaded by another script on the page.
-
Attempts to load
mentions
v2.2
andpowerpaste
v5.5
from Tiny Cloud. -
Attempts to load
advcode
from the self-hosted installation. -
Attempts to load all other premium plugins from those bundled with version
5
of TinyMCE.
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/5/plugins.min.js?mentions=2.2&powerpaste=5.5&advcode=sdk" referrerpolicy="origin"></script>
The disadvantage of plugins.min.js
: to load only one plugin from the Tiny Cloud and the rest from a self-hosted deployment, ALL other plugins need to be added as query parameter with the version as sdk
. When Tiny Cloud releases a new plugin, this will need to be updated. In situations where most premium plugins need to be loaded from a self-hosted deployment, use cloud-plugins.min.js
.
cloud-plugins.min.js
Instead of loading tinymce.min.js
from Tiny Cloud, serve TinyMCE from a self-hosted server, and load cloud-plugins.min.js
from Tiny Cloud. Unlike plugins.min.js
, cloud-plugins.min.js
defaults to loading every premium plugin from the self-hosted TinyMCE installation, not Tiny Cloud. However, plugins can be loaded from Tiny Cloud by specifying them as query parameters.
With cloud-plugins.min.js
, the plugins listed in the query strings do not require a version. If there is no version specified, TinyMCE uses the version bundled with the TinyMCE version requested. There is also no need to specify sdk
as the version for any plugin, as that is the default.
The following example:
-
Assumes TinyMCE has already been loaded by another script on the page.
-
Attempts to load
mentions
v2.2
andpowerpaste
v5.5
from Tiny Cloud. -
Attempts to load
advcode
from the version bundled with version5
of TinyMCE because it doesn’t specify a version. -
Attempts to load all other premium plugins from the self-hosted installation.
<script src="https://cdn.tiny.cloud/1/no-api-key/tinymce/5/cloud-plugins.min.js?mentions=2.2&powerpaste=5.5&advcode" referrerpolicy="origin"></script>
The disadvantage of cloud-plugins.min.js
: every plugin to be loaded from Tiny Cloud must be added to the query parameter. When Tiny Cloud releases a new plugin, this will need to be updated. In situations where most premium plugins need to be loaded from Tiny Cloud, use plugins.min.js
.