Paste Clean-up in JavaScript Block Editor control

18 Nov 20183 minutes to read

The Block Editor control provides robust paste clean-up functionalities to ensure that pasted content integrates seamlessly and maintains styling and structural consistency. This feature helps remove unwanted formatting, scripts, and elements copied from external sources like web pages or word processors.

You can configure the paste behavior using the pasteCleanupSettings property, which allows you to define how content is handled when pasted into the editor.

Configuring allowed styles

The allowedStyles property lets you define which CSS styles are permitted in pasted content. Any style not in this list is stripped out, ensuring that only desired visual attributes are preserved.

By default, the following styles are allowed:

[‘font-weight’, ‘font-style’, ‘text-decoration’, ‘text-transform’].

In the below example, only font-weight and font-style styles will be retained from the pasted content. All other inline styles will be removed.

const editor = new BlockEditor({
    pasteCleanupSettings: {
        allowedStyles: ['font-weight', 'font-style']
    }
});

Setting denied tags

The deniedTags property specifies a list of HTML tags to be removed from pasted content. This is useful for stripping potentially problematic elements like <script> or <iframe> tags. By default, this property is an empty array, so no tags are removed.

In the below example, any <script> or <iframe> tags found in the pasted content will be removed, preventing unwanted behavior or styling issues.

const editor = new BlockEditor({
    pasteCleanupSettings: {
        deniedTags: ['script', 'iframe']
    }
});

Below example demonstrates the usage of paste settings that allows only specific styles and also removes the specific tags from the pasted content.

Disable Keep format

By default, the editor retains the formatting of pasted content (e.g., bold, italics, links). You can disable this by setting the keepFormat property to false. When disabled, the editor primarily pastes content as plain text, regardless of the allowedStyles configuration.

const editor = new BlockEditor({
    pasteCleanupSettings: {
        keepFormat: false
    }
});

Allowing plain text

To paste content as plain text, stripping all HTML tags and inline styles, set the plainText property to true in pasteCleanupSettings. This ensures that only raw text is inserted, which is ideal for maintaining strict content consistency. By default, this property is false.

const editor = new BlockEditor({
    pasteCleanupSettings: {
        plainText: true
    }
});

Below example demonstrates the usage of paste settings that disables the keep format and allows plain text.

Events

The Block Editor provides events to monitor and interact with the paste action.

Name	Args	Description
beforePasteCleanup	BeforePasteCleanupEventArgs	Triggers before the content is pasted into the editor.
afterPasteCleanup	AfterPasteCleanupEventArgs	Triggers after the content is pasted into the editor.

Below snippet demonstrates how to configure above events in the editor.

const editor = new BlockEditor({
    beforePasteCleanup: onBeforePasteCleanup()
});

const editor = new BlockEditor({
    afterPasteCleanup: onAfterPasteCleanup()
});