> ## Documentation Index
> Fetch the complete documentation index at: https://developers.jup.ag/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Next.js App Example

> Step-by-step guide to integrate Jupiter Plugin into a Next.js application.

This guide walks through integrating Jupiter Plugin into a Next.js application from scratch. It covers both App Router and Pages Router setups, TypeScript declarations, and two initialization methods: the window object approach and the `@jup-ag/plugin` npm package.

## Prerequisites

Before you begin, make sure you have the following installed on your system.

**Node.js and npm**: Download and install from [nodejs.org](https://nodejs.org)

## Step 1: Create a New Next.js Project

Head to your preferred directory and create a new Next.js project using `create-next-app` with TypeScript template (you can use other templates or methods to start your project too):

```bash theme={null}
npx create-next-app@latest plugin-demo --typescript
cd plugin-demo
npm run dev
```

## Step 2: Add TypeScript Support

Create a type declaration file `plugin.d.ts` in your project's `/src/types` folder:

```js theme={null}
declare global {
  interface Window {
    Jupiter: JupiterPlugin;
  }
};
export {};
```

> [accordion] Full TypeScript Declaration
>
> ```js theme={null}
>  declare global {
>     interface Window {
>         Jupiter: JupiterPlugin;
>     }
> }
>
> export type WidgetPosition = 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right';
> export type WidgetSize = 'sm' | 'default';
> export type SwapMode = "ExactInOrOut" | "ExactIn" | "ExactOut";
> export type DEFAULT_EXPLORER = 'Solana Explorer' | 'Solscan' | 'Solana Beach' | 'SolanaFM';
>
> export interface FormProps {
>     swapMode?: SwapMode;
>     initialAmount?: string;
>     initialInputMint?: string;
>     initialOutputMint?: string;
>     fixedAmount?: boolean;
>     fixedMint?: string;
>     referralAccount?: string;
>     referralFee?: number;
> }
>
> export interface IInit {
>     localStoragePrefix?: string;
>     formProps?: FormProps;
>     defaultExplorer?: DEFAULT_EXPLORER;
>     autoConnect?: boolean;
>     displayMode?: 'modal' | 'integrated' | 'widget';
>     integratedTargetId?: string;
>     widgetStyle?: {
>         position?: WidgetPosition;
>         size?: WidgetSize;
>     };
>     containerStyles?: CSSProperties;
>     containerClassName?: string;
>     enableWalletPassthrough?: boolean;
>     passthroughWalletContextState?: WalletContextState;
>     onRequestConnectWallet?: () => void | Promise<void>;
>     onSwapError?: ({
>         error,
>         quoteResponseMeta,
>     }: {
>         error?: TransactionError;
>         quoteResponseMeta: QuoteResponse | null;
>     }) => void;
>     onSuccess?: ({
>         txid,
>         swapResult,
>         quoteResponseMeta,
>     }: {
>         txid: string;
>         swapResult: SwapResult;
>         quoteResponseMeta: QuoteResponse | null;
>     }) => void;
>     onFormUpdate?: (form: IForm) => void;
>     onScreenUpdate?: (screen: IScreen) => void;
> }
>
> export interface JupiterPlugin {
>     _instance: JSX.Element | null;
>     init: (props: IInit) => void;
>     resume: () => void;
>     close: () => void;
>     root: Root | null;
>     enableWalletPassthrough: boolean;
>     onRequestConnectWallet: IInit['onRequestConnectWallet'];
>     store: ReturnType<typeof createStore>;
>     syncProps: (props: { passthroughWalletContextState?: IInit['passthroughWalletContextState'] }) => void;
>     onSwapError: IInit['onSwapError'];
>     onSuccess: IInit['onSuccess'];
>     onFormUpdate: IInit['onFormUpdate'];
>     onScreenUpdate: IInit['onScreenUpdate'];
>     localStoragePrefix: string;
> }
>
> export { };
> ```

## Step 3: Embed the Plugin Script

For Next.js applications, you can add the script in two ways:

### Using App Router (Next.js 13+)

In your `app/layout.tsx`:

```js theme={null}
import Script from "next/script";

export default function RootLayout({
  children,
}: {
  children: React.ReactNode;
}) {
  return (
    <html lang="en">
      <head>
        <Script
          src="https://plugin.jup.ag/plugin-v1.js"
          strategy="beforeInteractive"
          data-preload
          defer
        />
      </head>
      <body>{children}</body>
    </html>
  );
}
```

### Using Pages Router

In your `pages/_app.tsx`:

```js theme={null}
import "@/styles/globals.css";
import type { AppProps } from "next/app";
import Script from "next/script";

export default function MyApp({ Component, pageProps }: AppProps) {
  return (
    <>
      <Script
        src="https://plugin.jup.ag/plugin-v1.js"
        strategy="beforeInteractive"
        data-preload
        defer
      />
      <Component {...pageProps} />
    </>
  );
}
```

## Step 4: Initialize Plugin

There are two ways to initialize Jupiter Plugin in a Next.js application:

### Method 1: Using Window Object

Create a new component for the plugin at `components/plugin.tsx`:

```js theme={null}
"use client";

import React, { useEffect } from "react";

export default function PluginComponent() {
  useEffect(() => {
    if (typeof window !== "undefined") {
      window.Jupiter.init({
        displayMode: "widget",
        integratedTargetId: "jupiter-plugin",
      });
    }
  }, []);

  return (
    <div>
      <h1>Jupiter Plugin Demo</h1>
      <div
        id="jupiter-plugin"
      />
    </div>
  );
}
```

### Method 2: Using @jup-ag/plugin Package

> [!WARNING]
>
> **WARNING**
>
> Do note that using this method will require you to maintain its dependencies.

**Step 1**

Install the package:

```bash theme={null}
npm install @jup-ag/plugin
```

**Step 2**

Create a new component for the plugin at `components/plugin.tsx`:

```js theme={null}
"use client";

import React, { useEffect } from "react";
import "@jup-ag/plugin/css";

export default function PluginComponent() {
  useEffect(() => {
    import("@jup-ag/plugin").then((mod) => {
      const { init } = mod;
      init({
        displayMode: "widget",
        integratedTargetId: "jupiter-plugin",
      });
    });
  }, []);

  return (
    <div>
      <h1>Jupiter Plugin Demo</h1>
      <div id="jupiter-plugin" />
    </div>
  );
}
```

## Step 5: Add the Plugin Component to Your Page

In your `app/page.tsx` (or `pages/index.tsx` if you're using Pages Router):

```js theme={null}
import PluginComponent from '@/components/plugin';

export default function Home() {
  return (
    <div className="grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20 font-[family-name:var(--font-geist-sans)]">
      <PluginComponent />
    </div>
  );
}
```

There you have it! You've successfully integrated Jupiter Plugin into your Next.js application.

* Please test the swap functionality and check the transaction.
* If you require more customizations, check out the [Plugin Playground](https://plugin.jup.ag) or the [Customization](https://developers.jup.ag/docs/tool-kits/plugin/customization.md) documentation.
* If you have any questions or issues, please refer to the [FAQ](https://developers.jup.ag/docs/tool-kits/plugin/faq.md) or contact us on [Discord](https://discord.gg/jup).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.