next-ssr
v1.2.5
Published
Library for easy SSR of data obtained from asynchronous in Next.js.
Downloads
665
Readme
next-ssr
overview
Library for easy SSR of data obtained from asynchronous in Next.js. SSR can be performed from PagesRouter and AppRouter's ClientComponents.
URL of sample program
https://next-ssr-pokemon.vercel.app/
Notes.
Do not use <Suspense>
for components using useSSR in ServerSide.
You will not be able to wait for asynchronous data.
Easiest example.
Asynchronous data is rendered as-is in components on the server.
- pages/simple.tsx
import { SSRProvider, useSSR } from "next-ssr";
/**
* Return time asynchronously
*/
const Test = () => {
// The return value of async is SSRed.
const { data } = useSSR(async () => "Hello world!");
return <div>{data}</div>;
};
/**
* Page display components
*/
const Page = () => {
return (
<SSRProvider>
<Test />
</SSRProvider>
);
};
export default Page;
usage
import { SSRProvider, SSRBodyRoot, useSSR } from "next-ssr";
Add
SSRProvider
to Layout.React@19
<html lang="en"> <SSRProvider> <head> <SSRHeadRoot /> </head> <body>{children}</body> </SSRProvider> </html>
React@18
<html lang="en"> <SSRProvider> <head> <SSRHeadRoot /> </head> <body> {children} <SSRBodyRoot /> </body> </SSRProvider> </html>
Asynchronous data used for SSR is obtained by useSSR
/**
* data: Data received from fetch.
* error: Errors thrown by fetch.
* reload: Used when re-calling fetch.
* isLoading: `true` if loading.
*/
const { data, error, reload, isLoading } = useSSR<T>(
// Function returning 'Proimise<T>'.
fetcher,
// key: If omitted, the value of useId() is used.
// However, note that nesting causes malfunctions.
{
key: "key-value",
}
);
- Use
<SSRHead>
to manipulate data in<head>
in components
<SSRHead>
<title>Title</title>
</SSRHead>
Example
- src/layout/Layout.tsx
import { SSRHeadRoot, SSRProvider } from "next-ssr";
import { headers } from "next/headers";
export default function RootLayout({
children,
}: {
children: React.ReactNode;
}) {
headers();
return (
<html lang="en">
<SSRProvider>
<head>
<SSRHeadRoot />
</head>
<body>{children}</body>
</SSRProvider>
</html>
);
}
- src/app/[page]/page.tsx
"use client";
import { SSRHead, useSSR } from "next-ssr";
import Link from "next/link";
import { useParams } from "next/navigation";
type PokemonList = {
count: number;
next: string;
previous: string | null;
results: { name: string; url: string }[];
};
const pokemonList = (page: number): Promise<PokemonList> =>
fetch(`https://pokeapi.co/api/v2/pokemon/?offset=${(page - 1) * 20}`).then(
(r) => r.json()
);
const Page = () => {
const params = useParams();
const page = Number(params["page"] ?? 1);
const { data } = useSSR(() => pokemonList(page), {
key: `pokemon-list-${page}`,
});
if (!data) return <div>loading</div>;
return (
<>
<SSRHead>
<title>Pokemon List</title>
</SSRHead>
<div style={{ display: "flex", gap: "8px", padding: "8px" }}>
<Link
href={page > 1 ? `/${page - 1}` : ""}
style={{
textDecoration: "none",
padding: "8px",
boxShadow: "0 0 8px rgba(0, 0, 0, 0.1)",
}}
>
⏪️
</Link>
<Link
href={page < Math.ceil(data.count / 20) ? `/${page + 1}` : ""}
style={{
textDecoration: "none",
padding: "8px",
boxShadow: "0 0 8px rgba(0, 0, 0, 0.1)",
}}
>
⏩️
</Link>
</div>
<hr style={{ margin: "24px 0" }} />
<div>
{data.results.map(({ name }) => (
<div key={name}>
<Link href={`/pokemon/${name}`}>{name}</Link>
</div>
))}
</div>
</>
);
};
export default Page;
- src/app/pokemon/[name]/page.tsx
"use client";
import { SSRHead, useSSR } from "next-ssr";
import Link from "next/link";
import { useParams } from "next/navigation";
type Pokemon = {
abilities: { ability: { name: string; url: string } }[];
base_experience: number;
height: number;
id: number;
name: string;
order: number;
species: { name: string; url: string };
sprites: {
back_default: string;
back_female: string;
back_shiny: string;
back_shiny_female: string;
front_default: string;
front_female: string;
front_shiny: string;
front_shiny_female: string;
};
weight: number;
};
const pokemon = (name: string): Promise<Pokemon> =>
fetch(`https://pokeapi.co/api/v2/pokemon/${name}`).then((r) => r.json());
const Page = () => {
const params = useParams();
const name = String(params["name"]);
const { data } = useSSR(() => pokemon(name), {
key: `pokemon-${name}`,
});
if (!data) return <div>loading</div>;
return (
<>
<SSRHead>
<title>{name}</title>
</SSRHead>
<div style={{ padding: "8px" }}>
<Link
href="/1"
style={{
textDecoration: "none",
padding: "8px 32px",
boxShadow: "0 0 8px rgba(0, 0, 0, 0.1)",
borderRadius: "8px",
}}
>
⏪️List
</Link>
</div>
<hr style={{ margin: "24px 0" }} />
<div
style={{
display: "inline-flex",
flexDirection: "column",
alignItems: "center",
padding: "8px",
}}
>
<img
style={{ boxShadow: "0 0 8px rgba(0, 0, 0, 0.5)" }}
src={data.sprites.front_default}
/>
<div>{name}</div>
</div>
</>
);
};
export default Page;