Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aykutkardas/svgps.app
SVGPS converts your icons into a single JSON file that is ready to use in your frontend or mobile projects.
https://github.com/aykutkardas/svgps.app
icomoon icons parser react svelte svg svg-icons svg-parser vue
Last synced: 10 days ago
JSON representation
SVGPS converts your icons into a single JSON file that is ready to use in your frontend or mobile projects.
- Host: GitHub
- URL: https://github.com/aykutkardas/svgps.app
- Owner: aykutkardas
- License: mit
- Created: 2021-08-15T16:25:17.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T10:23:09.000Z (7 months ago)
- Last Synced: 2024-08-02T13:35:12.389Z (3 months ago)
- Topics: icomoon, icons, parser, react, svelte, svg, svg-icons, svg-parser, vue
- Language: TypeScript
- Homepage: https://svgps.app
- Size: 9.33 MB
- Stars: 293
- Watchers: 6
- Forks: 24
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
## 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](https://github.com/aykutkardas/react-icomoon), [vue-icomoon](https://github.com/aykutkardas/vue-icomoon) or [svelte-icomoon](https://github.com/aykutkardas/svelte-icomoon) packages.
## What is Icomoon?
[Icomoon](https://icomoon.io/) 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
- [React](https://github.com/aykutkardas/react-icomoon)
- [React Native](https://github.com/aykutkardas/react-icomoon#react-native---demo)
- [Preact](https://github.com/aykutkardas/preact-icomoon)
- [Vue](https://github.com/aykutkardas/vue-icomoon)
- [Svelte](https://github.com/aykutkardas/svelte-icomoon)
### 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
```
```jsx
// Icon.jsx
import IcoMoon from "react-icomoon";
import iconSet from "./selection.json";
const Icon = (props) => ;
export default Icon;
```
See [react-icomoon](https://github.com/aykutkardas/react-icomoon) or [vue-icomoon](https://github.com/aykutkardas/vue-icomoon) for details on how to use the `Icon` component.
---
## Become a sponsor to Core Maintainers 🥤
[](https://github.com/sponsors/aykutkardas)
[](https://github.com/sponsors/gizemnkorkmaz)
---
### Related Links
- [svgps](https://github.com/aykutkardas/svgps)
- [svgps-cli](https://github.com/aykutkardas/svgps-cli)