summaryrefslogtreecommitdiff
path: root/examples/framework-react
diff options
context:
space:
mode:
Diffstat (limited to 'examples/framework-react')
-rw-r--r--examples/framework-react/.codesandbox/Dockerfile1
-rw-r--r--examples/framework-react/.gitignore24
-rw-r--r--examples/framework-react/.vscode/extensions.json4
-rw-r--r--examples/framework-react/.vscode/launch.json11
-rw-r--r--examples/framework-react/README.md13
-rw-r--r--examples/framework-react/astro.config.mjs9
-rw-r--r--examples/framework-react/package.json20
-rw-r--r--examples/framework-react/public/favicon.svg9
-rw-r--r--examples/framework-react/src/components/Counter.css11
-rw-r--r--examples/framework-react/src/components/Counter.tsx25
-rw-r--r--examples/framework-react/src/pages/index.astro36
-rw-r--r--examples/framework-react/tsconfig.json9
12 files changed, 172 insertions, 0 deletions
diff --git a/examples/framework-react/.codesandbox/Dockerfile b/examples/framework-react/.codesandbox/Dockerfile
new file mode 100644
index 000000000..c3b5c81a1
--- /dev/null
+++ b/examples/framework-react/.codesandbox/Dockerfile
@@ -0,0 +1 @@
+FROM node:18-bullseye
diff --git a/examples/framework-react/.gitignore b/examples/framework-react/.gitignore
new file mode 100644
index 000000000..16d54bb13
--- /dev/null
+++ b/examples/framework-react/.gitignore
@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/
diff --git a/examples/framework-react/.vscode/extensions.json b/examples/framework-react/.vscode/extensions.json
new file mode 100644
index 000000000..22a15055d
--- /dev/null
+++ b/examples/framework-react/.vscode/extensions.json
@@ -0,0 +1,4 @@
+{
+ "recommendations": ["astro-build.astro-vscode"],
+ "unwantedRecommendations": []
+}
diff --git a/examples/framework-react/.vscode/launch.json b/examples/framework-react/.vscode/launch.json
new file mode 100644
index 000000000..d64220976
--- /dev/null
+++ b/examples/framework-react/.vscode/launch.json
@@ -0,0 +1,11 @@
+{
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "command": "./node_modules/.bin/astro dev",
+ "name": "Development server",
+ "request": "launch",
+ "type": "node-terminal"
+ }
+ ]
+}
diff --git a/examples/framework-react/README.md b/examples/framework-react/README.md
new file mode 100644
index 000000000..f036afa8c
--- /dev/null
+++ b/examples/framework-react/README.md
@@ -0,0 +1,13 @@
+# Astro + React Example
+
+```sh
+npm create astro@latest -- --template framework-react
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-react)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-react)
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-react/devcontainer.json)
+
+This example showcases Astro working with [React](https://react.dev).
+
+Write your React components as `.jsx` or `.tsx` files in your project.
diff --git a/examples/framework-react/astro.config.mjs b/examples/framework-react/astro.config.mjs
new file mode 100644
index 000000000..36ed34a5e
--- /dev/null
+++ b/examples/framework-react/astro.config.mjs
@@ -0,0 +1,9 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import react from '@astrojs/react';
+
+// https://astro.build/config
+export default defineConfig({
+ // Enable React to support React JSX components.
+ integrations: [react()],
+});
diff --git a/examples/framework-react/package.json b/examples/framework-react/package.json
new file mode 100644
index 000000000..c628d5d3f
--- /dev/null
+++ b/examples/framework-react/package.json
@@ -0,0 +1,20 @@
+{
+ "name": "@example/framework-react",
+ "type": "module",
+ "version": "0.0.1",
+ "private": true,
+ "scripts": {
+ "dev": "astro dev",
+ "build": "astro build",
+ "preview": "astro preview",
+ "astro": "astro"
+ },
+ "dependencies": {
+ "@astrojs/react": "^4.2.0",
+ "@types/react": "^18.3.18",
+ "@types/react-dom": "^18.3.5",
+ "astro": "^5.2.5",
+ "react": "^18.3.1",
+ "react-dom": "^18.3.1"
+ }
+}
diff --git a/examples/framework-react/public/favicon.svg b/examples/framework-react/public/favicon.svg
new file mode 100644
index 000000000..f157bd1c5
--- /dev/null
+++ b/examples/framework-react/public/favicon.svg
@@ -0,0 +1,9 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 128 128">
+ <path d="M50.4 78.5a75.1 75.1 0 0 0-28.5 6.9l24.2-65.7c.7-2 1.9-3.2 3.4-3.2h29c1.5 0 2.7 1.2 3.4 3.2l24.2 65.7s-11.6-7-28.5-7L67 45.5c-.4-1.7-1.6-2.8-2.9-2.8-1.3 0-2.5 1.1-2.9 2.7L50.4 78.5Zm-1.1 28.2Zm-4.2-20.2c-2 6.6-.6 15.8 4.2 20.2a17.5 17.5 0 0 1 .2-.7 5.5 5.5 0 0 1 5.7-4.5c2.8.1 4.3 1.5 4.7 4.7.2 1.1.2 2.3.2 3.5v.4c0 2.7.7 5.2 2.2 7.4a13 13 0 0 0 5.7 4.9v-.3l-.2-.3c-1.8-5.6-.5-9.5 4.4-12.8l1.5-1a73 73 0 0 0 3.2-2.2 16 16 0 0 0 6.8-11.4c.3-2 .1-4-.6-6l-.8.6-1.6 1a37 37 0 0 1-22.4 2.7c-5-.7-9.7-2-13.2-6.2Z" />
+ <style>
+ path { fill: #000; }
+ @media (prefers-color-scheme: dark) {
+ path { fill: #FFF; }
+ }
+ </style>
+</svg>
diff --git a/examples/framework-react/src/components/Counter.css b/examples/framework-react/src/components/Counter.css
new file mode 100644
index 000000000..fb21044d7
--- /dev/null
+++ b/examples/framework-react/src/components/Counter.css
@@ -0,0 +1,11 @@
+.counter {
+ display: grid;
+ font-size: 2em;
+ grid-template-columns: repeat(3, minmax(0, 1fr));
+ margin-top: 2em;
+ place-items: center;
+}
+
+.counter-message {
+ text-align: center;
+}
diff --git a/examples/framework-react/src/components/Counter.tsx b/examples/framework-react/src/components/Counter.tsx
new file mode 100644
index 000000000..cc416d3f1
--- /dev/null
+++ b/examples/framework-react/src/components/Counter.tsx
@@ -0,0 +1,25 @@
+import { useState } from 'react';
+import './Counter.css';
+
+export default function Counter({
+ children,
+ count: initialCount,
+}: {
+ children: JSX.Element;
+ count: number;
+}) {
+ const [count, setCount] = useState(initialCount);
+ const add = () => setCount((i) => i + 1);
+ const subtract = () => setCount((i) => i - 1);
+
+ return (
+ <>
+ <div className="counter">
+ <button onClick={subtract}>-</button>
+ <pre>{count}</pre>
+ <button onClick={add}>+</button>
+ </div>
+ <div className="counter-message">{children}</div>
+ </>
+ );
+}
diff --git a/examples/framework-react/src/pages/index.astro b/examples/framework-react/src/pages/index.astro
new file mode 100644
index 000000000..5bc1f8d36
--- /dev/null
+++ b/examples/framework-react/src/pages/index.astro
@@ -0,0 +1,36 @@
+---
+// Component Imports
+import Counter from '../components/Counter';
+const someProps = {
+ count: 0,
+};
+
+// Full Astro Component Syntax:
+// https://docs.astro.build/basics/astro-components/
+---
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width" />
+ <meta name="generator" content={Astro.generator} />
+ <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+ <style>
+ html,
+ body {
+ font-family: system-ui;
+ margin: 0;
+ }
+ body {
+ padding: 2rem;
+ }
+ </style>
+ </head>
+ <body>
+ <main>
+ <Counter {...someProps} client:visible>
+ <h1>Hello, React!</h1>
+ </Counter>
+ </main>
+ </body>
+</html>
diff --git a/examples/framework-react/tsconfig.json b/examples/framework-react/tsconfig.json
new file mode 100644
index 000000000..92a18df90
--- /dev/null
+++ b/examples/framework-react/tsconfig.json
@@ -0,0 +1,9 @@
+{
+ "extends": "astro/tsconfigs/strict",
+ "include": [".astro/types.d.ts", "**/*"],
+ "exclude": ["dist"],
+ "compilerOptions": {
+ "jsx": "react-jsx",
+ "jsxImportSource": "react"
+ }
+}