Loading...

How to programmatically navigate to a page in Next.js?

question nextjs react
Ram Patra Published on July 18, 2024
Tested on Next.js 14

In Next.js, you can programmatically navigate to different pages using the useRouter hook from the next/navigation module. This hook provides a convenient way to navigate between pages within your Next.js application. Below is an example demonstrating how to use the useRouter hook to programmatically navigate to another page.

Step-by-Step Example

  1. Install Next.js (if you haven’t already):
     npx create-next-app@latest my-next-app
     cd my-next-app
     npm run dev
    
  2. Create a new page: Let’s create a new page to navigate to. Create a file named page.jsx in the about directory.

     // app/about/page.jsx
     export default function About() {
         return (
             <div>
                 <h1>About Page</h1>
                 <p>This is the about page.</p>
             </div>
         );
     }
    
  3. Set up navigation in another component: Use the useRouter hook to navigate to the “About” page when a button is clicked. Modify the index.jsx file in the app directory.

     // app/index.jsx
     import { useRouter } from 'next/navigation';
     import React from 'react';
    
     export default function Home() {
         const router = useRouter();
    
         const navigateToAbout = () => {
             router.push('/about');
         };
    
         return (
             <div>
                 <h1>Home Page</h1>
                 <button onClick={navigateToAbout}>Go to About Page</button>
             </div>
         );
     }
    
  4. Run the Next.js development server:
     npm run dev
    

Now, when you open your browser and navigate to http://localhost:3000, you should see the Home Page with a button labeled “Go to About Page.” When you click the button, it will programmatically navigate to the About Page.

Detailed Explanation

  • useRouter Hook:
    • The useRouter hook from next/navigation gives you access to the router object, which includes methods for navigation.
      import { useRouter } from 'next/navigation';
    
  • router.push:
    • router.push('/about') is used to navigate to the /about page. This is similar to navigating using a link but done programmatically.
      const navigateToAbout = () => {
          router.push('/about');
      };
    
  • Button Click Handler:
    • The navigateToAbout function is called when the button is clicked, triggering the navigation.
      <button onClick={navigateToAbout}>Go to About Page</button>
    

This approach can be extended to navigate to different pages, pass query parameters, or even handle more complex routing logic as required in your Next.js application.

Presentify

Take your presentation to the next level.

FaceScreen

Put your face and name on your screen.

ToDoBar

Your to-dos on your menu bar.

Ram Patra Published on July 18, 2024
Image placeholder

Keep reading

If this article was helpful, others might be too

question nextjs react February 9, 2024 How to make an HTML button element behave like a Link component in Next.js?

In Next.js, you can use the Link component from next/link to create client-side navigation. However, if you want to use an HTML button element (<button>) to behave like a link, you can wrap it with the Link component. Here’s how you can do it:

question nextjs react July 9, 2024 How to create global types in Typescript in a Next.js app?

The env.d.ts file is typically used for global type declarations, especially for environment variables and other globally available types. This file is automatically included in the TypeScript compilation if it’s referenced in tsconfig.json.

question nextjs react February 9, 2024 Main advantages of using the Link component in Next.js over Anchors and Buttons

The main advantage of using the Link component in Next.js for client-side navigation is its optimized prefetching behavior, which enhances the performance and user experience of your web application. Here’s a breakdown of the key advantages: