@best-skn/next-types
v1.1.1
Published
A Simple Type Definition Extension Library For Next.js 14
Downloads
62
Readme
SKN Next.js Type Extension Library
TypeScript Next.js
Introduction:
This is a simple TypeScript Type Extension Library for Next.js 14
I made this library so that I can use it in all of my Next.js 14 projects without writing the same codes over and over again
Details:
ParamProps
Type
- An interface taking a generic that has
params
property of typeRecord<T, string>
ParamProps
is the prop type for Next.js dynamic routepage.tsx
default exported server component.ParamProps
generic type is actually a string which is the name of the slug i.e. the name of the dynamic id- The dynamic id can have names like: "slug", "id" etc. which becomes the directory name like: [slug], [id] etc
- For usage instruction, see
Usage
section
GenerateMetadata
Type
GenerateMetadata
is the type for Next.js dynamic routegenerateMetadata
function- The generic type which is the dynamic id, must match that of
ParamProps
in a certain dynamic route component - For usage instruction, see
Usage
section
GenerateStaticParams
Type
GenerateStaticParams
is the type for Next.js dynamic routegenerateStaticParams
function- The generic type which is the dynamic id, must match that of
ParamProps
in a certain dynamic route component - For usage instruction, see
Usage
section
NextErrorProps
Type
- an interface for Next.js
error.tsx
client component NextErrorProps
is the prop type forerror.tsx
default exported function
Use Case:
- Next.js
Requirements:
This library has peer dependency for React & React DOM of minimum 18.3.1. It may or may not work on 19.x
This library is intended to be used in Next.js of minimum 14.2.3. It may or may not work on 15.x
- 💀 Minimum react Version:
18.3.1
- 💀 Minimum @types/react Version:
18.3.3
- 💀 Minimum react-dom Version:
18.3.1
- 💀 Minimum @types/react-dom Version:
18.3.0
- 💀 Minimum next Version:
14.2.3
Complementary Libraries:
Usage:
To install the package, type the following in console
npm add -D @best-skn/next-types #or yarn add -D @best-skn/next-types #or pnpm add -D @best-skn/next-types #or bun add -D @best-skn/next-types
Create a directory called types
in the root location of your project, and create a file called next.d.ts
, then do this
import "@best-skn/next-types";
Check your tsconfig.json
, if includes
property has **/*.ts
& **/*.tsx
or not otherwise the type definition file may not work
Now Inside your Next.js 14 Project, use the package like this (Just an example)
ParamProps
, GenerateMetadata
& GenerateStaticParams
Types:
For any dynamic routes, use like this
// Location: app/users/[slug]/page.tsx // Dynamic id: slug import type { GenerateMetadata, GenerateStaticParams, ParamProps, } from "next"; // Generic type here `slug` as the dynamic id is that export const generateMetadata: GenerateMetadata<"slug"> = async (props) => { const { slug } = props.params; // some codes here... return { // some codes here... }; }; // Generic type here `slug` as the dynamic id is that export const generateStaticParams: GenerateStaticParams<"slug"> = async () => { // your code for generating static params here... // you'll get type safe dynamic route: `slug` }; // Generic type here `slug` as the dynamic id is that // here `React.SC` type is from my another package: `@best-skn/react-types` const User: React.SC<ParamProps<"slug">> = async (props) => { const { slug } = props.params; // you'll get a type safe dynamic id name return (); };
NextErrorProps
Type:
For error.tsx
files, use like this
"use client"; import type { NextErrorProps } from "next"; const Error: React.FC<NextErrorProps> = (props) => { const { error, reset } = props; // some codes here... return ( <div>something...</div> ); };
Dedicated To:
- 👩⚕️
Tanjila Hasan Trina
: The long lost love of my life. The course of nature separated us from our paths and put us in separate places far away from each other. But no matter how separated we are right now, each and every moment of mine is only dedicated to you. We may not see each other in this lifetime as it seems but I will find you again in the next life. I just want to say:世界は残酷だ それでも君を愛すよ
- 💯
My Parents
: The greatest treasures of my life ever.
License:
Copyright (C) 2024 SKN Shukhan
Licensed under the MIT License