zuicon_material/
lib.rs

1// Copyright (c) 2024 Xu Shaohua <shaohua@biofan.org>. All rights reserved.
2// Use of this source is governed by Lesser General Public License
3// that can be found in the LICENSE file.
4
5//! # Zu icon material
6//! ![Build status](https://github.com/RustVis/zu/actions/workflows/rust.yml/badge.svg)
7//! [![Latest version](https://img.shields.io/crates/v/zuicon-material.svg)](https://crates.io/crates/zuicon-material)
8//! [![Documentation](https://docs.rs/zuicon-material/badge.svg)](https://docs.rs/zuicon-material)
9//! ![Minimum rustc version](https://img.shields.io/badge/rustc-1.81+-yellow.svg)
10//! ![License](https://img.shields.io/crates/l/zuicon-material.svg)
11//!
12//! Wrapper of material design icons for yew framework.
13//!
14//! Material icons are placed in different themes:
15//! 1. baseline (default)
16//! 2. outline
17//! 3. round
18//! 4. twotone
19//! 5. sharp
20//!
21//! - [Documentation](https://docs.rs/zuicon-material)
22//! - [Online tutorial](https://zu.biofan.org/material-icons)
23//!
24//!
25//! ## How to use
26//! First add this to `Cargo.toml`:
27//! ```toml
28//! [dependencies.zuicon-material]
29//! version = "0.2"
30//! features = [
31//!   "Home",
32//!   "Email",
33//! ]
34//! ```
35//!
36//! `Home` and `Email` are available.
37//!
38//! Then import specific icons in yew components:
39//! `use zuicon_material::{email::Email, home::Home};`
40//!
41//! ## Related projects
42//! - [MUI Material Icons][icons-material]
43//!
44//! [icons-material]: https://github.com/mui/material-ui/tree/master/packages/mui-icons-material
45
46#![allow(clippy::multiple_crate_versions)]
47#![allow(unused_imports)]
48
49mod icons;
50pub use icons::*;
51
52mod custom;
53pub use custom::*;