https://github.com/kkomelin/isomorphic-dompurify
Use DOMPurify on server and client in the same way
https://github.com/kkomelin/isomorphic-dompurify
dompurify html-escape isomorphic sanitize sanitize-html sanitizer security ssr universal wrapper xss xss-filter
Last synced: 5 months ago
JSON representation
Use DOMPurify on server and client in the same way
- Host: GitHub
- URL: https://github.com/kkomelin/isomorphic-dompurify
- Owner: kkomelin
- License: mit
- Created: 2020-03-17T16:09:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T03:25:08.000Z (5 months ago)
- Last Synced: 2025-05-13T09:09:04.973Z (5 months ago)
- Topics: dompurify, html-escape, isomorphic, sanitize, sanitize-html, sanitizer, security, ssr, universal, wrapper, xss, xss-filter
- Language: JavaScript
- Homepage:
- Size: 1.62 MB
- Stars: 474
- Watchers: 5
- Forks: 16
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Isomorphic DOMPurify
[](https://badge.fury.io/js/isomorphic-dompurify)
[](https://github.com/kkomelin/isomorphic-dompurify/actions/workflows/build_test.yml)
[](https://bundlephobia.com/result?p=isomorphic-dompurify)
The library makes it possible to seamlessly use [DOMPurify](https://github.com/cure53/DOMPurify) on server and client in the same way.
It does nothing by itself except providing an isomorphic/universal wrapper around DOMPurify, so all credits go to DOMPurify authors and contributors.
> DOMPurify - a DOM-only, super-fast, uber-tolerant XSS sanitizer for HTML, MathML and SVG. DOMPurify works with a secure default, but offers a lot of configurability and hooks.
- [DOMPurify Demo](https://cure53.de/purify)
- [DOMPurify Documentation](https://github.com/cure53/DOMPurify/blob/master/README.md)
## Motivation
DOMPurify needs a DOM tree to base on, which is not available in Node by default. To work on the server side, we need a fake DOM to be created and supplied to DOMPurify. It means that DOMPurify initialization logic on the server is not the same as on the client.
This project was born with the idea of encapsulating DOMPurify initialization details and providing an easy way to import the library on both, server and client, for example in Next.js apps.
It was inspired by [Isomorphic Unfetch](https://github.com/developit/unfetch/tree/master/packages/isomorphic-unfetch).
## Requirements
| isomorphic-dompurify | Node.js | Environment |
| ------------- | ------------- | ------------- |
| `<=0.19.0` | `>=12` | Server |
| `>=0.20.0` | `>=14` | Server |
| `>=1.4.0` | `>=16` | Server |
| `>=1.10.0` | `>=18` | Server |
## Installation
```shell_script
$ npm i isomorphic-dompurify
```
## Updates
Please note that DOMPurify library [doesn't follow Semantic Versioning](https://github.com/cure53/DOMPurify/issues/446#issuecomment-643761433), so we have to release every change as a minor version because we cannot be 100% sure whether new features are added to patch DOMPurify releases or not.
## Usage
Import:
```javascript
import DOMPurify from "isomorphic-dompurify";
```
_Importing the entire module for the client/browser version is recommended._
Sanitize:
```javascript
const clean = DOMPurify.sanitize(dirtyString);
```
or with [config](https://github.com/cure53/DOMPurify/blob/main/README.md):
```javascript
const clean = DOMPurify.sanitize(dirtyString, { USE_PROFILES: { html: true } });
```
## Known Issues
1. Next.js and Remix are mistakenly trying to use the `browser` entry point on server, which causes the `Window is not defined` issue. [#228](https://github.com/kkomelin/isomorphic-dompurify/issues/228) [#214](https://github.com/kkomelin/isomorphic-dompurify/issues/214) https://github.com/vercel/next.js/discussions/58142
2. [Can't resolve 'canvas' on Next.js serverless app](https://github.com/kkomelin/isomorphic-dompurify/issues/54)
## License
DOMPurify -
[Apache 2.0 or MPL 2.0](https://github.com/cure53/DOMPurify/blob/master/LICENSE)
© 2015 Mario Heiderich
Isomorphic DOMPurify - [MIT License](LICENSE) © 2020 [Konstantin Komelin](https://github.com/kkomelin) and [contributors](https://github.com/kkomelin/isomorphic-dompurify/graphs/contributors)