Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dai-shi/waku
⛩️ The minimal React framework
https://github.com/dai-shi/waku
Last synced: 5 days ago
JSON representation
⛩️ The minimal React framework
- Host: GitHub
- URL: https://github.com/dai-shi/waku
- Owner: dai-shi
- License: mit
- Created: 2023-03-03T13:05:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T16:57:10.000Z (5 months ago)
- Last Synced: 2024-05-29T00:22:08.734Z (5 months ago)
- Language: TypeScript
- Homepage: https://waku.gg
- Size: 2.55 MB
- Stars: 3,989
- Watchers: 16
- Forks: 104
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-luooooob - dai-shi/waku - ⛩️ The minimal React framework (TypeScript)
README
# Waku
⛩️ The minimal React framework
visit [waku.gg](https://waku.gg) or `npm create waku@latest`
[](https://github.com/pmndrs/jotai/actions?query=workflow%3ALint)
[](https://www.npmjs.com/package/waku)
[](https://www.npmjs.com/package/waku)
[](https://discord.gg/MrQdmzd)
## Introduction
**Waku** _(wah-ku)_ or **わく** means “framework” in Japanese. As the minimal React framework, it’s designed to accelerate the work of developers at startups and agencies building small to medium-sized React projects. These include marketing websites, light ecommerce, and web applications.
We recommend other frameworks for heavy ecommerce or enterprise applications. Waku is a lightweight alternative bringing a fun developer experience to the server components era. Yes, let’s make React development fun again!
> Waku is in rapid development and some features are currently missing. Please try it on non-production projects and report any issues you may encounter. Expect that there will be some breaking changes on the road towards a stable v1 release. Contributors are welcome.
## Getting started
Start a new Waku project with the `create` command for your preferred package manager. It will scaffold a new project with our default [Waku starter](https://github.com/dai-shi/waku/tree/main/examples/01_template).
```
npm create waku@latest
```
**Node.js version requirement:** `^20.8.0` or `^18.17.0`
## Rendering
While there’s a bit of a learning curve to modern React rendering, it introduces powerful new patterns of full-stack composability that are only possible with the advent of [server components](https://github.com/reactjs/rfcs/blob/main/text/0188-server-components.md).
So please don’t be intimidated by the `'use client'` directive! Once you get the hang of it, you’ll appreciate how awesome it is to flexibly move server-client boundaries with a single line of code as your full-stack React codebase evolves over time. It’s way simpler than maintaining separate codebases for your backend and frontend.
And please don’t fret about client components! Even if you only lightly optimize towards server components, your client bundle size will be smaller than traditional React frameworks, which are always 100% client components.
> Future versions of Waku may provide additional opt-in APIs to abstract some of the complexity away for an improved developer experience.
#### Server components
Server components can be made async and can securely perform server-side logic and data fetching. Feel free to access the local file-system and import heavy dependencies since they aren’t included in the client bundle. They have no state, interactivity, or access to browser APIs since they run _exclusively_ on the server.
```tsx
// server component
import db from 'some-db';
import { Gallery } from '../components/gallery';
export const Store = async () => {
const products = await db.query('SELECT * FROM products');
return ;
};
```
#### Client components
A `'use client'` directive placed at the top of a file will create a server-client boundary when imported into a server component. All components imported below the boundary will be hydrated to run in the browser as well. They can use all traditional React features such as state, effects, and event handlers.
```tsx
// client component
'use client';
import { useState } from 'react';
export const Counter = () => {
const [count, setCount] = useState(0);
return (
<>
Count: {count}
setCount((c) => c + 1)}>Increment
>
);
};
```
#### Shared components
Simple React components that [meet all of the rules](https://github.com/reactjs/rfcs/blob/main/text/0188-server-components.md#sharing-code-between-server-and-client) of both server and client components can be imported into either server or client components without affecting the server-client boundary.
```tsx
// shared component
export const Headline = ({ children }) => {
return
{children}
;
};
```
#### Weaving patterns
Server components can import client components and doing so will create a server-client boundary. Client components cannot import server components, but they can accept server components as props such as `children`. For example, you may want to add global context providers this way.
```tsx
// ./src/pages/_layout.tsx
import { Providers } from '../components/providers';
export default async function RootLayout({ children }) {
return (
{children}
);
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
```tsx
// ./src/components/providers.tsx
'use client';
import { Provider } from 'jotai';
export const Providers = ({ children }) => {
return {children};
};
```
#### Server-side rendering
Waku provides static prerendering (SSG) and server-side rendering (SSR) options for both layouts and pages including all of their server _and_ client components. Note that SSR is a distinct concept from RSC.
#### tl;dr:
Each layout and page in Waku is composed of a React component hierarchy.
It begins with a server component at the top of the tree. Then at points down the hierarchy, you’ll eventually import a component that needs client component APIs. Mark this file with a `'use client'` directive at the top. When imported into a server component, it will create a server-client boundary. Below this point, all imported components are hydrated and will run in the browser as well.
Server components can be rendered below this boundary, but only via composition (e.g., `children` props). Together they form [a new “React server” layer](https://github.com/reactwg/server-components/discussions/4) that runs _before_ the traditional “React client” layer with which you’re already familiar.
Client components are still server-side rendered as SSR is separate from RSC. Please see the [linked diagrams](https://github.com/reactwg/server-components/discussions/4) for a helpful visual.
#### Further reading
To learn more about the modern React architecture, we recommend [Making Sense of React Server Components](https://www.joshwcomeau.com/react/server-components/) and [The Two Reacts](https://overreacted.io/the-two-reacts/).
## Routing
Waku provides a minimal file-based “pages router” experience built for the server components era.
Its underlying [low-level API](https://github.com/dai-shi/waku/blob/main/docs/create-pages.mdx) is also available for those that prefer programmatic routing. This documentation covers file-based routing since many React developers prefer it, but please feel free to try both and see which you like more!
### Overview
The directory for file-based routing in Waku projects is `./src/pages`.
Layouts and pages can be created by making a new file with two exports: a default function for the React component and a named `getConfig` function that returns a configuration object to specify the render method and other options.
Waku currently supports two rendering options:
- `'static'` for static prerendering (SSG)
- `'dynamic'` for server-side rendering (SSR)
For example, you can statically prerender a global header and footer in the root layout at build time, but dynamically render the rest of a home page at request time for personalized user experiences.
```tsx
// ./src/pages/_layout.tsx
import '../styles.css';
import { Providers } from '../components/providers';
import { Header } from '../components/header';
import { Footer } from '../components/footer';
// Create root layout
export default async function RootLayout({ children }) {
return (
{children}
);
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
```tsx
// ./src/pages/index.tsx
// Create home page
export default async function HomePage() {
const data = await getData();
return (
<>
{data.title}
{data.content}
>
);
}
const getData = async () => {
/* ... */
};
export const getConfig = async () => {
return {
render: 'dynamic',
};
};
```
### Pages
Pages render a single route, segment route, or catch-all route based on the file system path (conventions below). All page components automatically receive two props related to the rendered route: `path` (string) and `query` (string).
#### Single routes
Pages can be rendered as a single route (e.g., `about.tsx` or `blog/index.tsx`).
```tsx
// ./src/pages/about.tsx
// Create about page
export default async function AboutPage() {
return <>{/* ...*/}>;
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
```tsx
// ./src/pages/blog/index.tsx
// Create blog index page
export default async function BlogIndexPage() {
return <>{/* ...*/}>;
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
#### Segment routes
Segment routes (e.g., `[slug].tsx` or `[slug]/index.tsx`) are marked with brackets.
The rendered React component automatically receives a prop named by the segment (e.g., `slug`) with the value of the rendered segment (e.g., `'introducing-waku'`).
If statically prerendering a segment route at build time, a `staticPaths` array must also be provided.
```tsx
// ./src/pages/blog/[slug].tsx
// Create blog article pages
export default async function BlogArticlePage({ slug }) {
const data = await getData(slug);
return <>{/* ...*/}>;
}
const getData = async (slug) => {
/* ... */
};
export const getConfig = async () => {
return {
render: 'static',
staticPaths: ['introducing-waku', 'introducing-pages-router'],
};
};
```
```tsx
// ./src/pages/shop/[category].tsx
// Create product category pages
export default async function ProductCategoryPage({ category }) {
const data = await getData(category);
return <>{/* ...*/}>;
}
const getData = async (category) => {
/* ... */
};
export const getConfig = async () => {
return {
render: 'dynamic',
};
};
```
Static paths (or other config values) can also be generated programmatically.
```tsx
// ./src/pages/blog/[slug].tsx
// Create blog article pages
export default async function BlogArticlePage({ slug }) {
const data = await getData(slug);
return <>{/* ...*/}>;
}
const getData = async (slug) => {
/* ... */
};
export const getConfig = async () => {
const staticPaths = await getStaticPaths();
return {
render: 'static',
staticPaths,
};
};
const getStaticPaths = async () => {
/* ... */
};
```
#### Nested segment routes
Routes can contain multiple segments (e.g., `/shop/[category]/[product]`) by creating folders with brackets as well.
```tsx
// ./src/pages/shop/[category]/[product].tsx
// Create product category pages
export default async function ProductDetailPage({ category, product }) {
return <>{/* ...*/}>;
}
export const getConfig = async () => {
return {
render: 'dynamic',
};
};
```
For static prerendering of nested segment routes, the `staticPaths` array is instead composed of ordered arrays.
```tsx
// ./src/pages/shop/[category]/[product].tsx
// Create product detail pages
export default async function ProductDetailPage({ category, product }) {
return <>{/* ...*/}>;
}
export const getConfig = async () => {
return {
render: 'static',
staticPaths: [
['same-category', 'some-product'],
['same-category', 'another-product'],
],
};
};
```
#### Catch-all routes
Catch-all or “wildcard” segment routes (e.g., `/app/[...catchAll]`) are marked with an ellipsis before the name and have indefinite segments.
Wildcard routes receive a prop with segment values as an ordered array. For example, the `/app/profile/settings` route would receive a `catchAll` prop with the value `['profile', 'settings']`. These values can then be used to determine what to render in the component.
```tsx
// ./src/pages/app/[...catchAll].tsx
// Create dashboard page
export default async function DashboardPage({ catchAll }) {
return <>{/* ...*/}>;
}
export const getConfig = async () => {
return {
render: 'dynamic',
};
};
```
### Layouts
Layouts are created with a special `_layout.tsx` file name and wrap the entire route and its descendents. They must accept a `children` prop of type `ReactNode`. While not required, you will typically want at least a root layout.
#### Root layout
The root layout placed at `./pages/_layout.tsx` is especially useful. It can be used for setting global styles, global metadata, global providers, global data, and global components, such as a header and footer.
```tsx
// ./src/pages/_layout.tsx
import '../styles.css';
import { Providers } from '../components/providers';
import { Header } from '../components/header';
import { Footer } from '../components/footer';
// Create root layout
export default async function RootLayout({ children }) {
return (
{children}
);
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
```tsx
// ./src/components/providers.tsx
'use client';
import { createStore, Provider } from 'jotai';
const store = createStore();
export const Providers = ({ children }) => {
return {children};
};
```
#### Other layouts
Layouts are also helpful in nested routes. For example, you can add a layout at `./pages/blog/_layout.tsx` to add a sidebar to both the blog index and all blog article pages.
```tsx
// ./src/pages/blog/_layout.tsx
import { Sidebar } from '../../components/sidebar';
// Create blog layout
export default async function BlogLayout({ children }) {
return (
{children}
);
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
## Navigation
### Link
The`` component should be used for internal links. It accepts a `to` prop for the destination, which is automatically prefetched ahead of the navigation.
```tsx
// ./src/pages/index.tsx
import { Link } from 'waku';
export default async function HomePage() {
return (
<>
Home
About
>
);
}
```
### useRouter
The `useRouter` hook can be used to inspect the current route or perform programmatic navigation.
#### router properties
The `router` object has two properties related to the current route: `path` (string) and `query` (string).
```tsx
'use client';
import { useRouter_UNSTABLE as useRouter } from 'waku';
export const Component = () => {
const { path, query } = useRouter();
return (
<>
current path: {path}
current query: {query}
>
);
};
```
#### router methods
The `router` object also contains several methods for programmatic navigation:
- `router.push(to: string)` - navigate to the provided route
- `router.prefetch(to: string)` - prefetch the provided route
- `router.replace(to: string)` - replace the current history entry
- `router.reload()` - reload the current route
- `router.back()` - navigate to the previous entry in the session history
- `router.forward()` - navigate to the next entry in the session history
```tsx
'use client';
import { useRouter_UNSTABLE as useRouter } from 'waku';
export const Component = () => {
const router = useRouter();
return (
<>
router.push('/')}>Home
router.back()}>Back
>
);
};
```
## Metadata
Waku automatically hoists any title, meta, and link tags to the document head. That means adding meta tags is as simple as adding them to any of your layout or page components.
```tsx
// ./src/pages/_layout.tsx
export default async function RootLayout({ children }) {
return (
<>
{children}
>
);
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
```tsx
// ./src/pages/index.tsx
export default async function HomePage() {
return (
<>
Waku
Waku
Hello world!
>
);
}
export const getConfig = async () => {
return {
render: 'static',
};
};
```
Metadata can also be generated programmatically.
```tsx
// ./src/pages/index.tsx
export default async function HomePage() {
return (
<>