JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q37747F
  • License ISC

Package Exports

  • remixicon-react-bundler
  • remixicon-react-bundler/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remixicon-react-bundler) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remixicon-react-bundler

npm version License: MIT

A lightweight, performance-optimized React bundler for Remix Icon SVGs. Instead of importing the entire Remix Icon package or relying on CDN, this library dynamically loads only the icons you use, dramatically reducing bundle size and improving offline availability.

๐Ÿš€ Features

  • โœ… All Remix Icon SVGs Included โ€“ Latest SVGs are bundled as string constants.
  • ๐Ÿง  Type-Safe Icon Names โ€“ Intellisense support with IconName union types for better DX.
  • ๐ŸŽฏ Optimized React Component โ€“ Only load what you need, when you need it.
  • ๐ŸŽจ Customizable Colors โ€“ Supports an array of colors for multi-path SVGs.
  • ๐Ÿ“ Resizable Icons โ€“ Control icon size via a simple size prop.
  • ๐Ÿ“ฆ Minimal Bundle Size โ€“ Uses dynamic imports and manual path rendering.

Screenshot 2025-05-16 at 1 08 55โ€ฏAM


๐Ÿ“ฆ Installation

npm install remixicon-react-bundler
# or
yarn add remixicon-react-bundler

๐Ÿงฉ Usage

import React from "react";
import { SvgIcon } from "remixicon-react-bundler";

function App() {
  return (
    <div>
      <SvgIcon icon="arrow-right-line" size={32} color={["#ff0000"]} />
    </div>
  );
}

๐Ÿงช Props

Prop Type Default Description
icon IconName Required Icon name string with full intellisense support.
size number | string 24 Size of the icon in pixels (used for both height and width).
color string[] ["currentColor"] Array of color strings applied to each <path> in the SVG.

โš™๏ธ How It Works

  1. Type-Safe Icon Tokens All available icon names are exported as a TypeScript union type, ensuring type safety and editor support.

  2. SVG Constants as Modules All SVG files are converted to string constants and saved as .ts files in the icons directory during build time.

  3. Dynamic Import The SvgIcon component uses dynamic import() to fetch the string for the given icon on-demand.

  4. Path Extraction SVG strings are parsed using RegExp to extract d attributes manually.

  5. Color Injection Custom colors provided through the color prop are mapped to individual paths in order.

๐Ÿง‘โ€๐Ÿ’ป Contributing

Clone the repo

Run npm install

Build and test your changes

Submit a PR