Skip to content

About

Docs, recipes and runnable examples for react-render-wave.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

React Render Wave docs

The documentation site for react-render-wave: API reference, recipes, and runnable examples.

Live at renderwave.sudo-ezekiel.com.

Every page here is a real page in this repository. Nothing is faked with a screenshot, so if an example renders on the site it compiles and runs.

Layout

Path What is in it
app/examples/ One prop or feature at a time, each with its source below the demo
app/recipes/ Task-oriented answers: sizing, batch size, keys, scroll restoration, pausing, SSR
app/real-world/ Whole screens: a chat transcript, a data table, a searchable directory
app/api-reference/ Every export and prop in one page
lib/examples.ts The registry the nav and the landing page are both built from
lib/data.ts Sample data, derived from the row index so SSR and hydration agree

Adding a page means creating it under the right directory and adding one entry to lib/examples.ts. The nav and the landing grid pick it up from there.

Local development

npm install
npm run dev

The site resolves react-render-wave from npm. When the pages here document an unreleased version, install the library from the repository while you work:

npm install github:sudo-ezekiel/react-render-wave

To test against an uncommitted local build instead, pack the library and install the tarball, which is closer to what a consumer gets:

npm pack --pack-destination /tmp ../react-render-wave
npm install --no-save /tmp/react-render-wave-<version>.tgz

Deploying

Static export served by an assets-only Cloudflare Worker.

npm run deploy

That builds to out/ and runs wrangler deploy. The hostname and the DNS record come from wrangler.jsonc.

Checks

npm run lint
npm run typecheck
npm run build

About

Docs, recipes and runnable examples for react-render-wave.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages