mx-icons 1.0.15 → 1.0.16

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 mx-icons contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 mx-icons contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,193 +1,193 @@
-<div align="center">
-  
-  ![Preview](/imgs/mxicons-banner-ts.png)
-
-![npm version](https://img.shields.io/npm/v/mx-icons)
-![npm downloads](https://img.shields.io/npm/dm/mx-icons)
-![license](https://img.shields.io/github/license/ig-imanish/mx-icons)
-![bundle size](https://img.shields.io/bundlephobia/minzip/mx-icons)
-
-**A modern, lightweight React icon library with beautiful SVG icons**
-
-Built with React • Optimized for Production
-
-[Live Demo](https://mx-icons.vercel.app/) • [Browse Icons](#-available-icons) • [Documentation](#-usage) • [Contributing](#-contributing)
-
-</div>
-
----
-
-## ✨ 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
-
-```bash
-npm install mx-icons
-```
-
-## 🚀 Quick Start
-
-```jsx
-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
-
-```bash
-# 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](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](https://github.com/ig-imanish/mx-icons/issues/new)
-- 💡 **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](https://github.com/ig-imanish/mx-icons/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
-
-```bash
-# 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:
-
-```jsx
-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](https://www.conventionalcommits.org/):
-
-```
-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**](https://github.com/ig-imanish/mx-icons/blob/main/CONTRIBUTING.md)
-
-## 📄 License
-
-MIT License © 2025 [MX Icons Contributors](https://github.com/ig-imanish/mx-icons/graphs/contributors)
-
-Free to use in personal and commercial projects. See [LICENSE](./LICENSE) for details.
-
-## 📊 Project Stats
-
-![Contributors](https://img.shields.io/github/contributors/ig-imanish/mx-icons)
-![Last Commit](https://img.shields.io/github/last-commit/ig-imanish/mx-icons)
-![Issues](https://img.shields.io/github/issues/ig-imanish/mx-icons)
-![Pull Requests](https://img.shields.io/github/issues-pr/ig-imanish/mx-icons)
-
-## 🔗 Links
-
-- **📦 NPM Package:** [npmjs.com/package/mx-icons](https://www.npmjs.com/package/mx-icons)
-- **🌐 Live Preview:** [ig-imanish.github.io/mx-icons](https://ig-imanish.github.io/mx-icons)
-- **📚 Documentation:** [github.com/ig-imanish/mx-icons](https://github.com/ig-imanish/mx-icons)
-- **🐛 Issues:** [github.com/ig-imanish/mx-icons/issues](https://github.com/ig-imanish/mx-icons/issues)
-- **💬 Discussions:** [github.com/ig-imanish/mx-icons/discussions](https://github.com/ig-imanish/mx-icons/discussions)
-
-<div align="center">
-  
-  **Made with ❤️ by the open-source community**
-  
-  If you find this project useful, please consider giving it a ⭐ on GitHub!
-  
-</div>
+<div align="center">
+  
+  ![Preview](/imgs/mxicons-banner-ts.png)
+
+![npm version](https://img.shields.io/npm/v/mx-icons)
+![npm downloads](https://img.shields.io/npm/dm/mx-icons)
+![license](https://img.shields.io/github/license/ig-imanish/mx-icons)
+![bundle size](https://img.shields.io/bundlephobia/minzip/mx-icons)
+
+**A modern, lightweight React icon library with beautiful SVG icons**
+
+Built with React • Optimized for Production
+
+[Live Demo](https://mx-icons.vercel.app/) • [Browse Icons](#-available-icons) • [Documentation](#-usage) • [Contributing](#-contributing)
+
+</div>
+
+---
+
+## ✨ 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
+
+```bash
+npm install mx-icons
+```
+
+## 🚀 Quick Start
+
+```jsx
+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
+
+```bash
+# 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](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](https://github.com/ig-imanish/mx-icons/issues/new)
+- 💡 **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](https://github.com/ig-imanish/mx-icons/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
+
+```bash
+# 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:
+
+```jsx
+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](https://www.conventionalcommits.org/):
+
+```
+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**](https://github.com/ig-imanish/mx-icons/blob/main/CONTRIBUTING.md)
+
+## 📄 License
+
+MIT License © 2025 [MX Icons Contributors](https://github.com/ig-imanish/mx-icons/graphs/contributors)
+
+Free to use in personal and commercial projects. See [LICENSE](./LICENSE) for details.
+
+## 📊 Project Stats
+
+![Contributors](https://img.shields.io/github/contributors/ig-imanish/mx-icons)
+![Last Commit](https://img.shields.io/github/last-commit/ig-imanish/mx-icons)
+![Issues](https://img.shields.io/github/issues/ig-imanish/mx-icons)
+![Pull Requests](https://img.shields.io/github/issues-pr/ig-imanish/mx-icons)
+
+## 🔗 Links
+
+- **📦 NPM Package:** [npmjs.com/package/mx-icons](https://www.npmjs.com/package/mx-icons)
+- **🌐 Live Preview:** [ig-imanish.github.io/mx-icons](https://ig-imanish.github.io/mx-icons)
+- **📚 Documentation:** [github.com/ig-imanish/mx-icons](https://github.com/ig-imanish/mx-icons)
+- **🐛 Issues:** [github.com/ig-imanish/mx-icons/issues](https://github.com/ig-imanish/mx-icons/issues)
+- **💬 Discussions:** [github.com/ig-imanish/mx-icons/discussions](https://github.com/ig-imanish/mx-icons/discussions)
+
+<div align="center">
+  
+  **Made with ❤️ by the open-source community**
+  
+  If you find this project useful, please consider giving it a ⭐ on GitHub!
+  
+</div>