agerix/iconify
2
0
Fork 0
mirror of https://github.com/iconify/iconify.git synced 2024-11-08 06:15:24 +00:00
Code Issues Releases Activity
08669af71f
iconify/components/svg-framework
History
Vjacheslav Trushkin 3bd902d5e4 chore: update counters in readme files
2023-11-12 19:36:23 +02:00
..
demo feat: support require-trusted-types-for policy 2023-06-22 11:50:27 +03:00
offline Restructure monorepo 2022-05-12 22:39:56 +03:00
src chore: rename badly named iconExists to iconLoaded 2023-07-04 19:45:04 +03:00
tests chore: rename badly named iconExists to iconLoaded 2023-07-04 19:45:04 +03:00
.eslintignore Restructure monorepo 2022-05-12 22:39:56 +03:00
.eslintrc.js Restructure monorepo 2022-05-12 22:39:56 +03:00
.gitignore Restructure monorepo 2022-05-12 22:39:56 +03:00
.npmignore Restructure monorepo 2022-05-12 22:39:56 +03:00
api-extractor.json Restructure monorepo 2022-05-12 22:39:56 +03:00
api-extractor.without-api.json Restructure monorepo 2022-05-12 22:39:56 +03:00
build.js Reuse storage for API data, clean up build scripts 2022-06-29 09:45:30 +03:00
jest.config.js Restructure monorepo 2022-05-12 22:39:56 +03:00
license.txt chore: update readme files and license years 2023-05-31 22:04:11 +03:00
package.json feat: support require-trusted-types-for policy 2023-06-22 11:50:27 +03:00
README.md chore: update counters in readme files 2023-11-12 19:36:23 +02:00
rollup.config.mjs chore(svg-framework): update terser 2023-04-02 10:42:40 +03:00
tsconfig-base.json chore: remove importsNotUsedAsValues from all tsconfig files 2023-04-01 20:41:40 +03:00
tsconfig.json Restructure monorepo 2022-05-12 22:39:56 +03:00

README.md

What is Iconify?

Iconify is the most versatile icon framework.

  • Unified icon framework that can be used with any icon library.
  • Out of the box includes 150+ icon sets with more than 200,000 icons.
  • Embed icons in HTML with SVG framework 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 SVG framework

There are many fonts and SVG sets available, but they all have one thing in common: using any font or SVG set limits you to icons that are included in that set and forces browsers to load entire font or icons set. That limits developers to one or two fonts or icon sets.

Iconify uses a new innovative approach to loading icons. Unlike fonts and SVG frameworks, Iconify only loads icons that are used on the page instead of loading entire fonts. How is it done? By serving icons dynamically from publicly available JSON API (you can make a copy of script and API if you prefer to keep everything on your servers).

Iconify SVG framework is designed to be as easy to use as possible.

Add this line to your page to load Iconify SVG framework (you can add it to <head> section of the page or before </body>):

<script src="https://code.iconify.design/3/3.1.1/iconify.min.js"></script>

or

<script src="https://cdn.jsdelivr.net/npm/@iconify/iconify@3.1.1/dist/iconify.min.js"></script>

or, if you are building a project with something like WebPack or Rollup, you can include the script by installing @iconify/iconify as a dependency and importing it in your project:

import Iconify from '@iconify/iconify';

To add any icon, write something like this:

<span class="iconify" data-icon="eva:people-outline"></span>

    Sample

or this:

<span class="iconify-inline" data-icon="fa-solid:home"></span>
<a href="#">Return home!</a>

    Screenshot

That is it. Change data-icon value to the name of the icon you want to use. There are over 200,000 premade icons to choose from, including FontAwesome, Material Design Icons, Tabler Icons, Box Icons, Unicons, Bootstrap Icons and even several emoji sets.

Do you want to make your own icon sets? Everything you need is available on GitHub: tools for creating custom icon sets, Iconify API application and documentation to help you.

Web component

SVG framework was designed a while ago, when browsers had poor support for web components.

However, this is no longer an issue. All modern browsers support web components.

A newer replacement for SVG framework is available: Iconify Icon web component. Consider switching to it.

Full documentation

Below is a shortened version of documentation.

Full documentation is available on Iconify website:

How does it work?

The syntax is similar to icon fonts. Instead of inserting SVG in the document, you write a placeholder element, such SPAN or I.

Iconify SVG framework finds those placeholders and uses the following logic to parse them:

  1. Retrieves icon name from data-icon attribute.
  2. Checks if icon exists. If not, it sends a request to Iconify API to retrieve icon data.
  3. Replaces placeholder element with SVG.

This is done in a fraction of a second. Iconify SVG framework watches DOM for changes, so whenever you add new placeholders, it immediately replaces them with SVG, making it easy to use with dynamic content, such as AJAX forms.

Offline usage

