How-to
Add the Vercel Toolbar to your local environment
Learn how to use the Vercel Toolbar in your local environment.Table of Contents
Next.js (/app)
To enable the toolbar in your local environment, add it to your project using the @vercel/toolbar
package, or with an injection script.
Install the package using the following command:
pnpm i @vercel/toolbar
Then link your local project to your Vercel project with the
vercel link
command using Vercel CLI.terminalvercel link [path-to-directory]
To use the Vercel Toolbar locally in a Next.js project, define
withVercelToolbar
in yournext.config.js
file and export it, as shown below:next.config.js/** @type {import('next').NextConfig} */ const nextConfig = { // Config options here }; const withVercelToolbar = require('@vercel/toolbar/plugins/next')(); // Instead of module.exports = nextConfig, do this: module.exports = withVercelToolbar(nextConfig);
Then add the following code to your
layout.tsx
orlayout.jsx
file:app/layout.tsximport { VercelToolbar } from '@vercel/toolbar/next'; export default function RootLayout({ children, }: { children: React.ReactNode; }) { const shouldInjectToolbar = process.env.NODE_ENV === 'development'; return ( <html lang="en"> <body> {children} {shouldInjectToolbar && <VercelToolbar />} </body> </html> ); }
Last updated on July 23, 2024
Was this helpful?