@hide-in-shadows/react v0.0.4

Hide In Shadows

A small, zero dependency library for wrapping React apps in declarative shadow DOM.

Usage

Installation

npm install @hide-in-shadows/react react react-dom

Server Side Rendered React

If you want to SSR your React app while isolating it inside the shadow dom, read on...

Server code

import { server } from "@hide-in-shadows/react/server";
import App from "./app.js"; // your React app component. You will need to bundle this if it is in JSX.

const options = {
    props, // a props object for your app. This will be serialised and made available when hydrating on the client side.
    styles, // inline styles to be included in the shadow dom. Inlining styles is good for avoiding FOUC issues. See example below.
    replacer, // function to control how objects are serialized. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
    mode = "open" // shadow dom mode See https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM. Defaults to "open"
}
const rendered = server(
    "hide-in-shadows-example", // name to use for custom element in the DOM
    App, // either a React component OR a pre rendered string
    options // additional options
);

// you should then respond with "rendered" from your server

Client code

import { client } from "@hide-in-shadows/react";
import App from "./app.js"; // your React app component.

const options = {
  reviver, // function to control how the DOM serialised props object is deserialised. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse.
};
// calling this method will cause it to hydrate the DOM that was setup in the server code section above.
hydrate("hide-in-shadows-example", App, options);

Example reviver usage

The following example shows using the reviver function to regenerate URL objects for a prop called "url".

Server Side

import { server } from "@hide-in-shadows/react/server";
import App from "./app.js";

server("my-app", App, {
  props: { url: new URL("https://example.com") },
});

Client Side

import { client } from "@hide-in-shadows/react";
import App from "./app.js";

hydrate("my-app", App, {
  reviver: (key, value) => {
    if (key === "url") return new URL(value);
    return value;
  },
});

Example manually rendering

The following example shows pre rendering a string to pass to the server function for cases where you need more control.

Server Side

import ReactDOM from "react-dom/server"
import { server } from "@hide-in-shadows/react/server";
import App from "./app.js";

const app = ReactDOM.renderToString(React.createElement(App))
server("my-app", app);

If you need to pass props to your app, be sure to pass them to the server function for serialisation

import ReactDOM from "react-dom/server"
import { server } from "@hide-in-shadows/react/server";
import App from "./app.js";

const props = { ... }
const app = ReactDOM.renderToString(React.createElement(App, props))
server("my-app", app, { props });

Example styles usage

It is generally prefereable to use inline styles rather than external URLs when working with the shadow dom due to the fact that content can display unstyled while external style URLs are fetched. Using a library such as Tailwind that allows you to purge your CSS down to a minimum can help with this though you are free to provide any styles you wish. If you do still plan on using an external stylesheet, include a link tag in your app and be sure to preload the URL in the document head to help avoid a flash of unstyled content.

Server Side

import { server } from "@hide-in-shadows/react/server";
import App from "./app.js";

server("my-app", App, {
  styles: `
    h1 {
        background-color: hotpink;
    }
  `,
});

or, read in the contents of an external stylesheet like so:

import { server } from "@hide-in-shadows/react/server";
import fs from "node:fs/promises";
import App from "./app.js";

const styles = await fs.readFile(
  new URL("./styles.css", import.meta.url),
  "utf8"
);
server("my-app", App, { styles });

Styles added in these ways will be encapsulated inside the shadow dom.