https://github.com/itsbrex/dfx-icons
Auto-generate size-labeled plaeholder icon set for new Chrome extension projects
https://github.com/itsbrex/dfx-icons
Last synced: 3 months ago
JSON representation
Auto-generate size-labeled plaeholder icon set for new Chrome extension projects
- Host: GitHub
- URL: https://github.com/itsbrex/dfx-icons
- Owner: itsbrex
- License: mit
- Created: 2023-08-08T21:20:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T14:30:03.000Z (over 1 year ago)
- Last Synced: 2025-02-19T22:11:55.747Z (3 months ago)
- Language: JavaScript
- Size: 218 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎨 dfx-cons
> 💡 **Note:** gif above shows local `yarn` usage. Use `npx` if you don't want to install this package locally.
## Overview
This package generates a set of uniform placeholder icons with size labels. It is designed to assist you in creating new Chrome/web extensions. The idea was inspired by an [old archived repository](https://github.com/jbrudvik/chrome-extension-icon-sizes) that stored pre-made image sizes. I turned the concept into a simple `npm` package that is modular and customizable.
## Requirements
- Node.js `16.2.0` to install globally (using `npx` is easier if you're using a new version of `node`.)
- `npm` or `yarn`
## Usage
- `npx dfx-icons` generates all sizes of the same color and outputs them to the assets/icons folder
- `npx dfx-icons --sizes 16 48 128 --random` generates only the specified sizes with random colors
> You can also install globally with `npm i -g dfx-icons` and run `dfx-icons` from anywhere. Requires node 16.2.0 so `npx` method is recommended.
## Features
- Generates icons of various sizes
- Allows customization of icon sizes and colors
- Overlays the size of the icon on top of the icon to help with debugging
## Contributing
Contributions are welcome!
If you find any bugs or want to suggest new features, please feel free to contribute by submitting an [issue](https://github.com/itsbrex/dfx-icons/issues) or a [pull request](https://github.com/itsbrex/dfx-icons/pulls).
## Contributors ✨
([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)):
[](##Contributing)
This project follows the [all-contributors](https://allcontributors.org/) specification. Contributions of any kind welcome!
## License
Licensed under the MIT license. See the [LICENSE](./LICENSE) file for more information.
If you found this project interesting or helpful, please consider [sponsoring me](https://github.com/sponsors/itsbrex) or following me on twitter 