-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
1 addition
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,113 +0,0 @@ | ||
[![Discord Server](https://img.shields.io/discord/899851952891002890.svg?logo=discord&style=flat-square)](https://discord.gg/sKJSVNSCDJ) | ||
[![Crates.io](https://img.shields.io/crates/v/dioxus-free-icons)](https://crates.io/crates/dioxus-free-icons) | ||
|
||
# dioxus-free-icons 🙂 | ||
|
||
Use free svg icons in your [Dioxus](https://dioxuslabs.com/) projects easily with dioxus-free-icons. | ||
|
||
More information about this crate can be found in the [crate documentation](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/). | ||
|
||
## Install | ||
|
||
To use `dioxus-free-icons`, add this to your Cargo.toml: | ||
|
||
```toml | ||
[dependencies] | ||
dioxus-free-icons = { version = "0.7.0", features = ["font-awesome-brands"] } | ||
``` | ||
|
||
### Support features | ||
|
||
The following features are available. Please see [react-icons site](https://react-icons.github.io/react-icons) to check the icon name and icon design. | ||
|
||
- [bootstrap](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/bs_icons/index.html) | ||
- [font-awesome-brands](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/fa_brands_icons/index.html) | ||
- [font-awesome-regular](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/fa_regular_icons/index.html) | ||
- [font-awesome-solid](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/fa_solid_icons/index.html) | ||
- [feather](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/fi_icons/index.html) | ||
- [octicons](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/go_icons/index.html) | ||
- [hero-icons-outline](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/hi_outline_icons/index.html) | ||
- [hero-icons-solid](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/hi_solid_icons/index.html) | ||
- [ionicons](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/io_icons/index.html) | ||
- [material-design-icons-action](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_action_icons/index.html) | ||
- [material-design-icons-alert](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_alert_icons/index.html) | ||
- [material-design-icons-av](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_av_icons/index.html) | ||
- [material-design-icons-communication](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_communication_icons/index.html) | ||
- [material-design-icons-content](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_content_icons/index.html) | ||
- [material-design-icons-device](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/io_icons/index.html) | ||
- [material-design-icons-editor](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_editor_icons/index.html) | ||
- [material-design-icons-file](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_file_icons/index.html) | ||
- [material-design-icons-hardware](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_hardware_icons/index.html) | ||
- [material-design-icons-home](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_home_icons/index.html) | ||
- [material-design-icons-image](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_image_icons/index.html) | ||
- [material-design-icons-maps](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_maps_icons/index.html) | ||
- [material-design-icons-navigation](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_navigation_icons/index.html) | ||
- [material-design-icons-notification](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_notification_icons/index.html) | ||
- [material-design-icons-places](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_places_icons/index.html) | ||
- [material-design-icons-social](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_social_icons/index.html) | ||
- [material-design-icons-toggle](https://docs.rs/dioxus-free-icons/0.7.0/dioxus_free_icons/icons/md_toggle_icons/index.html) | ||
|
||
## Example | ||
|
||
This library provides Icon component, which will generate SVG for a Font Awesome icon. | ||
|
||
```rust | ||
use dioxus::prelude::*; | ||
use dioxus_free_icons::icons::fa_brands_icons::FaRust; | ||
use dioxus_free_icons::Icon; | ||
|
||
fn RustIcon() -> Element { | ||
rsx!( | ||
Icon { | ||
width: 30, | ||
height: 30, | ||
fill: "black", | ||
icon: FaRust, | ||
} | ||
) | ||
} | ||
``` | ||
|
||
## License | ||
|
||
This project is licensed under the MIT license. | ||
|
||
### Icon | ||
|
||
Icon Library|License|Version | ||
---|---|--- | ||
[Bootstrap Icons](https://icons.getbootstrap.com/)|[MIT License](https://github.com/twbs/icons/blob/main/LICENSE.md)| [1.8.3](https://github.com/twbs/icons/tree/v1.8.3) | ||
[Feather](https://feathericons.com/)|[MIT License](https://github.com/feathericons/feather/blob/master/LICENSE)| [4.29.0](https://github.com/feathericons/feather/tree/v4.29.0) | ||
[Font Awesome](https://fontawesome.com/)|[CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/)| [6.1.1](https://github.com/FortAwesome/Font-Awesome/tree/6.1.1) | ||
[Heroicons](https://heroicons.com/)|[MIT License](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE)| [1.0.6](https://github.com/tailwindlabs/heroicons/tree/v1.0.6) | ||
[Ionicons](https://ionic.io/ionicons)|[MIT License](https://github.com/ionic-team/ionicons/blob/main/LICENSE)| [6.0.2](https://github.com/ionic-team/ionicons/tree/v6.0.2) | ||
[Material Design icons](https://developers.google.com/fonts/docs/material_icons)|[Apache License 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE)| [4.0.0](https://github.com/google/material-design-icons/tree/4.0.0) | ||
[Octicons](https://primer.style/octicons/)|[MIT License](https://github.com/primer/octicons/blob/main/LICENSE)| [17.3.0](https://github.com/primer/octicons/tree/v17.3.0) | ||
|
||
## Contribution | ||
|
||
The project welcomes all contributions from anyone willing to work in good faith with other contributors and the community. | ||
In particular, contributions regarding support for other free icons such as Material Design icons or Ionicons are welcome. | ||
This library aims to be a react-icons-like library for dioxus projects. | ||
|
||
### Development | ||
|
||
```sh | ||
// generate icon files | ||
cd packages/codegen | ||
cargo run | ||
``` | ||
|
||
### Preview | ||
|
||
```sh | ||
cd packages/exmaple | ||
cargo install dioxus-cli | ||
dx serve | ||
``` | ||
|
||
### Update icons | ||
|
||
1. checkout a new tag in the icon resource submodule | ||
2. create new icon files | ||
3. Update README.md and check the LICENSE | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[package] | ||
name = "dioxus-free-icons" | ||
version = "0.8.0" | ||
version = "0.8.1" | ||
edition = "2021" | ||
authors = ["Daiki Nishikawa <[email protected]>", "Marc Espín <[email protected]>"] | ||
description = "Use free svg icons in your Dioxus projects easily with dioxus-free-icons." | ||
|