Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Artem-Schander/quill-paste-smart
Quill.js module to paste only supported HTML
https://github.com/Artem-Schander/quill-paste-smart
clipboard paste quill tidy
Last synced: about 1 month ago
JSON representation
Quill.js module to paste only supported HTML
- Host: GitHub
- URL: https://github.com/Artem-Schander/quill-paste-smart
- Owner: Artem-Schander
- License: mit
- Created: 2020-04-24T23:48:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T19:27:47.000Z (over 1 year ago)
- Last Synced: 2024-05-02T04:51:43.897Z (7 months ago)
- Topics: clipboard, paste, quill, tidy
- Language: JavaScript
- Homepage:
- Size: 111 KB
- Stars: 78
- Watchers: 5
- Forks: 23
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-quill - quill-paste-smart - Paste only supported HTML (Uncategorized / Uncategorized)
README
# Quill Paste Smart
[](https://www.npmjs.com/package/quill-paste-smart?activeTab=versions)
[](https://bundlephobia.com/package/quill-paste-smart)
[](https://www.npmjs.com/package/quill-paste-smart)
[](https://github.com/Artem-Schander/quill-paste-smart/blob/master/LICENSE)
This plugin extends the default clipboard module of [Quill.js](https://github.com/quilljs/quill) 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](https://www.npmjs.com/) or with [yarn](https://yarnpkg.com/).
Run one of the following commands from your projects root in a bash prompt.
```bash
npm i quill-paste-smart
# or: yarn add quill-paste-smart
```
If you are using Quill v1, you must also install the [v1](https://github.com/Artem-Schander/quill-paste-smart/tree/legacy) of this package
```bash
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.
```javascript
import Quill from 'quill';
import 'quill-paste-smart';
```
### Demos
* Vanilla JS
* [ES6](https://il56g.csb.app/)
* [CommonJS](https://8rw3l.csb.app/)
* Vue
* [surmon-china/vue-quill-editor](https://bk79f.csb.app/)
* React
* [zenoamaro/react-quill](https://3di00.csb.app/)
* [gtgalone/react-quilljs](https://h3tut.csb.app/)
### 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:
```javascript
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);
```
> :raised_hand: **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` | 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` | 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` | 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` | The tags allowed when this custom button is present. |
| customButtons.allowedAttr | HTML attributes | `undefined` | `Array` | 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 `foo`. Note: This only works if there is nothing pasted except a valid URL. |
| hooks | [DOMPurify Hooks](https://github.com/cure53/DOMPurify#hooks) | `undefined` | `Array` | 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](https://github.com/cure53/DOMPurify/tree/main/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 `` tag. Here is a full example.
```html
<!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">
var quill = new Quill('#editor', {
theme: 'snow',
modules: {
toolbar: ['bold', 'italic', 'underline', 'link'],
}
});