ProIcons

Work in progress

Most of the website and planned packages aren't currently finished, but you can start using the beta package right now on NPM. See ROADMAP.md to learn more.

Usage

Node.js

1. Install the ProIcons package via NPM:

npm install proicons

2. Use ProIcons inside JavaScript

import { icons } from 'proicons';
// or
const { icons } = require('proicons')

// Refer to the icon
icons.add;

or

<!-- Insert the icon -->
<i proicon="add"></i>

<script src="path/to/proicons/dist/umd/proicons.cjs"></script>

<!-- Replace icons with SVG -->
<script>
    proicons.replace();
</script>

HTML

You can import the ProIcons package via a CDN provider

<!-- Insert the icon -->
<i proicon="add"></i>

<script src="https://unpkg.com/proicons"></script>

<!-- Replace icons with SVG -->
<script>
    proicons.replace();
</script>

Packages

ProIcons is also available in the following packages:

• Webfont: Use ProIcons on your website as a webfont, similar to Font Awesome, without the need of scripts.

License

ProIcons is MIT-licensed, giving you peace of mind using these icons in your project. Learn more here

[!WARNING] This library contains brand icons that may not be MIT-licensed and may have additional terms and guidelines. Learn more here

Contributing

For more info on how to contribute, please see our contributing guide.

Credits

• Icon design and guidelines inspired by Microsoft's Fluent System Icons
• Alpha bleeding script from https://github.com/Corecii/Transparent-Pixel-Fix
• API based on Feather Icons
• Website design inspired by Lucide and built using VitePress