diff options
Diffstat (limited to 'examples/framework-multiple')
16 files changed, 314 insertions, 0 deletions
diff --git a/examples/framework-multiple/.codesandbox/Dockerfile b/examples/framework-multiple/.codesandbox/Dockerfile new file mode 100644 index 000000000..c3b5c81a1 --- /dev/null +++ b/examples/framework-multiple/.codesandbox/Dockerfile @@ -0,0 +1 @@ +FROM node:18-bullseye diff --git a/examples/framework-multiple/.gitignore b/examples/framework-multiple/.gitignore new file mode 100644 index 000000000..16d54bb13 --- /dev/null +++ b/examples/framework-multiple/.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-multiple/.vscode/extensions.json b/examples/framework-multiple/.vscode/extensions.json new file mode 100644 index 000000000..22a15055d --- /dev/null +++ b/examples/framework-multiple/.vscode/extensions.json @@ -0,0 +1,4 @@ +{ + "recommendations": ["astro-build.astro-vscode"], + "unwantedRecommendations": [] +} diff --git a/examples/framework-multiple/.vscode/launch.json b/examples/framework-multiple/.vscode/launch.json new file mode 100644 index 000000000..d64220976 --- /dev/null +++ b/examples/framework-multiple/.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-multiple/README.md b/examples/framework-multiple/README.md new file mode 100644 index 000000000..30b020eff --- /dev/null +++ b/examples/framework-multiple/README.md @@ -0,0 +1,13 @@ +# Kitchen Sink: Microfrontends with Astro + +```sh +npm create astro@latest -- --template framework-multiple +``` + +[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/framework-multiple) +[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/framework-multiple) +[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/framework-multiple/devcontainer.json) + +This example showcases Astro's built-in support for multiple frameworks ([React](https://react.dev), [Preact](https://preactjs.com), [Svelte](https://svelte.dev), and [Vue (`v3.x`)](https://v3.vuejs.org/)). + +No configuration is needed to enable these frameworks—just start writing components in `src/components`. diff --git a/examples/framework-multiple/astro.config.mjs b/examples/framework-multiple/astro.config.mjs new file mode 100644 index 000000000..7609d3fc6 --- /dev/null +++ b/examples/framework-multiple/astro.config.mjs @@ -0,0 +1,19 @@ +// @ts-check +import { defineConfig } from 'astro/config'; +import preact from '@astrojs/preact'; +import react from '@astrojs/react'; +import svelte from '@astrojs/svelte'; +import vue from '@astrojs/vue'; +import solid from '@astrojs/solid-js'; + +// https://astro.build/config +export default defineConfig({ + // Enable many frameworks to support all different kinds of components. + integrations: [ + preact({ include: ['**/preact/*'] }), + solid({ include: ['**/solid/*'] }), + react({ include: ['**/react/*'] }), + svelte(), + vue(), + ], +}); diff --git a/examples/framework-multiple/package.json b/examples/framework-multiple/package.json new file mode 100644 index 000000000..c7b44b7b7 --- /dev/null +++ b/examples/framework-multiple/package.json @@ -0,0 +1,28 @@ +{ + "name": "@example/framework-multiple", + "type": "module", + "version": "0.0.1", + "private": true, + "scripts": { + "dev": "astro dev", + "build": "astro build", + "preview": "astro preview", + "astro": "astro" + }, + "dependencies": { + "@astrojs/preact": "^4.0.4", + "@astrojs/react": "^4.2.0", + "@astrojs/solid-js": "^5.0.4", + "@astrojs/svelte": "^7.0.4", + "@astrojs/vue": "^5.0.6", + "@types/react": "^18.3.18", + "@types/react-dom": "^18.3.5", + "astro": "^5.2.5", + "preact": "^10.25.4", + "react": "^18.3.1", + "react-dom": "^18.3.1", + "solid-js": "^1.9.4", + "svelte": "^5.19.7", + "vue": "^3.5.13" + } +} diff --git a/examples/framework-multiple/public/favicon.svg b/examples/framework-multiple/public/favicon.svg new file mode 100644 index 000000000..f157bd1c5 --- /dev/null +++ b/examples/framework-multiple/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-multiple/src/components/preact/PreactCounter.tsx b/examples/framework-multiple/src/components/preact/PreactCounter.tsx new file mode 100644 index 000000000..5ad164cc2 --- /dev/null +++ b/examples/framework-multiple/src/components/preact/PreactCounter.tsx @@ -0,0 +1,22 @@ +/** @jsxImportSource preact */ + +import { useState } from 'preact/hooks'; +import type { ComponentChildren } from 'preact'; + +/** A counter written with Preact */ +export function PreactCounter({ children }: { children?: ComponentChildren }) { + const [count, setCount] = useState(0); + const add = () => setCount((i) => i + 1); + const subtract = () => setCount((i) => i - 1); + + return ( + <> + <div class="counter"> + <button onClick={subtract}>-</button> + <pre>{count}</pre> + <button onClick={add}>+</button> + </div> + <div class="counter-message">{children}</div> + </> + ); +} diff --git a/examples/framework-multiple/src/components/react/ReactCounter.tsx b/examples/framework-multiple/src/components/react/ReactCounter.tsx new file mode 100644 index 000000000..84681035d --- /dev/null +++ b/examples/framework-multiple/src/components/react/ReactCounter.tsx @@ -0,0 +1,21 @@ +/** @jsxImportSource react */ + +import { useState, type ReactNode } from 'react'; + +/** A counter written with React */ +export function Counter({ children }: { children?: ReactNode }) { + const [count, setCount] = useState(0); + 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-multiple/src/components/solid/SolidCounter.tsx b/examples/framework-multiple/src/components/solid/SolidCounter.tsx new file mode 100644 index 000000000..cb9219608 --- /dev/null +++ b/examples/framework-multiple/src/components/solid/SolidCounter.tsx @@ -0,0 +1,21 @@ +/** @jsxImportSource solid-js */ + +import { createSignal, type JSX } from 'solid-js'; + +/** A counter written with Solid */ +export default function SolidCounter(props: { children?: JSX.Element }) { + const [count, setCount] = createSignal(0); + const add = () => setCount(count() + 1); + const subtract = () => setCount(count() - 1); + + return ( + <> + <div id="solid" class="counter"> + <button onClick={subtract}>-</button> + <pre>{count()}</pre> + <button onClick={add}>+</button> + </div> + <div class="counter-message">{props.children}</div> + </> + ); +} diff --git a/examples/framework-multiple/src/components/svelte/SvelteCounter.svelte b/examples/framework-multiple/src/components/svelte/SvelteCounter.svelte new file mode 100644 index 000000000..641312ae1 --- /dev/null +++ b/examples/framework-multiple/src/components/svelte/SvelteCounter.svelte @@ -0,0 +1,30 @@ +<!-- @component +A counter written with Svelte +--> +<script lang="ts"> + import type { Snippet } from 'svelte'; + + interface Props { + children?: Snippet + } + + let { children }: Props = $props(); + let count = $state(0); + + function add() { + count += 1; + } + + function subtract() { + count -= 1; + } +</script> + +<div class="counter"> + <button onclick={subtract}>-</button> + <pre>{count}</pre> + <button onclick={add}>+</button> +</div> +<div class="counter-message"> + {@render children?.()} +</div> diff --git a/examples/framework-multiple/src/components/vue/VueCounter.vue b/examples/framework-multiple/src/components/vue/VueCounter.vue new file mode 100644 index 000000000..74820f7f0 --- /dev/null +++ b/examples/framework-multiple/src/components/vue/VueCounter.vue @@ -0,0 +1,33 @@ +<template> + <!-- + Seeing type errors on the word `class`? + This unfortunately happens because @types/react's JSX definitions leak into every file due to being declared globally. + There's currently no way to prevent this when using both Vue and React with TypeScript in the same project. + You can read more about this issue here: https://github.com/johnsoncodehk/volar/discussions/592 + --> + <div class="counter"> + <button @click="subtract()">-</button> + <pre>{{ count }}</pre> + <button @click="add()">+</button> + </div> + <div class="counter-message"> + <slot /> + </div> +</template> + +<script lang="ts"> +import { ref } from 'vue'; +export default { + setup() { + const count = ref(0); + const add = () => (count.value = count.value + 1); + const subtract = () => (count.value = count.value - 1); + + return { + count, + add, + subtract, + }; + }, +}; +</script> diff --git a/examples/framework-multiple/src/pages/index.astro b/examples/framework-multiple/src/pages/index.astro new file mode 100644 index 000000000..d420111a2 --- /dev/null +++ b/examples/framework-multiple/src/pages/index.astro @@ -0,0 +1,48 @@ +--- +// Style Imports +import '../styles/global.css'; + +// Component Imports +// For JSX components, all the common ways of exporting (under a namespace, specific export, default export etc) are supported! +import * as react from '../components/react/ReactCounter'; +import { PreactCounter } from '../components/preact/PreactCounter'; +import SolidCounter from '../components/solid/SolidCounter'; + +import VueCounter from '../components/vue/VueCounter.vue'; +import SvelteCounter from '../components/svelte/SvelteCounter.svelte'; + +// 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" /> + </head> + <body> + <main> + <react.Counter client:visible> + <h1>Hello from React!</h1> + </react.Counter> + + <PreactCounter client:visible> + <h1>Hello from Preact!</h1> + </PreactCounter> + + <SolidCounter client:visible> + <h1>Hello from Solid!</h1> + </SolidCounter> + + <VueCounter client:visible> + <h1>Hello from Vue!</h1> + </VueCounter> + + <SvelteCounter client:visible> + <h1>Hello from Svelte!</h1> + </SvelteCounter> + </main> + </body> +</html> diff --git a/examples/framework-multiple/src/styles/global.css b/examples/framework-multiple/src/styles/global.css new file mode 100644 index 000000000..4912b4c39 --- /dev/null +++ b/examples/framework-multiple/src/styles/global.css @@ -0,0 +1,21 @@ +html, +body { + font-family: system-ui; + margin: 0; +} + +body { + padding: 2rem; +} + +.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-multiple/tsconfig.json b/examples/framework-multiple/tsconfig.json new file mode 100644 index 000000000..a19c58a62 --- /dev/null +++ b/examples/framework-multiple/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "astro/tsconfigs/strict", + "include": [".astro/types.d.ts", "**/*"], + "exclude": ["dist"], + "compilerOptions": { + // Needed for TypeScript intellisense in the template inside Vue files + "jsx": "preserve" + } +} |
