https://github.com/aem/docs-soap

Library to clean up the clipboard contents generated by google docs
https://github.com/aem/docs-soap

draft-js draftjs google google-docs html javascript

Last synced: 3 months ago
JSON representation

Library to clean up the clipboard contents generated by google docs

• Host: GitHub
• URL: https://github.com/aem/docs-soap
• Owner: aem
• License: isc
• Created: 2016-06-08T15:04:22.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-02T13:16:24.000Z (over 6 years ago)
• Last Synced: 2024-10-04T13:34:47.985Z (4 months ago)
• Topics: draft-js, draftjs, google, google-docs, html, javascript
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/docs-soap
• Size: 92.8 KB
• Stars: 18
• Watchers: 2
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docs-soap [![Build Status](https://travis-ci.org/aem/docs-soap.svg?branch=master)](https://travis-ci.org/aem/docs-soap) [![npm version](https://badge.fury.io/js/docs-soap.svg)](https://badge.fury.io/js/docs-soap) [![codecov](https://codecov.io/gh/aem/docs-soap/branch/master/graph/badge.svg)](https://codecov.io/gh/aem/docs-soap)

docs-soap is a small (1.5kb minified/gzipped), simple library that can be used to transform clipboard contents from Google Docs into readable HTML. This library was born from the need to parse clipboard content from Google Docs into a [DraftJS](https://www.github.com/facebook/draft-js) Rich Text Editor and fits nicely into Draft's `handlePastedText` hook.

This project was developed for use in a client-side project. To use in a Node environment, your project will also require [jsdom-global](https://www.npmjs.com/package/jsdom-global).

### New in 1.2.1

* Comment are stripped from output. Fixes bug when pasting on Windows.

### Exported API

```js

module.exports = {

  default: docsSoap,

  docsSoap,

  parseHTML

};

```

### Testing

Tests are written in Mocha, using `expect` for assertions. `npm run test` will run all tests in the `test/` directory, allowing you to test the entire library's functionality at once. All contributions to the repository are expected to contain accompanying tests.

In the `examples/` directory, there's a simple HTML example that, after running `npm run build` in the project root, can be used to test your changes or just see the library in action.

### Installation

#### ESM

```bash

yarn add docs-soap

```

```js

import docsSoap from 'docs-soap';

```

#### CommonJS

```bash

yarn add docs-soap

```

```js

const docsSoap = require('docs-soap').default;

```

#### Script tag

```html

```

```js

var docsSoap = window.docsSoap;

```

### Usage

```js

const html =

  'bold textsome italic text';

const clean = docsSoap(html);

console.log(

  clean

); /* "some bold textsome italic text" */

```