Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/finnbear/yew_icons
Easily include a variety of SVGs into your yew app
https://github.com/finnbear/yew_icons
crate icon iconpack icons rust rust-crate rust-lang yew yew-components yew-framework
Last synced: 3 months ago
JSON representation
Easily include a variety of SVGs into your yew app
- Host: GitHub
- URL: https://github.com/finnbear/yew_icons
- Owner: finnbear
- License: mit
- Created: 2022-04-09T04:08:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-23T01:21:34.000Z (8 months ago)
- Last Synced: 2024-07-12T11:08:48.864Z (4 months ago)
- Topics: crate, icon, iconpack, icons, rust, rust-crate, rust-lang, yew, yew-components, yew-framework
- Language: Rust
- Homepage: https://crates.io/crates/yew_icons
- Size: 44.4 MB
- Stars: 39
- Watchers: 2
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
- awesome-yew - yew_icons - Easily include a variety of svg icons(Feather/Font Awesome/Octicons) into your Yew app. (Crates / Utils)
README
# yew_icons
[![Icons Gallery]][gallery] [![Latest Version]][crates.io]
[icons gallery]: https://img.shields.io/badge/gallery-passing-brightgreen
[gallery]: https://finnbear.github.io/yew_icons/
[latest version]: https://img.shields.io/crates/v/yew_icons.svg
[crates.io]: https://crates.io/crates/yew_icons
This crate makes it easy to use [SVG icons](https://finnbear.github.io/yew_icons/) from the following collections (more may be added in the future):
| Icon Set | License | Variants |
| -------------------- | ----------------- | -------------------------- |
| **Bootstrap** | MIT License | - |
| **Feather** | MIT License | Deprecated (use Lucide) |
| **Font Awesome** | CC BY 4.0 License | Regular, Solid |
| **Heroicons** | MIT License | Solid, Outline, Mini Solid |
| **Lipis Flag Icons** | MIT License | - |
| **Lucide** | ISC License | - |
| **Octicons** | MIT License | - |
| **Simple Icons** | CC0 License | - |
| *Extra* | Case-by-case | - |
## Gallery
[](https://finnbear.github.io/yew_icons/)
\*not all icons included in [gallery](https://finnbear.github.io/yew_icons/).
## Usage
Use the [gallery](https://finnbear.github.io/yew_icons/) to find icons you like, and add them as feature flags.
```toml
# If still using yew 0.19, use yew_icons 0.6.1
# If still using yew 0.20, use yew_icons 0.7.3
[dependencies]
yew_icons = {version = "0.8", features = ["LucideArrowLeftCircle", "LucideArrowRightCircle", "LucideArrowUpCircle"]}
```
Then, add an `` component with the corresponding icon id, optionally specifying a `width`, `height`, and/or `onclick` callback.
```rust
use yew::prelude::*;
use yew_icons::{Icon, IconId};
html!{
<>
>
}
```
Note: The icons will inherit their parent's CSS `color`.
## Feature Flags
Each icon collection must be included with the corresponding feature flag, such as `lucide` or `font_awesome_solid`.
To save binary size, individual icons can also be included by feature flag, such as `LucideZoomIn` or `FontAwesomeSolidAtom`.
By default, no collections or icons are included. Be warned that including too many icons may result in a `.wasm` binary
that some WebAssembly engines refuse to load, especially in debug mode (see ).
## License
Code is licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license
([LICENSE-MIT](LICENSE-MIT) or )
at your option.
Icons are licensed by their respective creators (see above). An license summary is emitted to the DOM for each icon:
```html
```
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
### Updating an Icon Collection
```shell
# 1. on first checkout, init submodules:
git submodule update --init --recursive
# 2. update a submodule to latest commit in remote branch:
git submodule update --remote bootstrap
# 3. generate the icons, writing the feature flags to a file:
cargo run --features="generator" > generated_feature_flags.txt
# 4. reformat the feature flags onto separate lines (choose your own adventure, e.g. vim macros)
# 5. copy the feature flags from generated_feature_flags.txt to the Cargo.toml
```
PR's ideally shouldn't include non-trivial amounts of generated file diffs. Merging and then generating is much easier to review than thousands of generated files.
### Running tests
```shell
# 1. uncomment the "testing" feature flag in Cargo.toml
# 2. for each icon set to test, run:
cargo test test --features "enum-iterator testing [icon collection to test]"
# (the test name is "test", which we specify to skip the doc tests)
# icon collection options are: bootstrap feather font_awesome_regular font_awesome_solid heroicons_mini_solid heroicons_outline heroicons_solid lipis_flag_icons_1_x_1 lipis_flag_icons_4_x_3 lucide octicons simple_icons
# if testing all icon sets at once, the prokio-runtime-worker may overflow its stack
```