warrior 66f00d63c9 created page 5 months ago
..
types 66f00d63c9 created page 5 months ago
LICENSE 66f00d63c9 created page 5 months ago
README.md 66f00d63c9 created page 5 months ago
package.json 66f00d63c9 created page 5 months ago
ssr-window.esm.js 66f00d63c9 created page 5 months ago
ssr-window.umd.js 66f00d63c9 created page 5 months ago
ssr-window.umd.js.map 66f00d63c9 created page 5 months ago
ssr-window.umd.min.js 66f00d63c9 created page 5 months ago
ssr-window.umd.min.js.map 66f00d63c9 created page 5 months ago

README.md

SSR Window

Better handling for window and document object in SSR environment.

This library doesn't implement the DOM (like JSDOM), it just patches (or creates window and document objects) to avoid them to fail (throw errors) during server-side rendering.

Was created for use in:

Installation

Library available on NPM:

npm i ssr-window

Usage

import { window, document } from 'ssr-window';

window.addEventListener('resize', () => {});

const div = document.querySelectorAll('div');

Extending

If you rely on some window/document properties which are not included here, you can use extend helper to add them:

import { window, document, extend } from 'ssr-window';

// add window.navigator.language
extend(window, {
  navigator: {
    language: 'en',
  },
});

// add document.body
extend(document, {
  body: {
    /* ... */
  },
});

Contribution

Yes please! See the contributing guidelines for details.

Licence

This project is licensed under the terms of the MIT license.