SVG framework is designed to be used with Iconify API, loading icon data on demand instead of bundling it.

If you want to use icons without Iconify API, there are many other options available.

Attributes

There are optional attributes to customise icon appearance.

Vertical alignment

Code examples above use different class names: the first example uses "iconify", the second example uses "iconify-inline".

What is the difference?

  • "iconify" renders icon as is, so it behaves like an image.
  • "iconify-inline" renders adds vertical alignment to the icon, making it behave like text (inline mode).

Usually, icon fonts do not render like normal images, they render like text. Text is aligned slightly below the baseline.

Visual example to show the difference between inline and block modes:

    Inline icon

Why is the inline mode needed?

  • To easily align icons within the text, such as emojis.
  • To make the transition from outdated icon fonts to SVG easier.

Use "iconify" for decorations, use "iconify-inline" if you want the icon to behave like an icon font.

data-inline attribute

In addition to using "iconify-inline" class, you can toggle inline mode with the data-inline attribute.

Set value to "true" to force inline mode, set value to "false" to use block mode.

Different ways to use block mode:

<span class="iconify" data-icon="eva:people-outline"></span>
<span class="iconify" data-icon="eva:people-outline" data-inline="false"></span>

Different ways to use inline mode:

<span class="iconify-inline" data-icon="eva:people-outline"></span>
<span class="iconify" data-icon="eva:people-outline" data-inline="true"></span>
<span
	class="iconify"
	data-icon="eva:people-outline"
	style="vertical-align: -0.125em"
></span>

Iconify API

When you use an icon font, each visitor loads an entire font, even if your page only uses a few icons. This is a major downside of using icon fonts. That limits developers to one or two fonts or icon sets.

Unlike icon fonts, Iconify SVG framework does not load the entire icon set. Unlike fonts and SVG frameworks, Iconify only loads icons that are used on the current page instead of loading entire icon sets. How is it done? By serving icons dynamically from publicly available JSON API.

Custom API

Relying on a third party service is often not an option. Many companies and developers prefer to keep everything on their own servers to have full control.

Iconify API and icon sets are all available on GitHub, making it easy to host API on your own server.

For more details see Iconify API documentation.

You can also create custom Iconify API to serve your own icons. For more details see hosting custom icons in Iconify documentation.

Color

There are 2 types of icons: monotone and coloured.

  • Monotone icons are icons that use only 1 colour and you can change that colour. Most icon sets fall into this category: FontAwesome, Unicons, Material Design Icons, etc.
  • Coloured icons are icons that use the preset palette. Most emoji icons fall into this category: Noto Emoji, Emoji One, etc. You cannot change the palette for those icons.

Monotone icons use font colour, just like glyph fonts. To change colour, you can do this:

<span class="iconify icon-bell" data-icon="vaadin-bell"></span>

and add this to CSS:

.icon-bell {
	color: #f80;
}
.icon-bell:hover {
	color: #f00;
}

Sample:

    Sample

Dimensions

By default all icons are scaled to 1em height. To control icon height use font-size:

<span class="iconify icon-clipboard" data-icon="emojione-clipboard"></span>

and add this to css:

.icon-clipboard {
	font-size: 32px;
}

Sample:

    Sample

you might also need to set line-height:

.icon-clipboard {
	font-size: 32px;
	line-height: 1em;
}

You can also set custom dimensions using data-width and data-height attributes:

<span
	data-icon="twemoji-ice-cream"
	data-width="32"
	data-height="32"
	class="iconify"
></span>

Sample:

    Sample

Transformations

You can rotate and flip icon by adding data-flip and data-rotate attributes:

<span
	data-icon="twemoji-helicopter"
	class="iconify"
	data-flip="horizontal"
></span>
<span data-icon="twemoji-helicopter" class="iconify" data-rotate="90deg"></span>

Possible values for data-flip: horizontal, vertical. Possible values for data-rotate: 90deg, 180deg, 270deg.

If you use both flip and rotation, the icon is flipped first, then rotated.

To use custom transformations use CSS transform rule.

<span data-icon="twemoji-helicopter" class="iconify icon-helicopter"></span>

.icon-helicopter {
	transform: 45deg;
}

Samples:

    Sample

Available icons

There are over 200,000 icons to choose from.

General collections (monotone icons):

and many others.

Emoji collections (mostly colored icons):

Also, there are several thematic collections, such as weather icons, map icons, etc.

You can use browse or search available icons on the Iconify website: https://icon-sets.iconify.design/

Click an icon to get HTML code.

Browser support

Iconify SVG framework supports all modern browsers.

License

This package is licensed under MIT license.

SPDX-License-Identifier: MIT

Previous versions of this package 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 license does not apply to icons. Icons are released under different licenses, see each icon set for details. Icons available by default are all licensed under some kind of open-source or free license.

© 2019-PRESENT Vjacheslav Trushkin