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 proicons from 'proicons';

// Refer to the icon
proicons.icons.add;

or

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

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

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

HTML

If you are not inside a Node environment, you can import the ProIcons script 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>

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

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