-
-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#1215@minor: Adds support for a new package called happy-dom-without-…
…nodejs.
- Loading branch information
1 parent
52487a2
commit 1379a54
Showing
35 changed files
with
667 additions
and
333 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# EditorConfig is awesome: http://EditorConfig.org | ||
|
||
# top-most EditorConfig file | ||
root = true | ||
|
||
# Indentation override for all JS under lib directory | ||
[{**.js,**.ts,**.json}] | ||
indent_style = tab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
node_modules | ||
tmp | ||
lib | ||
src | ||
cjs | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
node_modules | ||
tmp | ||
test | ||
bin | ||
polyfills | ||
.turbo | ||
npm-shrinkwrap.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
module.exports = { | ||
singleQuote: true, | ||
useTabs: true, | ||
printWidth: 100, | ||
trailingComma: 'none' | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019 David Ortner (capricorn86) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
![Happy DOM Logo](https://github.com/capricorn86/happy-dom/raw/master/docs/happy-dom-logo.jpg) | ||
|
||
# About | ||
|
||
[Happy DOM](https://github.com/capricorn86/happy-dom) is a JavaScript implementation of a web browser without its graphical user interface. It includes many web standards from WHATWG [DOM](https://dom.spec.whatwg.org/) and [HTML](https://html.spec.whatwg.org/multipage/). | ||
|
||
The goal of [Happy DOM](https://github.com/capricorn86/happy-dom) is to emulate enough of a web browser to be useful for testing, scraping web sites and server-side rendering. | ||
|
||
[Happy DOM](https://github.com/capricorn86/happy-dom) focuses heavily on performance and can be used as an alternative to [JSDOM](https://github.com/jsdom/jsdom). | ||
|
||
### DOM Features | ||
|
||
- Custom Elements (Web Components) | ||
|
||
- Shadow Root (Shadow DOM) | ||
|
||
- Declarative Shadow DOM | ||
|
||
- Mutation Observer | ||
|
||
- Tree Walker | ||
|
||
- Fetch | ||
|
||
And much more.. | ||
|
||
### Works With | ||
|
||
- [Google LitHTML](https://lit-html.polymer-project.org) | ||
|
||
- [Google LitElement](https://lit-element.polymer-project.org) | ||
|
||
- [React](https://reactjs.org) | ||
|
||
- [Angular](https://angular.io/) | ||
|
||
- [Vue](https://vuejs.org/) | ||
|
||
### Module Systems | ||
|
||
- [ESM](https://nodejs.org/api/esm.html#introduction) | ||
- [CommonJS](https://nodejs.org/api/modules.html#modules-commonjs-modules) | ||
|
||
# Installation | ||
|
||
```bash | ||
npm install happy-dom | ||
``` | ||
|
||
# Usage | ||
|
||
Happy DOM can be used as a simulated [Browser](https://github.com/capricorn86/happy-dom/wiki/Browser) or by using the [Window](https://github.com/capricorn86/happy-dom/wiki/Window) class directly to quickly setup up a DOM. | ||
|
||
## Window | ||
|
||
```javascript | ||
import { Window } from 'happy-dom'; | ||
|
||
const window = new Window({ url: 'https://localhost:8080' }); | ||
const document = window.document; | ||
|
||
document.body.innerHTML = '<div class="container"></div>'; | ||
|
||
const container = document.querySelector('.container'); | ||
const button = document.createElement('button'); | ||
|
||
container.appendChild(button); | ||
|
||
// Outputs "<div class="container"><button></button></div>" | ||
console.log(document.body.innerHTML); | ||
``` | ||
|
||
## Browser | ||
|
||
```javascript | ||
import { Browser, BrowserErrorCaptureEnum } from 'happy-dom'; | ||
|
||
const browser = new Browser({ settings: { errorCapture: BrowserErrorCaptureEnum.processLevel } }); | ||
const page = browser.newPage(); | ||
|
||
// Navigates page | ||
await page.goto('https://github.com/capricorn86'); | ||
|
||
// Clicks on link | ||
page.mainFrame.document.querySelector('a[href*="capricorn86/happy-dom"]').click(); | ||
|
||
// Waits for all operations on the page to complete (fetch, timers etc.) | ||
await page.waitUntilComplete(); | ||
|
||
// Outputs "GitHub - capricorn86/happy-dom: Happy DOM..." | ||
console.log(page.mainFrame.document.title); | ||
|
||
// Closes the browser | ||
await browser.close(); | ||
``` | ||
|
||
# Documentation | ||
|
||
Read more about how to use Happy DOM in our [Wiki](https://github.com/capricorn86/happy-dom/wiki). | ||
|
||
# Performance | ||
|
||
| Operation | JSDOM | Happy DOM | | ||
| ------------------------------------ | ------- | --------- | | ||
| Import / Require | 333 ms | 45 ms | | ||
| Parse HTML | 256 ms | 26 ms | | ||
| Serialize HTML | 65 ms | 8 ms | | ||
| Render custom element | 214 ms | 19 ms | | ||
| querySelectorAll('tagname') | 4.9 ms | 0.7 ms | | ||
| querySelectorAll('.class') | 6.4 ms | 3.7 ms | | ||
| querySelectorAll('[attribute]') | 4.0 ms | 1.7 ms | | ||
| querySelectorAll('[class~="name"]') | 5.5 ms | 2.9 ms | | ||
| querySelectorAll(':nth-child(2n+1)') | 10.4 ms | 3.8 ms | | ||
|
||
See how the test was done [here](https://github.com/capricorn86/happy-dom-performance-test) | ||
|
||
# Jest | ||
|
||
Happy DOM provide with a package called [@happy-dom/jest-environment](https://github.com/capricorn86/happy-dom/tree/master/packages/jest-environment) that makes it possible to use Happy DOM with [Jest](https://jestjs.io/). | ||
|
||
# Vitest | ||
|
||
[Vitest](https://github.com/vitest-dev/vitest) supports Happy DOM out of the box. | ||
|
||
# Global Registration | ||
|
||
Happy DOM provide with a package called [@happy-dom/global-registrator](https://github.com/capricorn86/happy-dom/tree/master/packages/global-registrator) that can register Happy DOM globally. It makes it possible to use Happy DOM for testing in a Node environment. | ||
|
||
# Sponsors | ||
|
||
[<img alt="RTVision" width="120px" src="https://avatars.githubusercontent.com/u/8292810?s=200&v=4" />](https://rtvision.com) |
Oops, something went wrong.