Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/DennisSuitters/summernote-cleaner

Plugin for Summernote that adds a Button and/or Paste functionality for cleaning MS Word Crud from editor text
https://github.com/DennisSuitters/summernote-cleaner

addon clean crud office plugin summernote summernote-plugins toolbar word wysiwyg

Last synced: 3 months ago
JSON representation

Plugin for Summernote that adds a Button and/or Paste functionality for cleaning MS Word Crud from editor text

Host: GitHub
URL: https://github.com/DennisSuitters/summernote-cleaner
Owner: DennisSuitters
License: mit
Created: 2016-05-15T14:59:37.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-05-03T08:24:25.000Z (6 months ago)
Last Synced: 2024-05-03T20:22:52.590Z (6 months ago)
Topics: addon, clean, crud, office, plugin, summernote, summernote-plugins, toolbar, word, wysiwyg
Language: JavaScript
Homepage:
Size: 155 KB
Stars: 183
Watchers: 19
Forks: 112
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-summernote - summernote-cleaner

README

# summernote-cleaner v1.0.9
A plugin for the [Summernote](https://github.com/summernote/summernote/) WYSIWYG editor.

summernote-cleaner removes the unnecessary and possibly layout breaking Crud that gets added by MSWord, Open Office, and Libre Office Documents.

The plugin can function in a couple of different ways. It can have a Toolbar Button which allows the Cleaning of the Editor's Text, or Pasted Text can be Cleaned when Pasted into the Text Editor.

The plugin can also limit the number of characters, with options to display text and/or HTML count in the status bar area.

# Installation

#### 1. Include JS

Include the following code after Summernote:

```html

```

#### 2. Supported languages

Currently available in English!

#### 3. Summernote options

```javascript
$('.summernote').summernote({
toolbar: [
['cleaner',['cleaner']], // The Button
['style',['style']],
['font',['bold','italic','underline','clear']],
['fontname',['fontname']],
['color',['color']],
['para',['ul','ol','paragraph']],
['height',['height']],
['table',['table']],
['insert',['media','link','hr']],
['view',['fullscreen','codeview']],
['help',['help']]
],
cleaner: {
action: 'both', // both|button|paste 'button' only cleans via toolbar button, 'paste' only clean when pasting content, both does both options.
icon: '',
keepHtml: true,
keepTagContents: ['span'], //Remove tags and keep the contents
badTags: ['applet', 'col', 'colgroup', 'embed', 'noframes', 'noscript', 'script', 'style', 'title', 'meta', 'link', 'head'], //Remove full tags with contents
badAttributes: ['bgcolor', 'border', 'height', 'cellpadding', 'cellspacing', 'lang', 'start', 'style', 'valign', 'width', 'data-(.*?)'], //Remove attributes from remaining tags
limitChars: 0, // 0|# 0 disables option
limitDisplay: 'both', // none|text|html|both
limitStop: false, // true/false
limitType: 'text', // text|html
notTimeOut: 850, //time before status message is hidden in miliseconds
keepImages: true, // if false replace with imagePlaceholder
imagePlaceholder: 'https://via.placeholder.com/200'
}
});
```

# Documentation

**action:**
Options: ( both | button | paste )
- button = Only cleans via toolbar button.
- paste = Only cleans when pasting content.
- both = Does both of the above options.

**keepHtml:**
- true = Keeps HTML Markup and put through parser to remove Word Crud.
- false = Removes tag elements using the text version of the pasted content from the clipboard.

**keepTagContents**
Removes the tag but keeps the contents, e.g. useful for removing links or spans without losing text content

**badTags:**
Remove full tags with contents. Tags listed by name only `['style', 'script']`
NB: any tag not present in keepTagContents or badTags will remain

**badAttributes:**
Remove attributes from tags. Attributes listed by name only `['style', 'start']`

**limitChars:**
Limits the number of characters in the summernote
- false or 0 = allows for max input
- numbers > 0 = limit on number of characters

**limitDisplay:**
Shows in the status area the total html & text characters
Options: ( text | html | both )
- text = text character count only
- html = html character count only
- both = both html & text

**limitStop:**
Limits the number of characters set by limitChars.
- true = stops input
- false = doesn't stop input

**limitType**
Determines whether the limit is based on the text or html content length. Defaults to text if the option is not provided.
- text = uses the text content to calculate length for the limit
- html = uses the html content to calculate length for the limit

**imagePlaceholder:**
Replace pasted images with a nominated placeholder.

# Thanks:
- [RichardSquires](https://github.com/RichardSquires)
- Several issue regarding parsing text, and updating docs.
- [wheelspin](https://github.com/wheelspin)
- For adding Microsoft Browsers Support, and modifying the alert.
- [Diemen Design](https://github.com/DiemenDesign/)
- Check out our other Summernote Plugins via our main Github page.

# CHANGELOG:
#### v1.0.9
- Made image placeholder optional (many thanks to [DuncanHouston](https://github.com/DuncanHouston/))
#### v1.0.8
- Resolved issue where text like `` was accidentally counted as html when pasting from plain text context

#### v1.0.7
- Resolved issue in some cases where code view would be out of synch with editor

#### v1.0.6
- Added cleanup of data- attributes

#### v1.0.5
- Resolved tags/attributes not stripped when over one or more line
- Resolved spaces disappearing after pasting

#### v1.0.4
- Resolved sucess status text always shown after action

#### v1.0.3
- Added feature for removing a tag whilst keeping its content

#### v1.0.2
- Resolved paste plain text with keepHtml enabled bug
- Code cleanup

#### V1.0.1
- Remove keepOnlyTags, and keepClasses, they were origially intended to be used, but refinement and other options have taken their place.
- Reformat source looking for typos.
- Replace Images with a nominated placeholder.
- Replace `alt` attributes with `data-title` and `alt` used by Summernote.

# TODO:
- Implement Image conversion to base64, and hopefully automatic upload to destination folder.