mirror of https://github.com/iconify/iconify.git synced 2024-12-13 14:13:06 +00:00

History

Vjacheslav Trushkin f1b840918c Publish new components as stable		2021-08-09 09:22:08 +03:00
..
src	Move few more functions from Core to Utils, update packages	2021-05-26 10:01:23 +03:00
tests	Test mismatched API provider in API response	2021-06-15 18:48:31 +03:00
.eslintignore	Move version 2 to a big monorepo	2020-04-28 12:47:35 +03:00
.eslintrc.js	Update dependencies	2020-09-03 10:36:15 +03:00
.gitignore	Publish Iconify Core	2020-04-28 14:27:58 +03:00
.npmignore	Publish Iconify Core	2020-04-28 14:27:58 +03:00
package-lock.json	Publish new components as stable	2021-08-09 09:22:08 +03:00
package.json	Fix replacing ids in icons to support animations	2021-07-01 12:00:13 +03:00
README.md	Update dependencies, rewrite readme files	2021-06-20 09:59:30 +03:00
tsconfig-base.json	Update dependencies, rewrite readme files	2021-06-20 09:59:30 +03:00
tsconfig.json	Move version 2 to a big monorepo	2020-04-28 12:47:35 +03:00

README.md

Iconify Core

Iconify is the most versatile icon framework.

Unified icon framework that can be used with any icon library.
Out of the box includes 90+ icon sets with 80,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 Core contains code shared among various Iconify implementations.

Documentation

Documentation is currently not available because there is no demand for it.

If anyone would like to create custom Iconify implementation and needs documentation for Iconify Core, please create an issue on Iconify repository on GitHub.

You can browse icon components documentation, which explains how most functions exported by core package work. Components mostly just re-export functions from this package.

License

Iconify is dual-licensed under Apache 2.0 and GPL 2.0 license. You may select, at your option, one of the above-listed licenses.

SPDX-License-Identifier: Apache-2.0 OR GPL-2.0

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.