dioxus-free-icons

Crates.io	dioxus-free-icons
lib.rs	dioxus-free-icons
version	0.8.6
source	src
created_at	2022-06-19 04:56:41.884866
updated_at	2024-06-02 18:44:56.612157
description	Use free svg icons in your Dioxus projects easily with dioxus-free-icons.
homepage
repository	https://github.com/dioxus-community/dioxus-free-icons
max_upload_size
id	608818
size	10,069,832

Marc Espin (marc2332)

documentation

README

dioxus-free-icons 🙂

Use free svg icons in your Dioxus projects easily with dioxus-free-icons.

More information about this crate can be found in the crate documentation.

Install

To use dioxus-free-icons, add this to your Cargo.toml:

[dependencies]
dioxus-free-icons = { version = "0.8", features = ["font-awesome-brands"] }

Support features

The following features are available. Please see react-icons site to check the icon name and icon design.

Example

This library provides Icon component, which will generate SVG for a Font Awesome icon.

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	MIT License	1.8.3
Feather	MIT License	4.29.0
Font Awesome	CC BY 4.0 License	6.1.1
Heroicons	MIT License	1.0.6
Ionicons	MIT License	6.0.2
Lucide	ISC License	0.265.0
Material Design icons	Apache License 2.0	4.0.0
Octicons	MIT License	17.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

// generate icon files
cd packages/codegen
cargo run

Preview

cd packages/exmaple
cargo install dioxus-cli
dx serve

Update icons

checkout a new tag in the icon resource submodule
create new icon files
Update README.md and check the LICENSE

Commit count: 108