carlosted / icondata Goto Github PK

View Code? Open in Web Editor NEW

43.0 1.0 9.0 80.41 MB

SVG Icon data from multiple free icon libraries ported to rust.

License: MIT License

Just 0.01% Rust 99.99% HTML 0.01% CSS 0.01% JavaScript 0.01%

icondata's Introduction

Icondata

This crate provides SVG icon data from popular and free icon libraries.

A site referencing every icon is available!

Icondata
Table of Contents
Usage
Icon Packages
Developing
Contributing

Usage

Every crate is tied to a specific icon package. You can find the name of the crate corresponding to a package in the Icon Packages section.

Please see the API documentation to get started.

Icon Packages

Licenses of the icons provided through these libraries were extracted with best intent, but must only be taken as a hint. Please check the individual icon repositories for up-to-date license information.

Icon Library	Version	Source	License	Crate Name
Ant Design Icons	4.3.1	Git: https://github.com/ant-design/ant-design-icons - Branch: master - Commit: e09efdead14961d3cc9ec0c24a182f66241436de	MIT,	icondata_ai
BoxIcons	2.1.4	Git: https://github.com/atisawd/boxicons - Branch: master - Commit: 9ffa9136e8681886bb7bd2145cd4098717ce1c11	CC BY 4.0,	icondata_bi
Bootstrap Icons	1.11.0	Git: https://github.com/twbs/icons - Tag: v1.11.0	MIT,	icondata_bs
css.gg	2.1.1	Git: https://github.com/astrit/css.gg - Tag: 2.1.1	MIT,	icondata_cg
Charm	0.18.0	Git: https://github.com/jaynewey/charm-icons - Tag: v0.18.0	MIT,	icondata_ch
Font Awesome	6.4.2	Git: https://github.com/FortAwesome/Font-Awesome - Tag: 6.4.2	CC BY 4.0,	icondata_fa
Feather	4.29.1	Git: https://github.com/feathericons/feather - Tag: v4.29.1	MIT,	icondata_fi
Heroicons	2.0.18	Git: https://github.com/refactoringui/heroicons - Tag: v2.0.18	MIT,	icondata_hi
IcoMoon Free	unknown	Git: https://github.com/Keyamoon/IcoMoon-Free - Branch: master - Commit: d006795ede82361e1bac1ee76f215cf1dc51e4ca	CC BY 4.0, GPL,	icondata_im
Ionicons	7.1.2	Git: https://github.com/ionic-team/ionicons - Tag: v7.1.2	MIT,	icondata_io
Lucide	0.265.0	Git: https://github.com/lucide-icons/lucide - Tag: v0.265.0	ISC,	icondata_lu
Github Octicons	19.7.0	Git: https://github.com/primer/octicons - Tag: v19.7.0	MIT,	icondata_oc
Remix Icon	3.5.0	Git: https://github.com/Remix-Design/RemixIcon - Tag: v3.5.0	Apache 2.0,	icondata_ri
Simple Icons	9.14.0	Git: https://github.com/simple-icons/simple-icons - Tag: 9.14.0	CC0 1.0 Universal,	icondata_si
Tabler Icons	2.34.0	Git: https://github.com/tabler/tabler-icons - Tag: v2.34.0	MIT,	icondata_tb
Typicons	2.1.2	Git: https://github.com/stephenhutchings/typicons.font - Tag: v2.1.2	CC BY-SA 3.0,	icondata_ti
VS Code Icons	0.0.33	Git: https://github.com/microsoft/vscode-codicons - Tag: 0.0.33	CC BY 4.0,	icondata_vs
Weather Icons	2.0.12	Git: https://github.com/erikflowers/weather-icons - Tag: 2.0.12	SIL OFL 1.1,	icondata_wi

Developing

This repository uses Just

Simply call

just

to see a list of available commands.

You may need to install just using

cargo install just

Contributing

Contributions are more than welcomed! Do not hesitate add icon libraries, features, etc.

icondata's People

Contributors

Stargazers

Watchers

Forkers

jaynewey sleeplessone1917 adrianncovaci lpotthast workingjubilee mondeja aparo luoxiaozero martijnarts

icondata's Issues

Automatically update icon packs based on their Github Releases

This would use Renovate (as suggested here: #37 (comment)).

I'm working on this, just opening the thread for discussion!

Feature/Bug Tracker

Here is a table of missing features and bugs for this crate. Please do try your hand at any of the tasks listed below if you feel like it would improve your developer experience!

RAM usage issue with rust-analyzer.
I have not found a way to configure rust-analyzer so that it does not import into memory every icon's name, even when the library is not imported. icondata seems to take around 700MB of RAM on my machine with rust-analyzer. I'm not highly knowledgeable about rust-analyzer's infrastructure, but I believe it would require us to file an issue to rust-analyzer to add configuration options for our use case.
Explorer site not working on small screens.
This issue is a simple task, it only requires making a dynamic header with tailwind.
Most icons from HeroIcons are not rendering.
Writing a cron job that periodically updates icon libraries.
What should we do with icon categories e.g., Sm, Md, Lg, etc.? Are they useful, or are they simply scaled up versions of other icons?
Make sure (with a CI test or the like) that every icon can be properly styled.
Some icons can't seem to be styled because they use internal styles.
Revisit they way twotone icons are handled.
currently, we set a class on the secondary elements of twotone icons, but maybe there is a better solution.

Licensing?

This project looks very interesting and useful. I'm confused about the licensing situation here. The readme mentions:

Licenses of the icons provided through these libraries were extracted with best intent, but must only be taken as a hint. Please check the individual icon repositories for up-to-date license information.

It seems like understanding and complying with the terms of the source package licenses would be a necessary first step ahead of repackaging them for distribution? There are important terms that this project might not be in compliance with. For instance, at least the MIT-licensed projects expect their copyright notice to be maintained.

Site is down

Just a heads up, been down for a few days: https://carlosted.github.io/icondata It was really handy.

Thanks for this crate, lmk there's anything we can help with.

IconData should derive common functionality

IconData is a public item and does not derive anything. It should at least derive Debug.
It could probably safely

#[derive(Debug, PartialEq, Eq, Clone, Copy)]