Using Unplugin Icons in Next.js: Auto-Import Any Icon
LaunchFast LogoLaunchFast
Blog
ENDEES
705 words4 min read

Using Unplugin Icons in Next.js: Auto-Import Any Icon

A step-by-step guide to installing and using Unplugin Icons in Next.js to auto-import SVG icons from any icon set, on demand.

Rishi Raj Jain
Rishi Raj JainAuthor
Ask AIChatGPTClaudePerplexityGrok

In this guide, you will learn how to use Unplugin Icons in a Next.js application. You will go through the process of setting up a new Next.js project, configuring Unplugin Icons, and using them to leverage a huge collection of icons in your application.

Sponsored

High Quality Starter Kits with built-in authentication flow (Auth.js), object uploads (AWS, Clouflare R2, Firebase Storage, Supabase Storage), integrated payments (Stripe, LemonSqueezy), email verification flow (Resend, Postmark, Sendgrid), and much more. Compatible with any database (Redis, Postgres, MongoDB, SQLite, Firestore).

Get all 3 kits$147$99

One-time license · Lifetime updates

Prerequisites

You’ll need the following:

Table Of Contents

Create a new Next.js application

Let’s get started by creating a new Next.js project. Open your terminal and run the following command:

Terminal window
npx create-next-app@latest my-app

When prompted, choose:

Once that is done, move into the project directory and start the app in development mode by executing the following command:

Terminal window
cd my-app
npm run dev

The app should be running on localhost:3000. Now, let’s close the development server to install Unplugin Icons.

Integrate Unplugin Icons in your Next.js project

Install the Unplugin Icons dependencies

Execute the commands below to install the necessary packages for using Unplugin Icons in Next.js:

Terminal window
# unplugin-icons package for Webpack compiler
npm i -D unplugin-icons


# @iconify/json package for the icons collection
npm i -D @iconify/json


# @svgr/core and @svgr/plugin-jsx packages for React compatibility
npm i -D @svgr/core @svgr/plugin-jsx

The command installs the following libraries:

Further, perform the following additions in next.config.mjs to use the Unplugin Icons integration:

next.config.mjs
import unpluginIcons from 'unplugin-icons/webpack'


/** @type {import('next').NextConfig} */
const nextConfig = {
  webpack(config) {
    config.plugins.push(
      unpluginIcons({
        compiler: 'jsx',
        jsx: 'react',
      }),
    )
    return config
  },
}


export default nextConfig

Include Type Definitions for Unplugin Icons

To make sure that you can leverage the type definitions of the Unplugin Icons in Next.js, you would want to globally define such specific Icon imports as React component imports. To do so, update the tsconfig.json file with the following code:

{
  "compilerOptions": {
    "target": "es5",
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "strict": true,
    "noEmit": true,
    "esModuleInterop": true,
    "module": "esnext",
    "moduleResolution": "bundler",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "types": ["unplugin-icons/types/react"], // [!code ++] // [!code focus]
    "jsx": "preserve",
    "incremental": true,
    "paths": {
      "@/*": ["./*"]
    }
  },
  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
  "exclude": ["node_modules"]
}

The code above simply marks each import from ~icons to be considered as a React component in your Next.js application.

Use Unplugin Icons in the index route

Finally, import the icon and use it in your Next.js index route with the following code:

import ClockIcon from '~icons/mdi/clock'


export default function Home() {
  return (
    <ClockIcon />
  );
}

The code above imports an icon as a React component in the index route.

You’re all done now!

Build and Test your Next.js application locally

To test the application, prepare a build and run the preview server using the command below:

Terminal window
npm run build && npm run start

Conclusion

In this guide, you learned how to use Unplugin Icons in a Next.js application.

Working in another framework? See how to auto-import icons with Unplugin Icons in SvelteKit or Unplugin Icons in Astro with React.

If you have any questions or comments, feel free to reach out to me on Twitter.

Continue reading