Crate dioxus_material_icons

Source
Expand description

§🧬 Dioxus Material Icons

This project provides a simple but configurable component to render Google’s Material Icons in Dioxus.

Β§πŸš€ How to get started

cargo add dioxus-material-icons

This project introduces two components:

  1. MaterialIconStylesheet
  2. MaterialIcon

To be able to use the MaterialIcon component anywhere in your code, you first have to include a MaterialIconStylesheet component. When you want to use the default settings, just add it to your app’s root component like this:

MaterialIconStylesheet { }

Have a look at the MaterialIconStylesheet docs for more options like self-hosting the icon font file.

After that you can use the MaterialIcon component like you would expect it:

MaterialIcon { name: "settings" }

You can additionally specify the color and size.

MaterialIcon {
    name: "settings",
    size: 24,
    color: MaterialIconColor::Light,
}

Β§πŸ’‘ Examples

Β§Alternatives

Β§πŸ“œ License

This software is licensed under the terms of the MIT License.

Note: All Material Icons are licensed under the Apache License 2.0.

Β© 2023 Lennart Kloock

StructsΒ§

MaterialIconProps
Props for the MaterialIcon component
MaterialIconStylesheetProps
Props for the MaterialIconStylesheet component

EnumsΒ§

MaterialIconColor
Colors of Material Icons
MaterialIconVariant
Variants (also called categories) of the Material Icon font

FunctionsΒ§

IconColor
Create a new MaterialIconColor::Custom variant
MaterialIcon
Material Icon component
MaterialIconStylesheet
Stylesheet component