mirror of https://github.com/iconify/iconify.git synced 2024-11-08 14:20:57 +00:00

History

Vjacheslav Trushkin 08d2a5b4b4 chore: update core package		2023-11-27 13:36:07 +02:00
..
src	chore: limits for browser storage	2023-08-01 21:42:56 +03:00
tests	chore: update dependencies in packages	2023-08-01 22:03:20 +03:00
.eslintignore	WIP: moving core to unbuild and vitest	2022-03-16 12:12:25 +02:00
.eslintrc.cjs	WIP: moving core to unbuild and vitest	2022-03-16 12:12:25 +02:00
.gitignore	WIP: moving core to unbuild and vitest	2022-03-16 12:12:25 +02:00
.npmignore	Fix tsconfig in core, specify config when clearing jest cache	2022-03-16 16:10:14 +02:00
build.config.ts	Use unbuild to build core package	2022-03-14 18:12:01 +02:00
license.txt	chore: update readme files and license years	2023-05-31 22:04:11 +03:00
package.json	chore: update core package	2023-11-27 13:36:07 +02:00
README.md	chore: update counters in readme files	2023-11-12 19:36:23 +02:00
tsconfig.common.json	chore: remove importsNotUsedAsValues from all tsconfig files	2023-04-01 20:41:40 +03:00
tsconfig.json	Fix tsconfig in core, specify config when clearing jest cache	2022-03-16 16:10:14 +02:00
vitest.config.mjs	Fix include in vitest config in core	2022-03-16 12:14:35 +02: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 150+ icon sets with 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 and Sketch.
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

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.