chore: adds example

.github/workflows/release.yml

@@ -30,10 +30,10 @@ jobs:
         run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        working-directory: apps/react
+        working-directory: packages/react-next-pathname
 
       - name: Release @hyperjumptech/react-next-pathname-nextjs
         run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        working-directory: apps/next
+        working-directory: packages/react-next-pathname-nextjs

README.md

@@ -114,7 +114,7 @@ const Sidebar = () => {
 
 ## Next.js Support
 
-For Next.js applications, use the package `@hyperjumptech/react-next-pathname-nextjs`.
+Currently, the `@hyperjumptech/react-next-pathname-nextjs` package only supports the Page Router. If you are using the App Router, you can use the `@hyperjumptech/react-next-pathname` package. However, please note that it is not fully optimized for the App Router.
 
 ## License
 

apps/example-nextjs/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

apps/example-nextjs/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

apps/example-nextjs/.prettierrc

@@ -0,0 +1,3 @@
+{
+    "bracketSameLine": true
+}

apps/example-nextjs/README.md

@@ -0,0 +1,40 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

apps/example-nextjs/next.config.mjs

@@ -0,0 +1,6 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+};
+
+export default nextConfig;

apps/example-nextjs/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "example-nextjs",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@hyperjumptech/react-next-pathname-nextjs": "*",
+    "react": "^18",
+    "react-dom": "^18",
+    "next": "14.2.4"
+  },
+  "devDependencies": {
+    "typescript": "^5",
+    "@types/node": "^20",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "postcss": "^8",
+    "tailwindcss": "^3.4.1",
+    "eslint": "^8",
+    "eslint-config-next": "14.2.4"
+  }
+}

apps/example-nextjs/postcss.config.mjs

@@ -0,0 +1,8 @@
+/** @type {import('postcss-load-config').Config} */
+const config = {
+  plugins: {
+    tailwindcss: {},
+  },
+};
+
+export default config;

apps/example-nextjs/src/components/navbar.tsx

@@ -0,0 +1,41 @@
+import { useNextPathname } from "../../../../packages/react-next-pathname-nextjs/dist/index.mjs";
+import Link from "next/link";
+
+const tabs = [
+  { name: "Home", pathname: "/" },
+  { name: "Slow Page", pathname: "/slow-page" },
+  { name: "Very Slow Page", pathname: "/very-slow-page" },
+];
+
+function classNames(...classes: string[]) {
+  return classes.filter(Boolean).join(" ");
+}
+
+export default function Navbar() {
+  const { nextPathname } = useNextPathname();
+
+  function isActive(pathname: string) {
+    return nextPathname === pathname;
+  }
+
+  return (
+    <div className="border-b border-gray-200">
+      <nav aria-label="Tabs" className="-mb-px flex">
+        {tabs.map((tab) => (
+          <Link
+            key={tab.name}
+            href={tab.pathname}
+            aria-current={isActive(tab.pathname) ? "page" : undefined}
+            className={classNames(
+              isActive(tab.pathname)
+                ? "border-indigo-500 text-indigo-600"
+                : "border-transparent text-gray-500 hover:border-gray-300 hover:text-gray-700",
+              "w-1/3 border-b-2 px-1 py-4 text-center text-sm font-medium"
+            )}>
+            {tab.name}
+          </Link>
+        ))}
+      </nav>
+    </div>
+  );
+}

apps/example-nextjs/src/pages/_app.tsx

@@ -0,0 +1,14 @@
+import "~/styles/globals.css";
+
+import type { AppProps } from "next/app";
+import { NextPathnameProvider } from "../../../../packages/react-next-pathname-nextjs/dist/index.mjs";
+import Navbar from "~/components/navbar";
+
+export default function App({ Component, pageProps }: AppProps) {
+  return (
+    <NextPathnameProvider>
+      <Navbar />
+      <Component {...pageProps} />
+    </NextPathnameProvider>
+  );
+}

apps/example-nextjs/src/pages/_document.tsx

@@ -0,0 +1,13 @@
+import { Html, Head, Main, NextScript } from "next/document";
+
+export default function Document() {
+  return (
+    <Html lang="en">
+      <Head />
+      <body>
+        <Main />
+        <NextScript />
+      </body>
+    </Html>
+  );
+}

apps/example-nextjs/src/pages/index.tsx

@@ -0,0 +1,7 @@
+export default function Home() {
+  return (
+    <div className="min-h-screen flex flex-col justify-center items-center">
+      <h1 className="text-lg font-semibold">Home</h1>
+    </div>
+  );
+}

apps/example-nextjs/src/pages/slow-page/index.tsx

@@ -0,0 +1,23 @@
+import { InferGetServerSidePropsType } from "next";
+import { delay } from "~/utils/delay";
+
+export default function SlowPage({
+  message,
+}: InferGetServerSidePropsType<typeof getServerSideProps>) {
+  return (
+    <div className="min-h-screen flex flex-col justify-center items-center">
+      <h1 className="text-lg font-semibold">Slow Page</h1>
+      <p>{message}</p>
+    </div>
+  );
+}
+
+export async function getServerSideProps() {
+  await delay(2000);
+
+  return {
+    props: {
+      message: "This content is displayed after a 2000ms delay.",
+    },
+  };
+}

apps/example-nextjs/src/pages/very-slow-page/index.tsx

@@ -0,0 +1,23 @@
+import { InferGetServerSidePropsType } from "next";
+import { delay } from "~/utils/delay";
+
+export default function VerySlowPage({
+  message,
+}: InferGetServerSidePropsType<typeof getServerSideProps>) {
+  return (
+    <div className="min-h-screen flex flex-col justify-center items-center">
+      <h1 className="text-lg font-semibold">Very Slow Page</h1>
+      <p>{message}</p>
+    </div>
+  );
+}
+
+export async function getServerSideProps() {
+  await delay(5000);
+
+  return {
+    props: {
+      message: "This content is displayed after a 5000ms delay.",
+    },
+  };
+}

apps/example-nextjs/src/styles/globals.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

apps/example-nextjs/src/utils/delay.ts

@@ -0,0 +1,3 @@
+export function delay(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}

apps/example-nextjs/tailwind.config.ts

@@ -0,0 +1,20 @@
+import type { Config } from "tailwindcss";
+
+const config: Config = {
+  content: [
+    "./src/pages/**/*.{js,ts,jsx,tsx,mdx}",
+    "./src/components/**/*.{js,ts,jsx,tsx,mdx}",
+    "./src/app/**/*.{js,ts,jsx,tsx,mdx}",
+  ],
+  theme: {
+    extend: {
+      backgroundImage: {
+        "gradient-radial": "radial-gradient(var(--tw-gradient-stops))",
+        "gradient-conic":
+          "conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))",
+      },
+    },
+  },
+  plugins: [],
+};
+export default config;

apps/example-nextjs/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "paths": {
+      "~/*": ["./src/*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}