Iconify for Vue 2

Iconify offers native icon components for several popular UI frameworks.

Iconify for Vue is one of such components.

Yet another icon component? What are the advantages over other icon components?

• One syntax for over 200,000 icons from 150+ icon sets.
• Renders SVG. Many components simply render icon fonts, which look ugly. Iconify uses only pixel perfect SVG.
• Loads icons on demand. No need to bundle icons, component will automatically load icon data for icons that you use from Iconify API.

This documentation is for Vue component for Vue 2.

If you are using Vue 3, see documentation for Vue 3 component.

Or consider switching to modern web component that works with Vue 2, Vue 3 and Nuxt.

Installation

If you are using NPM:

npm install --save-dev @iconify/vue2

If you are using Yarn:

yarn add --dev @iconify/vue2

Usage

Install @iconify/vue2 and import component from it (component is exported as named export):

jsimport { Icon } from '@iconify/vue2';

Then in template use Icon component with icon name as icon parameter:

jsx<Icon icon="mdi-light:home" />

Nuxt.js

Component is compatible with Nuxt.js.

The component does not retrieve icon data until it is mounted. For server side rendering it means generated HTML will not include SVGs, icons will be rendered only on the client side after hydration is complete.

If you do want to render SVGs on the server side, provide icon data as a parameter instead of icon name or use a different icon component.

Properties

You can pass any custom properties to component.

Required properties:

• icon, IconifyIcon|string icon name or icon data.

Optional properties:

• inline, boolean changes vertical alignment.
• width, string|number icon width.
• height, string|number icon height.
• horizontalFlip, boolean flips icon horizontally.
• verticalFlip, boolean flips icon vertically.
• flip, string alternative to horizontalFlip and verticalFlip.
• rotate, number|string rotates icon.
• color, string changes icon color.
• onLoad, function is a callback that is called when icon data has been loaded. See below.

See below for more information on each optional property.

In addition to the properties mentioned above, the icon component accepts any other properties and events. All other properties and events will be passed to generated SVG element, so you can do stuff like setting the inline style, add title, add onClick event and so on.

Icon

Icon name is a string, which has 3 parts:

@api-provider	:	icon-prefix	:	icon-name
provider		prefix		name

• provider points to API source. Starts with "@", can be empty (empty value is used for public Iconify API).
• prefix is name of icon set.
• name is name of icon.

Examples of valid icon names:

• flat-color-icons:voice-presentation - icon is "voice-presentation" from Flat Color Icons icon set, from public Iconify API.
• mdi-light:home - icon is "home" from Material Design Light icon set, from public Iconify API.

Exceptions:

• If the API provider is empty, it can be skipped (like in examples above).
• If prefix does not contain "-", prefix and icon name can be separated with hyphen. This is to support people migrating from icon fonts. For example, fa:arrow-left and fa-arrow-left are identical because "fa" does not contain hyphen.

There are over 200,000 icons available from 150+ icon sets. Browse icons sets to see all available icons.

You can also add custom API providers for more icon choices. See API providers documentation.

Color

You can only change the color of monotone icons. Some icons, such as emoji, have a hardcoded palette that cannot be changed.

To add color to a monotone icon, simply change text color.

vue<Icon icon="mdi:home" style="color: red" />


For various ways to set color, see how to change icon color in Iconify for Vue.

Dimensions

By default, icon height is set to "1em", icon width is changed dynamically based on the icon's width/height ratio. This makes it easy to change icon size by changing font-size in the stylesheet, just like icon fonts.

There are several ways to change icon dimensions:

• Setting font-size in style (or fontSize if you are using inline style).
• Setting width and/or height property.

Values for width and height can be numbers or strings.

If you set only one dimension, another dimension will be calculated using the icon's width/height ratio. For example, if the icon size is 16 x 24, you set the height to 48, the width will be set to 32. Calculations work not only with numbers, but also with string values.

vue<Icon icon="mdi:home" style="font-size: 24px;" />


For various ways to change icon dimensions, see how to change icon dimensions in Iconify for Vue.

Transformations

An icon can be rotated and flipped horizontally and/or vertically. All transformations are done relative to the center of the icon.

These are not CSS transformations, transformations are applied inside SVG.

For more details see how to transform icon in Iconify for Vue.

onLoad

onLoad property is an optional callback function. It is called when icon data has been loaded.

It is not an event, such as click event for links, it is a simple callback function.

When onLoad is called:

• If value of icon property is an object, onLoad is not called.
• If value of icon property is a string and icon data is available, onLoad is called on first render.
• If value of icon property is a string and icon data is not available, onLoad is called on first re-render after icon data is retrieved from API.

What is the purpose of onLoad? To let you know when Icon component renders an icon and when it does not render anything. This allows you to do things like adding class name for the parent element, such as "container--with-icon" that modify layout if icon is being displayed.

Functions

Component exports various functions, which developers can use to control icons.

Functions are split in several groups (click function name to see more details and examples):

Check available icons

There are several functions in this section:

• iconExists(name). Checks if icon data is available, returns boolean.
• listIcons(). Lists available icons, returns string[].
• getIcon(name). Returns icon data, returns IconifyIcon object.

Adding icons

Functions for adding icons to the component:

• addIcon(). Adds one icon.
• addCollection(). Adds an icon set.

Note: icons added to the component with these functions are not stored in the icon data cache. Component caches only icons retrieved from API.

Helper functions

• replaceIDs(html). Randomises IDs in generated string. This should be used when rendering icon based on data returned by getIcon() to make sure elements inside each icon have unique IDs.
• calculateSize(). Calculates icon size. It is used to calculate width if only height is set and vice versa.
• buildIcon(icon, customisations?). Generates data used by icon component. This can be used if you prefer to generate <svg> yourself. Data includes attributes for <svg> and inner HTML.

API functions

• loadIcons(icons, callback?). Loads icons from API, calls optional callback when either all or part of icons have been loaded.
• loadIcon(icon). Loads one icon from API, returns Promise.
• enableCache(). Enables caching in localStorage and sessionStorage.
• disableCache(). Disables caching in localStorage and sessionStorage.
• addAPIProvider(). Adds custom API provider. See API providers documentation.

Internal API functions

There are several internal API functions that are exposed. They are intended to be used by developers that need more control over the component. For example, it is used in Sketch and Figma plug-ins. Use them carefully.

All internal API functions are exposed as properties of _api object:

• getAPI(). Returns internal API module.
• getAPIConfig(). Returns API configuration.
• setAPIModule(provider). Sets API module for provider. This is an experimental function intended for custom API providers that use custom module for retrieving data from API.
• setFetch(fetch). Set custom Fetch API.
• getFetch(). Returns used fetch() function, null if Fetch API is not available.