Skip to content

Repository files navigation

Reicon — Free Open-Source Icon Library

Mx Icons

Open source, beautiful icons for React projects. Beautiful SVG components with multiple style variants - linear, bold, bulk, and more. Customizable, and ready for your app or design system.

Live DemoBrowse IconsDocumentationContributing

npm version npm downloads license bundle size



✨ Features

  • 🎨 Multiple Variants — Every icon comes in outline, solid, and mini (16px) versions
  • Lightweight & Fast — Tree-shakeable, only imports what you use
  • 🔧 Fully Customizable — Control size, color, and all SVG attributes
  • 📦 Zero Dependencies — Only React as a peer dependency (18.x or 19.x)
  • 💅 Modern Design — Clean, professional icons optimized for light-mode interfaces
  • 📱 Responsive — Built-in support for different sizes (24px standard, 16px mini)

📦 Installation

npm install mx-icons

🚀 Quick Start

import { NoteTextLinear } from "mx-icons";

function App() {
  return (
    <div>
      <NoteTextLinear />
      <NoteTextLinear size={24} color="#292D32" />
    </div>
  );
}

🎨 Props & Customization

All icon components accept the following props:

Prop Type Default Description
size number | string 24 Icon width and height (px or any CSS unit)
color string "#292D32" Icon color (any CSS color)
className string "" Additional CSS classes

Run Preview Locally

# Clone the repository
git clone https://github.com/ig-imanish/mx-icons.git
cd mx-icons

# Install dependencies
npm install

# Start the preview app
npm run dev

Open http://localhost:5173 in your browser.

🤝 Contributing

We welcome contributions from developers of all skill levels! Here's how you can help make MX Icons even better.

Ways to Contribute

  • 🐛 Report Bugs — Found an issue? Open a bug report
  • 💡 Request Icons — Tell us which icons you need for your projects
  • 🎨 Add New Icons — Contribute new icons following our design guidelines
  • 📖 Improve Documentation — Help make our docs clearer and more comprehensive
  • 🔧 Fix Issues — Browse open issues and submit fixes
  • Star the Repo — Show your support and help us grow!
  • 🐦 Share — Spread the word about MX Icons

Quick Start for Contributors

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/mx-icons.git
  3. Install dependencies: npm install
  4. Create a feature branch: git checkout -b feature/new-icon
  5. Make your changes and test: npm run dev
  6. Lint your code: npm run lint
  7. Build the library: npm run build:lib
  8. Commit with a clear message: git commit -m "feat(icons): add calendar icon"
  9. Push to your fork: git push origin feature/new-icon
  10. Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/ig-imanish/mx-icons.git
cd mx-icons

# Install dependencies
npm install

# Start development server
npm run dev

# Run linter
npm run lint

# Build library
npm run build:lib

Adding a New Icon

Icons should follow these guidelines:

  • Format: Optimized SVG
  • Size: 24x24px (standard) or 16x16px (mini)
  • Variants: Provide Linear, Bold, and Mini versions
  • Color: Use currentColor for easy customization
  • Naming: PascalCase with variant suffix (e.g., CalendarLinear, CalendarBold)

Example icon component:

import React from "react";
import Icon from "../../Icon";

export const CalendarLinear = (props) => (
  <Icon {...props}>
    <path d="..." fill="none" stroke="currentColor" strokeWidth="1.5" />
  </Icon>
);

Commit Message Format

We follow Conventional Commits:

feat(icons): add calendar icon with all variants
fix(modal): resolve scrollbar display issue
docs(readme): update installation guide

Pull Request Guidelines

  • Provide a clear description of your changes
  • Include screenshots for visual changes
  • Reference related issues (e.g., "Closes #123")
  • Ensure all tests pass and linting is clean
  • Update documentation if needed

For comprehensive guidelines, check out our CONTRIBUTING.md.

Contributors

🔗 Links

📄 License

MIT License © 2025 MX Icons Contributors

Free to use in personal and commercial projects. See LICENSE for details.

Made with ❤️ by the open-source community
If you find this project useful, please consider giving it a ⭐ on GitHub!

About

A modern, lightweight React icon library with beautiful SVG icons

Topics

Resources

Contributing

Stars

175 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages