@mesalvo/icons 0.0.32156

package/LICENSE

@@ -0,0 +1,61 @@
+PROPRIETARY SOFTWARE LICENSE
+
+Copyright (c) 2026 Mesalvo GmbH. All rights reserved.
+
+NOTICE TO USER:
+
+This software and associated documentation files (the "Software") are the 
+proprietary and confidential information of Mesalvo GmbH ("Mesalvo"). 
+
+The Software is licensed, not sold. This license grants you the following rights:
+
+1. GRANT OF LICENSE
+   Subject to the terms and conditions of this License, Mesalvo grants you a 
+   limited, non-exclusive, non-transferable, revocable license to use the 
+   Software solely for internal business purposes within your organization.
+
+2. RESTRICTIONS
+   You may NOT:
+   - Copy, modify, or create derivative works of the Software
+   - Distribute, sublicense, lease, rent, or lend the Software
+   - Reverse engineer, decompile, or disassemble the Software
+   - Remove or alter any proprietary notices or labels on the Software
+   - Use the Software for any purpose other than as expressly permitted
+   - Transfer or assign your rights under this License
+
+3. OWNERSHIP
+   Mesalvo retains all right, title, and interest in and to the Software, 
+   including all intellectual property rights therein. This License does not 
+   grant you any rights to trademarks, service marks, or trade names of Mesalvo.
+
+4. CONFIDENTIALITY
+   The Software contains trade secrets and proprietary information of Mesalvo. 
+   You agree to maintain the confidentiality of the Software and not to disclose 
+   it to any third party without the prior written consent of Mesalvo.
+
+5. TERMINATION
+   This License is effective until terminated. Your rights under this License 
+   will terminate automatically without notice if you fail to comply with any 
+   term of this License. Upon termination, you must destroy all copies of the 
+   Software in your possession.
+
+6. DISCLAIMER OF WARRANTIES
+   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.
+
+7. LIMITATION OF LIABILITY
+   IN NO EVENT SHALL MESALVO 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.
+
+8. GOVERNING LAW
+   This License shall be governed by and construed in accordance with the laws 
+   of Germany, without regard to its conflict of law provisions.
+
+For licensing inquiries, please contact:
+Mesalvo GmbH
+Email: info@mesalvo.com
+Website: https://mesalvo.com
+

package/README.md

@@ -0,0 +1,94 @@
+
+# How to Build an Icon Library with TypeScript, Tsup, and SVGR
+
+This project is a TypeScript-based icon library that transforms SVG files into reusable React components using **SVGR** and bundles them efficiently with **Tsup**. This guide will show you how to set up the project, generate components from SVG files, customize them, and publish the library on npm.
+
+## Features
+
+- **Reusable React components**: Automatically generate React components from SVG files.
+- **Customizable icons**: Dynamically change the `size` and `color` of icons.
+- **Bundled with Tsup**: Efficient bundling for both CommonJS and ES Modules.
+- **TypeScript support**: Full type definitions for easy integration into TypeScript projects.
+
+## Project Structure
+
+The folder structure for this project looks like this:
+
+```
+my-icons-library/
+├── icons/                  # SVG files go here
+├── src/
+│   └── icons/              # Generated React components
+├── scripts/                # Utility scripts for custom tasks
+├── index.ts                # Entry point of the library
+├── tsconfig.json           # TypeScript config file
+├── package.json            # Project settings
+└── tsup.config.ts          # Tsup config file for building the project
+```
+
+## Installation
+
+To install the project dependencies, run:
+
+```bash
+npm install
+```
+
+## Generating React Icon Components
+
+Place your SVG files in the `icons/` folder. Then, run the following script to generate the React components from the SVG files:
+
+```bash
+npm run generate-icons
+```
+
+## Customizing Icons
+
+To add dynamic `size` and `color` properties to your icons, run the following script:
+
+```bash
+npm run generate-and-modify-icons
+```
+
+This will allow you to customize the appearance of icons when you use them in your React project.
+
+## Building the Library
+
+To bundle the icon components and generate the output files in the `dist/` directory, run:
+
+```bash
+npm run build
+```
+
+This will create both CommonJS and ES Module bundles, along with the type definitions.
+
+## Publishing to npm
+
+Follow these steps to publish your library to npm:
+
+1. Make sure you're logged in to npm:
+   ```bash
+   npm login
+   ```
+2. Publish the package:
+   ```bash
+   npm publish --access public
+   ```
+
+## License
+
+This project is licensed under the MIT License.
+
+## Contributing
+
+Feel free to fork this project and submit pull requests. Contributions are welcome!
+
+## Related Articles
+
+For those looking to deepen their understanding of how to create and publish a TypeScript library, I recommend checking out the following resources:
+
+- [How to Create a React Component Library Using Vite’s Library Mode](https://dev.to/receter/how-to-create-a-react-component-library-using-vites-library-mode-4lma)
+- [How to Write a Tree-Shakable Component Library](https://dev.to/lukasbombach/how-to-write-a-tree-shakable-component-library-4ied)
+- [How to Bundle a Tree-Shakable TypeScript Library with Tsup and Publish with npm](https://dev.to/orabazu/how-to-bundle-a-tree-shakable-typescript-library-with-tsup-and-publish-with-npm-3c46)
+
+These articles offer additional insights into creating efficient, tree-shakable libraries.