Iconify

Iconify is the most versatile icon framework.

• Unified icon framework that can be used with any icon library.
• Out of the box includes 200+ icon sets with more than 250,000 icons.
• Embed icons in HTML with Iconify Icon web component or components for front-end frameworks.
• Embed icons in designs with plug-ins for Figma, Sketch and Adobe XD.
• Add icon search to your applications with Iconify Icon Finder.

For more information visit https://iconify.design/.

Iconify parts

There are several parts of project, some are in this repository, some are in other repositories.

What is included in this repository?

• Directory packages contains reusable packages: types, utilities, functions used by various components.
• Directory iconify-icon contains iconify-icon web component that renders icons. It also contains wrappers for various frameworks that cannot handle web components.
• Directory components contains older version of icon components that are native to various frameworks, which do not use web component.
• Directory components-css contains components for rendering SVG with CSS, with Iconify API fallback for Safari browser.

Other repositories you might want to look at:

• Data for all icons is available in iconify/icon-sets repository.
• Tools for parsing icons and generating icon sets are available in iconify/tools repository.

Iconify icon components

Main packages in this repository are various icon components.

Why are those icon components needed? Iconify icon components are not just yet another set of icon components. Unlike other icon components, Iconify icon components do not include icon data. Instead, icon data is loaded on demand from Iconify API.

Iconify API provides data for over 200,000 open source icons! API is hosted on publicly available servers, spread out geographically to make sure visitors from all over the world have the fastest possible connection with redundancies in place to make sure it is always online.

Types of components

There are currently 2 types of components:

• Iconify icon components. These components render icon by name, loading icon data from Iconify API. They are very easy to use, but they do not work without API. You'll find them in iconify-icon (web component) and components directories.
• Iconify CSS icon components (in development). These components render SVG with CSS, which unfortunately is not supported by Safari browser, so for Safari it uses Iconify API as a fallback, loading icon data when needed and rendering it. You'll find them in components-css directory.

Why is API needed?

API is needed to load data for icons that you use.

For Iconify icon components, this means you don't need to worry about bundling all possible icons during development, component will load icons that are rendered.

For CSS icon components, this means fallback SVGs for Safari browser will be loaded only for users that use Safari browser (components check for feature support, not browser id), so you can move path data to CSS without worrying about visitors with old browsers.

You can also use API if you don't know what icons user will need, while offering thousands of icons to choose from. This is perfect for applications that can be customised by user.

Packages in this repository

There are several types of packages, split in their own directories.

Main packages

Directory packages contains main packages that are reusable by all other packages in this repository as well as third party components.

Main packages:

• Iconify types - TypeScript types.
• Iconify utils - common files used by various Iconify projects (including tools, API, etc...).

Packages used by Iconify icon components:

• API redundancy - library for managing redundancies for loading data from API: handling timeouts, rotating hosts. It provides fallback for loading icons if main API host is unreachable (will be deprecated in future, replaced by "Fetch" package).
• Iconify core - common files used by icon components (will be deprecated in future, replaced by "Component Utils" package).

Packages used by Iconify CSS icon components, will also be used in future by new versions of Iconify icon components:

• Fetch - Fetch wrapper with built in redundancy, allowing to use multiple hosts for request. Modern replacement of outdated "API redundancy" package.
• Component Utils - common files used by icon components, modern version of "Iconify core" package.

Web component

Directory iconify-icon contains iconify-icon web component and wrappers for various frameworks.

Frameworks that are confirmed to work with web components without custom wrappers:

• Svelte.
• Lit.
• Ember.
• Vue 2 and Vue 3, but requires custom config when used in Nuxt (see below).
• React, but with small differences, such as using class instead of className. Wrapper fixes it and provides types.

Demo

Directory iconify-icon-demo contains demo packages that show usage of iconify-icon web component.

• React demo - demo using web component with React. Run npm run dev to start demo.
• Next.js demo - demo for web component with Next.js. Run npm run dev to start demo.
• Svelte demo with Vite - demo for web component with Svelte using Vite. Run npm run dev to start demo.
• SvelteKit demo - demo for web component with SvelteKit. Run npm run dev to start the demo.
• Vue 3 demo - demo for web component with Vue 3. Run npm run dev to start demo.
• Nuxt 3 demo - demo for web component with Nuxt 3. Run npm run dev to start demo. Requires custom config, see below.
• SolidJS demo - demo using web component with SolidJS. Run npm run dev to start demo.

Nuxt 3 usage

When using web component with Nuxt 3, you need to tell Nuxt that iconify-icon is a custom element. Otherwise it will show few warnings in dev mode.

Example nuxt.config.ts:

export default defineNuxtConfig({
    vue: {
        compilerOptions: {
            isCustomElement: (tag) => tag === 'iconify-icon',
        },
    },
});

This configuration change is not needed when using Vue with @vitejs/plugin-vue.

Iconify icon components

Directory components contains native components for several frameworks:

Iconify CSS icon components

Directory components-css contains native components for several frameworks:

Unlike Iconify icon components, these components are intended to be used for rendering SVG + CSS, loading icon data from API only as a fallback option for Safari users.

Deprecation notice

Components in directory components are slowly phased out in favor of iconify-icon web component. Components are still maintained and supported, but it is better to switch to web component.

Functionality is identical, but web component has some advantages:

• No framework specific shenanigans. Events and attributes are supported for all frameworks.
• Works better with SSR (icon is rendered only in browser, but because icon is contained in shadow DOM, it does not cause hydration problems).
• Better interoperability. All parts of applicaiton reuse same web component, even if those parts are written in different frameworks.

Packages that have been deprecated, removed from this repository and are no longer maintained:

• SVG Framework: can be replaced with iconify-icon.
• Vue 2 component: can be replaced with iconify-icon, does not require Vue specific wrapper. Make sure you are not using Webpack older than version 5.
• Ember component: can be replaced with iconify-icon, does not require Ember specific wrapper.

Packages that are still available, but should be avoided:

• React component: can be replaced with iconify-icon using @iconify-icon/react wrapper.
• Svelte component: can be replaced with iconify-icon, does not require Svelte specific wrapper.
• Vue 3 component: can be replaced with iconify-icon, does not require Vue specific wrapper.

To import web component, just import it once in your script, as per iconify-icon README file.

Demo

Directory components-demo contains demo packages that show usage of icon components.

• React demo - demo for React component. Run npm run dev to start demo.
• Next.js demo - demo for React component with Next.js. Run npm run dev to start demo.
• Vue demo - demo for Vue component. Run npm run dev to start demo.
• Nuxt demo - demo for Vue component with Nuxt. Run npm run dev to start demo.
• Svelte demo with Vite - demo for Svelte component using Vite. Run npm run dev to start demo.
• SvelteKit demo - demo for SvelteKit, using Svelte component on the server and in the browser. Run npm run dev to start the demo.

Plugins

Plugin for Tailwind CSS has been rewritten and moved to a separate repository.

Installation, debugging and contributing

See CONTRIBUTING.md.

Sponsors

Documentation

Documentation for all packages is available on Iconify documentation website:

• Types documentation.
• Utilities documentation.
• Icon components documentation.
• Tailwind CSS plugin documentation.

Licence

Iconify is licensed under MIT license.

SPDX-License-Identifier: MIT

Some packages of this monorepo in previous versions were dual-licensed under Apache 2.0 and GPL 2.0 licence, which was messy and confusing. This was later changed to MIT for simplicity.

This licence does not apply to icons. Icons are released under different licences, see each icon set for details. Icons available by default are all licensed under various open-source licences.

© 2020-PRESENT Vjacheslav Trushkin