PowerPaste Plugin

Contribute to this page

The TinyMCE PowerPaste plugin automatically cleans up content from Microsoft Word and HTML sources to ensure clean, compliant content that matches the look and feel of the site.

Usage

The PowerPaste plugin activates automatically when users paste content into the editor. For basic usage, users are not required to take any action - simply copy and paste content normally using keyboard shortcuts, the browser's "Paste" menu item (including from the context menu) or the TinyMCE "Paste" toolbar button.

To paste clipboard content as plain text, user's can click the "Paste As Text" toolbar button and then paste the content normally. The TinyMCE PowerPaste plugin will convert the HTML on the clipboard into plain text.

If you configure PowerPaste to allow local images (see the powerpaste_allow_local_images setting below) then images pasted from Microsoft Word and other sources will appear in TinyMCE as Base64 encoded images. You can have TinyMCE automatically upload Base64 encoded images for conversion back to a standard image as documented on the following page:

https://www.tinymce.com/docs/advanced/handle-async-image-uploads/

Note: PowerPaste (when configured to allow local images) will import images from pasted Microsoft Word/Excel content. When doing this, PowerPaste extracts Base64 encoded images from the clipboard. Images larger than approximately 8.5MB may fail to import based on technical limitations of web browsers.

Cloud Installation

To enable the TinyMCE PowerPaste plugin with TinyMCE Cloud:

  1. If you are currently using the paste plugin provided with TinyMCE, disable it by removing it from the plugins list.
  2. Add powerpaste to the plugins list.

Example TinyMCE configuration:

tinymce.init({
  selector: "textarea",  // change this value according to your HTML
  plugins: "powerpaste"
});

Self-hosted Installation

To enable the TinyMCE PowerPaste plugin:

  1. If you are currently using the paste plugin provided with TinyMCE, disable it by removing it from the plugins list.
  2. Copy the entire powerpaste folder (found in the ZIP that you downloaded) into the plugins directory of your TinyMCE installation. This is typically /tinymce/plugins.
  3. Add powerpaste to the plugins list in your TinyMCE configuration.

See the example TinyMCE configuration above.

Configuration Options

powerpaste_word_import

This setting controls how content being pasted from Microsoft Word is filtered. The supported values are:

Note: When using the Windows operating system, copying and pasting content from Word 2013 (or later) in "Protected View" will result in plain, unformatted text. This is due to how Protected View interacts with the clipboard.

powerpaste_html_import

This setting controls how content being pasted from sources other than Microsoft Word is filtered. Note that this includes content copied from TinyMCE itself. The supported values are:

powerpaste_block_drop

Due to browser limitations, it is not possible to filter content that is dragged and dropped into the editor. When powerpaste_block_drop is set to true the plugin will disable drag and dropping content into the editor. This prevents the unfiltered content from being introduced. Copy and paste is still enabled.

The default is false.

powerpaste_allow_local_images

When set to true Base 64 encoded images using a data URI in the copied content will not be removed after pasting.

The default is true.

Note: If you configure PowerPaste to allow local images you can have TinyMCE automatically upload Base64 encoded images for conversion back to a standard image as documented on the following page: https://www.tinymce.com/docs/advanced/handle-async-image-uploads

Example
tinymce.init({
  selector: "textarea",  // change this value according to your HTML
  plugins: "powerpaste",
  powerpaste_word_import: "clean",
  powerpaste_html_import: "merge"
});

Toolbar Buttons

pastetext

This button allows you to toggle paste as plain text mode on/off. When in plain text mode all rich formatted contents gets converted into plain text.

Example TinyMCE Configuration:

tinymce.init({
  selector: "textarea",
  plugins: "powerpaste",
  toolbar: "pastetext"
});

Menu Items

pastetext

This menu item allows you to toggle paste as plain text mode on/off. When in plain text mode all rich formatted contents gets converted into plain text.

Example TinyMCE Configuration:

tinymce.init({
  selector: "textarea",
  plugins: "powerpaste",
  menu: {
    edit: {title: "edit", items: "pastetext"}
  }
});

Advanced Config Options

Post filter callback

Developers can add customer filtering after PowerPaste filters are run using the post filter callback. This can be added as an init option or at runtime by adding the event listener.

Using the init option
tinymce.init({
  selector: "textarea",
  plugins: "powerpaste",
  paste_postprocess: function(editor, fragment) {
    // Fragment is a DocumentFragment node containing the DOM structure of the pasted content,
    // after it has been filtered by the PowerPaste plugin.
  var textnode = document.createTextNode("Added Text");
  // Modify the fragment via the argument - do not return a value!
  fragment.node.appendChild(textnode);
  }
});
Using an event listener
tinymce.get('editorID').('PastePostProcess', function(fragment) {
  // Fragment is a DocumentFragment node containing the DOM structure of the pasted content,
  // after it has been filtered by the PowerPaste plugin.
});

Buy TinyMCE PowerPaste

Start with our dedicated product page to see our flexible pricing options. OEM and enterprise customers should contact sales directly.

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.