Skip to content

Latest commit

 

History

History
157 lines (123 loc) · 10 KB

README.md

File metadata and controls

157 lines (123 loc) · 10 KB
Raw

Quill Paste Smart

npm npm bundle size npm NPM

This plugin extends the default clipboard module of Quill.js to prevent users from pasting HTML that does not belong into the editor. To do so it looks into the toolbar configuration and decides which tags and attributes are allowed based on the possible formats.
However, you can also decide on your own, what is allowed.


Installation

You can install this plugin either with npm or with yarn.
Run one of the following commands from your projects root in a bash prompt.

npm i quill-paste-smart
# or: yarn add quill-paste-smart

If you are using Quill v1, you must also install the v1 of this package

npm i quill-paste-smart@^1
# or: yarn add quill-paste-smart@^1

Usage

Since this plugin registers itself, it is sufficient to just import it.

import Quill from 'quill';
import 'quill-paste-smart';

Demos


Configuration

Out of the box this plugin will remove all HTML tags and attributes that are not available in the toolbar formats.
If you don't agree with the default settings, you can decide what is allowed by yourself.
Also I thought it could be useful to keep the pasted content selected after pasting, so there is a setting for it too.

A valid configuration could look like this:

const options = {
    theme: 'snow',
    modules: {
        clipboard: {
            allowed: {
                tags: ['a', 'b', 'strong', 'u', 's', 'i', 'p', 'br', 'ul', 'ol', 'li', 'span'],
                attributes: ['href', 'rel', 'target', 'class']
            },
            customButtons: [
                {
                    module: 'quillEmbeds',
                    allowedTags: ['embed'],
                    allowedAttr: ['width', 'height'],
                }
            ],
            keepSelection: true,
            substituteBlockElements: true,
            magicPasteLinks: true,
            hooks: {
                uponSanitizeElement(node, data, config) {
                    console.log(node);
                },
            },

            handleImagePaste(image) {
                console.log("Image file pasted", image);
            },
            removeConsecutiveSubstitutionTags: true
        },
    },
};
new Quill('#editor', options);

✋ Probably you don't need a custom configuration.
You could stick with the default settings by completely omit the clipboard object in your quill options.

Configuration Object

key valid values default value type description
allowed.tags HTML tags undefined Array<string> Here you can define any HTML tag that should be allowed to be pasted. If this setting is not specified, allowed tags are determined by possible formats in the toolbar
allowed.attributes HTML attributes undefined Array<string> Here you can define any HTML attributes that should be allowed to be pasted. If this setting is not specified, allowed attributes are determined by possible formats in the toolbar
customButtons Array of button description objects undefined Array<object> Here you can add custom toolbar buttons with the associated tags and attributes that are allowed in relation to those buttons.
customButtons.module String undefined string The module name used in the toolbar button definition
customButtons.allowedTags HTML tags undefined Array<string> The tags allowed when this custom button is present.
customButtons.allowedAttr HTML attributes undefined Array<string> The attributes allowed when this custom button is present.
substituteBlockElements true false true Boolean If this setting is set to true all forbidden block type tags will be substituted by one of the allowed tags p/div/section
keepSelection true false false Boolean If this setting is set to true the pasted content will be selected after pasting it. Otherwise the cursor will be placed right after the pasted content
magicPasteLinks true false false Boolean If this setting is set to true pasted URLs over selected text will be converted to an a tag. Example: If you select the word foo and paste the URL https://foo.bar/ the result will be <a href="https://foo.bar/">foo</a>. Note: This only works if there is nothing pasted except a valid URL.
hooks DOMPurify Hooks undefined Array<function> Here you can define any of the DOMPurify hooks. This can be handy if you need to cusomtize the HTML sanitizer. For more information see the hook demos from DOMPurify.
BE AWARE
Here you can mess up things. E.g. You could create an infinite loop by adding not allowed tags to the node.
handleImagePaste function (File) undefined function (File) Here you can define custom behavior for handling images being pasted, you can use this to upload the image to a CDN rather than embedding
removeConsecutiveSubstitutionTags true false undefined Boolean If this setting is set to true the pasted content will have consecutive occurances of the chosen substitution element removed after pasting it. Otherwise the the pasted conntent will not be affected. Note this setting is in effect only when substituteBlockElements is not false.

CommonJS

It is possible to use this module by including it though a <script> tag. Here is a full example.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Quill Paste Smart</title>
    <link href="https://unpkg.com/quill@latest/dist/quill.snow.css" rel="stylesheet">
</head>
<body>
    <div id="editor"></div>

    <script src="https://unpkg.com/quill@latest/dist/quill.js"></script>
    <script src="https://unpkg.com/quill-paste-smart@latest/dist/quill-paste-smart.js"></script>

    <script>
        var quill = new Quill('#editor', {
            theme: 'snow',
            modules: {
                toolbar: ['bold', 'italic', 'underline', 'link'],
            }
        });
    </script>
</body>
</html>

License

This plugin is licensed under the terms of the MIT License (See LICENSE file for details).