Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 2.64 KB

README.md

File metadata and controls

61 lines (38 loc) · 2.64 KB

SVGPS

What is SVGPS?

SVGPS converts your icons into a single JSON file that is ready to use in your frontend or mobile projects.

Why do you need it?

Dealing with a large number of icon files, converting them into components or using them directly as SVGs can be frustrating. You can convert your icons into fonts, but unfortunately, it deprives us of the benefits of SVG format. That is why we found a way to store all our icons in a single JSON file and use them as SVGs!

How does it work?

Just import the icons that you want to use in your project! You can rename your icons, add new ones or remove them as you like. After creating a set of icons, SVGPS parses the data of that set and creates the single file you need. You can use that JSON file directly in your projects with the help of react-icomoon, vue-icomoon or svelte-icomoon packages.

What is Icomoon?

Icomoon is an icon management tool that allows you to convert your icon packs into many different formats. It produces a document for your packs, and SVGPS is built as an alternative to smooth the conversion process by allowing you to get a JSON file directly without feeling lost.

Supported Frameworks

Usage Example

Your Icon component and the JSON file you created are located in the same directory and combined with the help of *-icomoon packages previously mentioned.

Icon
|____ Icon.jsx
|____ selection.json
// Icon.jsx
import IcoMoon from "react-icomoon";
import iconSet from "./selection.json";

const Icon = (props) => <IcoMoon iconSet={iconSet} {...props} />;

export default Icon;

See react-icomoon or vue-icomoon for details on how to use the Icon component.


Become a sponsor to Core Maintainers 🥤

aykutkardas gizemnkorkmaz


Related Links