Miss any of our Open RFC calls?Watch the recordings here! »

quill-paste-smart

1.2.1 • Public • Published

Quill Paste Smart

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 

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']
            },
            keepSelection: true,
        },
    },
};
new Quill('#editor', options);

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).

Install

npm i quill-paste-smart

DownloadsWeekly Downloads

767

Version

1.2.1

License

MIT

Unpacked Size

27.7 kB

Total Files

4

Last publish

Collaborators

  • avatar