seed-icons-gen

Crates.ioseed-icons-gen
lib.rsseed-icons-gen
version0.3.2
sourcesrc
created_at2020-06-12 08:51:34.769365
updated_at2020-10-21 21:46:15.046571
descriptionGenerate font-awesome icons for Seed
homepage
repositoryhttps://gitlab.com/strwrite/seed-icons.git
max_upload_size
id253198
size31,066
(strowk)

documentation

README

Icons Collections for Seed

Seed is an awesome framework to develop single page applications.

This is a utility crate containing functions to use during build of other packages, for example seed-icons.

get_fa_resources

To use Font-Awesome collection of icons easier this crate provides get_fa_resources function, which you can use to download folder font-awesome to specified location. Inside font-awesome you'd find stylesheets required to link from your index.html. The idea is to call that function from your build.rs and ignore font-awesome folder from VCS, so that icons resources would be downloaded during build of your SPA.

Read more in seed-icons.

get_mi_resources

This method allows to download resources to use material icons, which is a part of material design.

Unfortunately this way of downloading resources only supports regular icons. Other types of icons, which are also part of this collection (outlined, round, sharp, etc) are not included and therefore it's recommened to get necessary resources manually from Google Fonts instead.

write_all

Crate provides write_all function to generate icons to use with Seed. write_all is intended to be used from seed-icons package, during its build and you probably don't need to use it by yourself.

write_all does not provide you with icons themselves (you stil have to get and reference CSS / fonts files from your index.html), but it generates icons.rs file with module for each icon, which should give you a convenient way to use them in your application.

registry

Registry is a several generated methods, such as font_awesome_collection and material_icons_collection. Those methods return a generic structures with information about available collections, which later are used in seed_icons_browser crate to dynamicly display all available icons.

Commit count: 83

cargo fmt