vite-plugin-react-icons

v0.1.0
Access thousands of icons as React components in Vite

vite-plugin-react-icons

This plugin is modified from vite-plugin-icons, just for use in react.

Access thousands of icons as React components in Vite

Install

Install the plugin and peer dependency @iconify/json

npm i -D vite-plugin-react-icons @iconify/json

Add it to vite.config.js

// vite.config.js
import reactRefresh from '@vitejs/plugin-react-refresh';
import reactIcons from 'vite-plugin-react-icons';

export default {
  plugins: [
    reactRefresh(),
    reactIcons(),
  ],
}
import IconAppConnectivity from 'virtual:vite-icons/carbon/app-connectivity';
import IconAlarmOff from 'virtual:vite-icons/mdi/alarm-off';

function App() {
  return (
    <div>
      <IconAppConnectivity />
      <IconAlarmOff />
    </div>
  );
}

Options

You can set default styling for all icons. The following config shows the default values of each option:

// vite.config.js
import reactRefresh from '@vitejs/plugin-react-refresh';
import reactIcons from 'vite-plugin-react-icons';

export default {
  plugins: [
    reactRefresh(),
    reactIcons({
      scale: 1, // Scale of icons against 1em
      defaultStyle: '', // Style apply to icons
      defaultClass: '', // Class names apply to icons
    }),
  ],
}

Metadata

  • MIT
  • Whatever
  • codpoe
  • released 7/19/2021

Downloads

Maintainers