collapse-whitespace
is a module for removing unnecessary whitespace from a DOM node.
Use npm
:
$ npm install collapse-whitespace
Then, if you’re using browserify
or something similar:
var collapse = require('collapse-whitespace')
Otherwise, just include the minified file, whitespace.min.js
, somewhere on your page, and this module will make itself available as collapse
:
<script src="./node_modules/collapse-whitespace/whitespace.min.js"></script>
var collapse = require('collapse-whitespace') var div = document.createElement('div') div.innerHTML = ' <p>Foo bar</p> <p>Words</p> ' collapse(div) console.log(div.innerHTML) // '<p>Foo bar</p><p>Words</p>'
For more examples of what collapse-whitespace
does, check out the test page.
collapse-whitespace
exposes a single function (called collapse
if you're including this module via a script
tag).
Removes all extraneous whitespace from the given node. By default, collapse-whitespace
relies on a theoretical list of block elements to determine which elements are block and which ones are inline. This list may be unsuitable for your needs; the optional parameter isBlock
can be used to tweak this behaviour. isBlock
should be a function that accepts a DOM node and returns a Boolean.
Note that collapse-whitespace
also does not take into account the parent(s) of the given node:
<pre> <span class="test"> Lots of whitespace around this text. </span> </pre> <script> collapse(document.querySelector('.test')) </script> <!-- Results in: --> <pre> <span class="test">Lots of whitespace around this text.</span> </pre>
By default only PRE
nodes have whitespace preserved, but this can be customized via the optional isPre
parameter. isPre
should be a function that accepts a DOM node and returns a Boolean.
MIT