diff --git a/.github/workflows/github-pages.yaml b/.github/workflows/github-pages.yaml new file mode 100644 index 0000000..179df4e --- /dev/null +++ b/.github/workflows/github-pages.yaml @@ -0,0 +1,80 @@ +name: Deploy Next.js example to GitHub Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - uses: pnpm/action-setup@v4.0.0 + name: Install pnpm + with: + run_install: false + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: "20" + cache: pnpm + - name: Setup Pages + uses: actions/configure-pages@v5 + with: + # Automatically inject basePath in your Next.js configuration file and disable + # server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized). + # + # You may remove this line if you want to manage the configuration yourself. + static_site_generator: next + generator_config_file: example/next.config.mjs + - name: Restore cache + uses: actions/cache@v4 + with: + path: | + .next/cache + # Generate a new cache whenever packages or source files change. + key: ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }} + # If source files changed but packages didn't, rebuild from a prior cache. + restore-keys: | + ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}- + - name: Install dependencies + run: pnpm install --frozen-lockfile + - name: Build the library + run: pnpm run build + - name: Build with Next.js + working-directory: example + run: pnpm run build + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./example/out + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 9b84c01..aae0f15 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ You use Next.js, and you want to show "You have unsaved changes that will be lost." dialog when user leaves page? This library is just for you! +## Demo + +[https://layerxcom.github.io/next-navigation-guard/](https://layerxcom.github.io/next-navigation-guard/) + ## How does it work? - [English Slide](https://speakerdeck.com/ypresto/cancel-next-js-page-navigation-full-throttle) diff --git a/example/src/app/page.tsx b/example/src/app/page.tsx index e4570cf..05cf4b3 100644 --- a/example/src/app/page.tsx +++ b/example/src/app/page.tsx @@ -1,7 +1,26 @@ -// import Image from "next/image"; -import { redirect } from "next/navigation"; +import Link from "next/link"; import styles from "./page.module.css"; export default function Home() { - redirect("/page1"); + return ( +
+
+

Navigation Guard Example

+ +
+
    +
  1. + App Router +
  2. +
+ +
    +
  1. + App Router +
  2. +
+
+
+
+ ); }