https://github.com/civicdatalab/opub-icons
React wrapper for adobe spectrum icons
https://github.com/civicdatalab/opub-icons
Last synced: 9 months ago
JSON representation
React wrapper for adobe spectrum icons
- Host: GitHub
- URL: https://github.com/civicdatalab/opub-icons
- Owner: CivicDataLab
- Created: 2022-10-16T19:09:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T10:15:18.000Z (about 3 years ago)
- Last Synced: 2025-09-10T03:05:14.961Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.06 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Opub Icons
- [Opub Icons](#opub-icons)
- [What is it?](#what-is-it)
- [Why this and not official one?](#why-this-and-not-official-one)
- [Is it tree shakable?](#is-it-tree-shakable)
- [How many icons?](#how-many-icons)
- [Licening](#licening)
- [Build](#build)
- [Create your Icon pack](#create-your-icon-pack)
## What is it?
React Icon pack based on the [spectrum icons](https://spectrum.adobe.com/page/icons/) by Adobe.
## Why this and not official one?
There is already a [react wrapper](https://react-spectrum.adobe.com/react-spectrum/workflow-icons.html) provided by Adobe team. But it doesn't work with Next.js. Atleast, not without adding the theme and other stuff from spectrum as well. [Read More](https://react-spectrum.adobe.com/react-spectrum/ssr.html).
## Is it tree shakable?
Yes! The SVG to JS tranformation flow is inspired by amazing folks at [Luicde](https://github.com/lucide-icons/lucide). After testing their icon library, we decided to do whatever they we doing.
## How many icons?
There are 901 workflow icons and 64 UI icons. [Read more about them](https://spectrum.adobe.com/page/iconography/)
`npm install @opub-icons/workflow` - for workflow icons
`npm install @opub-icons/ui` - for ui icons
## Licening
The repo is under Apache License 2.0. But, please go through both [Spectrum Licence](https://github.com/adobe/react-spectrum/blob/main/LICENSE) and [Lucide License](https://github.com/lucide-icons/lucide/blob/main/LICENSE) before deciding on anything.
## Build
`npm run build` on root of the repo will generate react components of both workflow and ui icons and also preapare them for publishing to npm.
## Create your Icon pack
Repalce `ui` and `workflow` directories from `/icons` in root directory. Do the same for `/packages`.
You would want to change the values in files under `/src` and `/scripts`.
Run `npm run build` from root.