Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[labs/react] Add Node build #3410

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/eight-elephants-sparkle.md
@@ -0,0 +1,5 @@
---
'@lit-labs/react': minor
---

Add Node build for server rendering. This will allow wrapped components to be added to SSR React frameworks like Next.js.
1 change: 1 addition & 0 deletions .eslintignore
Expand Up @@ -241,6 +241,7 @@ packages/labs/observers/performance_controller.*
packages/labs/observers/resize_controller.*
packages/labs/observers/intersection_controller.*
packages/labs/react/development/
packages/labs/react/node/
packages/labs/react/test/
packages/labs/react/node_modules/
packages/labs/react/index.*
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
Expand Up @@ -227,6 +227,7 @@ packages/labs/observers/performance_controller.*
packages/labs/observers/resize_controller.*
packages/labs/observers/intersection_controller.*
packages/labs/react/development/
packages/labs/react/node/
packages/labs/react/test/
packages/labs/react/node_modules/
packages/labs/react/index.*
Expand Down
1 change: 1 addition & 0 deletions packages/labs/react/.gitignore
@@ -1,4 +1,5 @@
/development/
/node/
/test/
/node_modules/
/index.*
Expand Down
14 changes: 13 additions & 1 deletion packages/labs/react/package.json
Expand Up @@ -20,17 +20,20 @@
".": {
"types": "./development/index.d.ts",
"development": "./development/index.js",
"node": "./node/index.js",
"default": "./index.js"
},
"./use-controller.js": {
"types": "./development/use-controller.d.ts",
"development": "./development/use-controller.js",
"node": "./node/use-controller.js",
"default": "./use-controller.js"
}
},
"files": [
"/development/",
"!/development/test/",
"/node/",
"/index.{d.ts,d.ts.map,js,js.map}",
"/create-component.{d.ts,d.ts.map,js,js.map}",
"/use-controller.{d.ts,d.ts.map,js,js.map}"
Expand All @@ -43,6 +46,7 @@
"test": "wireit",
"test:dev": "wireit",
"test:prod": "wireit",
"test:node": "wireit",
"checksize": "wireit"
},
"wireit": {
Expand Down Expand Up @@ -111,7 +115,8 @@
"test": {
"dependencies": [
"test:dev",
"test:prod"
"test:prod",
"test:node"
]
},
"test:dev": {
Expand All @@ -133,6 +138,13 @@
],
"files": [],
"output": []
},
"test:node": {
"command": "node development/test/node-render.js",
"dependencies": [
"build:ts",
"build:rollup"
]
}
},
"author": "Google LLC",
Expand Down
1 change: 1 addition & 0 deletions packages/labs/react/rollup.config.js
Expand Up @@ -10,4 +10,5 @@ import {createRequire} from 'module';
export default litProdConfig({
packageName: createRequire(import.meta.url)('./package.json').name,
entryPoints: ['index', 'create-component', 'use-controller'],
includeNodeBuild: true,
});
8 changes: 8 additions & 0 deletions packages/labs/react/src/create-component.ts
Expand Up @@ -4,6 +4,14 @@
* SPDX-License-Identifier: BSD-3-Clause
*/

const NODE_MODE = false;
taylor-vann marked this conversation as resolved.
Show resolved Hide resolved
const global = NODE_MODE ? globalThis : window;

const htmlElementShimNeeded = NODE_MODE && global.HTMLElement === undefined;
if (htmlElementShimNeeded) {
augustjk marked this conversation as resolved.
Show resolved Hide resolved
global.HTMLElement = class HTMLElement {} as unknown as typeof HTMLElement;
}

// Match a prop name to a typed event callback by
// adding an Event type as an expected property on a string.
export type EventName<T extends Event = Event> = string & {
Expand Down
25 changes: 25 additions & 0 deletions packages/labs/react/src/test/node-render.ts
@@ -0,0 +1,25 @@
/**
* @license
* Copyright 2022 Google LLC
* SPDX-License-Identifier: BSD-3-Clause
*/

// This file will be loaded by Node from the node:test script to verify that
// wrapped components can be server rendered by React.

import {createComponent} from '@lit-labs/react';
import {ReactiveElement} from '@lit/reactive-element';
import {customElement} from '@lit/reactive-element/decorators/custom-element.js';
import React from 'react';
import {renderToString} from 'react-dom/server.js';

@customElement('my-element')
class MyElement extends ReactiveElement {}

const Component = createComponent({
react: React,
tagName: 'my-element',
elementClass: MyElement,
});

renderToString(React.createElement(Component));