Merge branch 'main' into iminchev/virtualizer-ssr

lit · May 8, 2024 · 3c45d20 · 3c45d20
2 parents 435b10e + 56cb2ca
commit 3c45d20
Show file tree

Hide file tree

Showing 80 changed files with 1,536 additions and 242 deletions.
diff --git a/examples/nextjs/.eslintrc.json → examples/nextjs-v13/.eslintrc.json b/examples/nextjs/.eslintrc.json → examples/nextjs-v13/.eslintrc.json
diff --git a/examples/nextjs/.gitignore → examples/nextjs-v13/.gitignore b/examples/nextjs/.gitignore → examples/nextjs-v13/.gitignore
diff --git a/examples/nextjs/CHANGELOG.md → examples/nextjs-v13/CHANGELOG.md b/examples/nextjs/CHANGELOG.md → examples/nextjs-v13/CHANGELOG.md
@@ -1,4 +1,11 @@
-# @lit-examples/nextjs
+# @lit-examples/nextjs-v13
+
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies [[`aa4fc3ef`](https://github.com/lit/lit/commit/aa4fc3eff349b202861e597ef7554934b9eaa19a)]:
+ - @lit-labs/nextjs@0.2.0
 
 ## 0.1.1
 

diff --git a/examples/nextjs/README.md → examples/nextjs-v13/README.md b/examples/nextjs/README.md → examples/nextjs-v13/README.md
diff --git a/examples/nextjs/next.config.js → examples/nextjs-v13/next.config.js b/examples/nextjs/next.config.js → examples/nextjs-v13/next.config.js
diff --git a/examples/nextjs/package.json → examples/nextjs-v13/package.json b/examples/nextjs/package.json → examples/nextjs-v13/package.json
@@ -1,6 +1,6 @@
 {
- "name": "@lit-examples/nextjs",
- "version": "0.1.1",
+ "name": "@lit-examples/nextjs-v13",
+ "version": "0.1.2",
  "private": true,
  "scripts": {
  "dev": "next dev",
@@ -9,7 +9,7 @@
  "lint": "next lint"
  },
  "dependencies": {
- "@lit-labs/nextjs": "^0.1.2",
+ "@lit-labs/nextjs": "^0.2.0",
  "@lit/react": "^1.0.0",
  "@types/node": "^18.11.11",
  "@types/react": "^18.0.26",

diff --git a/examples/nextjs/pages/_app.tsx → examples/nextjs-v13/pages/_app.tsx b/examples/nextjs/pages/_app.tsx → examples/nextjs-v13/pages/_app.tsx
diff --git a/examples/nextjs/pages/index.tsx → examples/nextjs-v13/pages/index.tsx b/examples/nextjs/pages/index.tsx → examples/nextjs-v13/pages/index.tsx
diff --git a/examples/nextjs/public/flame-favicon.svg → examples/nextjs-v13/public/flame-favicon.svg b/examples/nextjs/public/flame-favicon.svg → examples/nextjs-v13/public/flame-favicon.svg
diff --git a/examples/nextjs/src/count-display.ts → examples/nextjs-v13/src/count-display.ts b/examples/nextjs/src/count-display.ts → examples/nextjs-v13/src/count-display.ts
diff --git a/examples/nextjs/src/simple-greeter-react.ts → ...es/nextjs-v13/src/simple-greeter-react.ts b/examples/nextjs/src/simple-greeter-react.ts → ...es/nextjs-v13/src/simple-greeter-react.ts
diff --git a/examples/nextjs/src/simple-greeter.ts → examples/nextjs-v13/src/simple-greeter.ts b/examples/nextjs/src/simple-greeter.ts → examples/nextjs-v13/src/simple-greeter.ts
diff --git a/examples/nextjs/styles/Home.module.css → examples/nextjs-v13/styles/Home.module.css b/examples/nextjs/styles/Home.module.css → examples/nextjs-v13/styles/Home.module.css
diff --git a/examples/nextjs/styles/globals.css → examples/nextjs-v13/styles/globals.css b/examples/nextjs/styles/globals.css → examples/nextjs-v13/styles/globals.css
diff --git a/examples/nextjs/tsconfig.json → examples/nextjs-v13/tsconfig.json b/examples/nextjs/tsconfig.json → examples/nextjs-v13/tsconfig.json
diff --git a/examples/nextjs-v14-app/.eslintrc.json b/examples/nextjs-v14-app/.eslintrc.json
@@ -0,0 +1,4 @@
+{
+ "root": true,
+ "extends": "next/core-web-vitals"
+}
diff --git a/examples/nextjs-v14-app/.gitignore b/examples/nextjs-v14-app/.gitignore
@@ -0,0 +1,40 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# Internal package links in lockfile will go out of date often.
+# External dependency versions are pinned in package.json instead.
+package-lock.json
diff --git a/examples/nextjs-v14-app/CHANGELOG.md b/examples/nextjs-v14-app/CHANGELOG.md
@@ -0,0 +1,8 @@
+# @lit-examples/nextjs-v14-app
+
+## 0.0.1
+
+### Patch Changes
+
+- Updated dependencies [[`aa4fc3ef`](https://github.com/lit/lit/commit/aa4fc3eff349b202861e597ef7554934b9eaa19a)]:
+ - @lit-labs/nextjs@0.2.0
diff --git a/examples/nextjs-v14-app/README.md b/examples/nextjs-v14-app/README.md
@@ -0,0 +1,9 @@
+# Lit in Next.js example
+
+This is a barebones demonstration of a Web Component authored with Lit working
+in a Next.js project with the App Router. You can also see an example of `@lit/react` usage.
+
+It uses the plugin from `@lit-labs/nextjs` to enable deep server rendering of
+Lit components.
+
+Note: Both bare custom elements and `@lit/react` wrapped components are placed in files with the `'use client';` directive. Deeply server rendering Lit components with declarative shadow DOM is not supported in React Server Components as React Flight server rendered data will contain the `<template>` element causing React hydration errors, and custom element definitions will not get included with client bundle.
diff --git a/examples/nextjs-v14-app/app/Home.module.css b/examples/nextjs-v14-app/app/Home.module.css
@@ -0,0 +1,52 @@
+.container {
+ padding: 0 2rem;
+}
+
+.main {
+ min-height: 100vh;
+ padding: 4rem 0;
+ flex: 1;
+ display: flex;
+ flex-direction: column;
+ justify-content: center;
+ align-items: center;
+}
+
+.title a {
+ color: #0070f3;
+ text-decoration: none;
+}
+
+.title a:hover,
+.title a:focus,
+.title a:active {
+ text-decoration: underline;
+}
+
+.title {
+ margin: 0;
+ line-height: 1.15;
+ font-size: 4rem;
+}
+
+.title,
+.description {
+ text-align: center;
+}
+
+.description {
+ margin: 4rem 0;
+ line-height: 1.5;
+ font-size: 1.5rem;
+}
+
+.description a {
+ color: #0070f3;
+ text-decoration: none;
+}
+
+.description a:hover,
+.description a:focus,
+.description a:active {
+ text-decoration: underline;
+}
diff --git a/examples/nextjs-v14-app/app/layout.tsx b/examples/nextjs-v14-app/app/layout.tsx
@@ -0,0 +1,14 @@
+import '../styles/globals.css';
+import type {Metadata} from 'next';
+
+export const metadata: Metadata = {
+ title: 'Lit in Next.js App Router',
+};
+
+export default function RootLayout({children}: {children: React.ReactNode}) {
+ return (
+ <html lang="en">
+ <body>{children}</body>
+ </html>
+ );
+}
diff --git a/examples/nextjs-v14-app/app/page.tsx b/examples/nextjs-v14-app/app/page.tsx
@@ -0,0 +1,27 @@
+import styles from './Home.module.css';
+import SimpleGreeter from './simple-greeter';
+import SimpleGreeterReact from '../src/simple-greeter-react';
+
+export default function Home() {
+ return (
+ <div className={styles.container}>
+ <main className={styles.main}>
+ <h1 className={styles.title}>
+ Welcome to <a href="https://lit.dev">Lit</a> and{' '}
+ <a href="https://nextjs.org">Next.js!</a>
+ </h1>
+ <p className={styles.description}>
+ The component below is a web component #builtWithLit
+ </p>
+ <SimpleGreeter name="Friend" />
+ <p className={styles.description}>
+ The component below is a component wrapped with{' '}
+ <a href="https://github.com/lit/lit/tree/main/packages/labs/react">
+ <code>@lit-labs/react</code>
+ </a>
+ </p>
+ <SimpleGreeterReact name="React" />
+ </main>
+ </div>
+ );
+}
diff --git a/examples/nextjs-v14-app/app/simple-greeter.tsx b/examples/nextjs-v14-app/app/simple-greeter.tsx
@@ -0,0 +1,7 @@
+'use client';
+
+import '../src/simple-greeter';
+
+export default function SimpleGreeter(props: any) {
+ return <simple-greeter {...props} />;
+}
diff --git a/examples/nextjs-v14-app/next.config.js b/examples/nextjs-v14-app/next.config.js
@@ -0,0 +1,11 @@
+const withLitSSR = require('@lit-labs/nextjs')({
+ addDeclarativeShadowDomPolyfill: true,
+});
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+ reactStrictMode: true,
+ swcMinify: true,
+};
+
+module.exports = withLitSSR(nextConfig);
diff --git a/examples/nextjs-v14-app/package.json b/examples/nextjs-v14-app/package.json
@@ -0,0 +1,25 @@
+{
+ "name": "@lit-examples/nextjs-v14-app",
+ "version": "0.0.1",
+ "private": true,
+ "scripts": {
+ "dev": "next dev",
+ "build": "next build",
+ "start": "next start",
+ "lint": "next lint"
+ },
+ "dependencies": {
+ "@lit-labs/nextjs": "^0.2.0",
+ "@lit/react": "^1.0.0",
+ "@types/node": "^18.11.11",
+ "@types/react": "^18.0.26",
+ "@types/react-dom": "^18.0.9",
+ "eslint": "^8.29.0",
+ "eslint-config-next": "^13.0.6",
+ "lit": "^3.0.0",
+ "next": "^14.1.0",
+ "react": "^18.2.0",
+ "react-dom": "^18.2.0",
+ "typescript": "~5.3.3"
+ }
+}
diff --git a/examples/nextjs-v14-app/public/flame-favicon.svg b/examples/nextjs-v14-app/public/flame-favicon.svg
diff --git a/examples/nextjs-v14-app/src/count-display.ts b/examples/nextjs-v14-app/src/count-display.ts
@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+import {LitElement, html} from 'lit';
+import {customElement, property} from 'lit/decorators.js';
+
+@customElement('count-display')
+export class CountDisplay extends LitElement {
+ @property({type: Number})
+ count = 0;
+ render() {
+ return html`<p>Count: ${this.count}</p>`;
+ }
+}
diff --git a/examples/nextjs-v14-app/src/simple-greeter-react.ts b/examples/nextjs-v14-app/src/simple-greeter-react.ts
@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+'use client';
+
+import React from 'react';
+import {createComponent} from '@lit/react';
+import {SimpleGreeter} from './simple-greeter';
+
+export default createComponent({
+ react: React,
+ tagName: 'simple-greeter',
+ elementClass: SimpleGreeter,
+});
diff --git a/examples/nextjs-v14-app/src/simple-greeter.ts b/examples/nextjs-v14-app/src/simple-greeter.ts
@@ -0,0 +1,70 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+import {LitElement, html, css} from 'lit';
+import {customElement, property} from 'lit/decorators.js';
+import type React from 'react';
+import './count-display';
+
+@customElement('simple-greeter')
+export class SimpleGreeter extends LitElement {
+ static styles = css`
+ div {
+ border: 1px solid black;
+ padding: 1rem;
+ display: flex;
+ flex-direction: column;
+ align-items: center;
+ }
+
+ @media (prefers-color-scheme: dark) {
+ div {
+ border-color: white;
+ }
+ }
+
+ span {
+ color: rebeccapurple;
+ }
+
+ p {
+ font-family: sans-serif;
+ }
+ `;
+
+ @property()
+ name = 'Somebody';
+
+ @property({type: Number})
+ count = 0;
+
+ render() {
+ return html`
+ <div>
+ <h1>Hello, <span>${this.name}</span>!</h1>
+ <count-display .count=${this.count}></count-display>
+ <button @click=${() => this.count++}>++</button>
+ </div>
+ `;
+ }
+}
+
+declare global {
+ interface HTMLElementTagNameMap {
+ 'simple-greeter': SimpleGreeter;
+ }
+
+ namespace JSX {
+ interface IntrinsicElements {
+ 'simple-greeter':
+ | React.DetailedHTMLProps<
+ React.HTMLAttributes<SimpleGreeter>,
+ SimpleGreeter
+ >
+ | Partial<SimpleGreeter>;
+ }
+ }
+}
diff --git a/examples/nextjs-v14-app/styles/globals.css b/examples/nextjs-v14-app/styles/globals.css
@@ -0,0 +1,26 @@
+html,
+body {
+ padding: 0;
+ margin: 0;
+ font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen,
+ Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif;
+}
+
+a {
+ color: inherit;
+ text-decoration: none;
+}
+
+* {
+ box-sizing: border-box;
+}
+
+@media (prefers-color-scheme: dark) {
+ html {
+ color-scheme: dark;
+ }
+ body {
+ color: white;
+ background: black;
+ }
+}