Package Exports
- html-janitor
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (html-janitor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
html-janitor
Cleans up your markup and allows you to take control of your HTML.
HTMLJanitor uses a defined whitelist to limit HTML it is given to a defined subset.
Usage
var janitor = HTMLJanitor(options);
var sanitisedHtml = janitor.clean(html);
Options
A configuration object.
tags
defines a whitelist of elements that are allowed in the sanitised output. Each entry in the map should be the name of the element and the attributes that a valid for the element.
E.g. {tags: { p:{}, a: { href: true} }}
would limit the valid HTML subset to just paragraphs and anchor tags, the anchor tags would only have the href
attribute preserved.
Distribution
Uses UMD for support in AMD and Common JS environments.
Not suitable for Node
This library is designed for use in a browser and requires access to document and createTreeWalker to work.
Installation
bower install html-janitor
# or
npm install html-janitor
Development
To run unit tests:
npm install
npm run test