InstallationReact (esbuild)

Install Monicon with React (esbuild)

Setting up Monicon with React and esbuild is a straightforward process. This guide will walk you through the installation and configuration steps to get started with Monicon in your React project using esbuild as the bundler.

Install

To get started, you’ll need to install the necessary dependencies for Monicon. In your project directory, run the following command to install the dependencies.

npm i @monicon/react @monicon/esbuild

Now you should install the development dependency @iconify/json for the icon sets. This package provides a comprehensive collection of icons that can be easily integrated into your project.

npm i -D @iconify/json
 
# or specific icon sets
npm i -D @iconify-json/mdi @iconify-json/feather

Configure esbuild

Now that the dependencies are installed, you’ll need to configure esbuild to use Monicon. Create a build script that uses the Monicon esbuild plugin:

build.ts
import * as esbuild from "esbuild";
import monicon from "@monicon/esbuild";
 
await esbuild.build({
  plugins: [
    monicon({
      icons: [
        "mdi:home",
        "feather:activity",
        "logos:active-campaign",
        "lucide:badge-check",
      ],
      // Load all icons from the listed collections
      collections: ["radix-icons"],
    }),
  ],
});
💡

The icons array in the moniconPlugin configuration specifies the icon sets you want to use in your project. You can add more icon sets as needed.

For a complete list of available icon sets, refer to the Icones website.

Usage

You can now use Monicon in your React components. Here’s an example of how to use Monicon in a React component:

src/App.tsx
import { Monicon } from "@monicon/react";
 
function App() {
  return (
    <main>
      <Monicon name="mdi:home" />
      <Monicon name="logos:active-campaign" size={30} />
      <Monicon name="feather:activity" color="red" />
      <Monicon name="lucide:badge-check" size={24} strokeWidth={4} />
    </main>
  );
}
 
export default App;

Configure .gitignore

Add the following to your .gitignore file to prevent icons from being committed to your repository:

# monicon
.monicon

Next Steps

You’ve successfully set up Monicon with React and esbuild! You can now explore more icon sets and customize your usage further.