Skip to content

Installation

Getting started with ProIcons doesn't take long. Follow the steps below for your environment:

HTML

Method 1: Use a CDN provider

The easiest way to install ProIcons is via a CDN provider such as UNPKG

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

Method 2: Install locally

If you want to use ProIcons locally, you can also install ProIcons via NPM.

shell
npm install proicons
shell
yarn add proicons
shell
pnpm add proicons
shell
bun add proicons

Then import your proicons.js file in your HTML

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

Replace path/to/ with the actual path to your node_modules folder (relative to the HTML file).

Node.js

Install ProIcons from NPM:

shell
npm install proicons
shell
yarn add proicons
shell
pnpm add proicons
shell
bun add proicons
javascript
import { AddIcon } from 'proicons';

Or in CommonJS:

javascript
const proicons = require('proicons');
const { AddIcon } = proicons

HTML Webfont

If you prefer not to use any scripts, you can also install ProIcons as a webfont on your site.

Import via UNPKG

html
<link rel="stylesheet" href="https://unpkg.com/@proicons/webfont">

Install package via NPM

shell
npm install @proicons/webfont
shell
yarn add @proicons/webfont
shell
pnpm add @proicons/webfont
shell
bun add @proicons/webfont
html
<link rel="stylesheet" href="path/to/@proicons/webfont/ProIcons.css">

Read the documentation

React

Install via NPM:

shell
npm install @proicons/react
shell
yarn add @proicons/react
shell
pnpm add @proicons/react
shell
bun add @proicons/react

Read the documentation

Svelte

Install via NPM:

shell
npm install @proicons/svelte
shell
yarn add @proicons/svelte
shell
pnpm add @proicons/svelte
shell
bun add @proicons/svelte

Read the documentation

Vue

Install via NPM:

shell
npm install @proicons/vue
shell
yarn add @proicons/vue
shell
pnpm add @proicons/vue
shell
bun add @proicons/vue

Read the documentation

Released under the MIT License.