pictogram 0.3.0

A compile time svg icon resolver.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# Pictogram
Pictogram resolves icons at compile time using data stored in the manifest directory. 
During compilation an icon is looked up and baked into your application.
This bypasses compilation penalties as the entire icon data does not have to be compiled by rustc.

## Features
* **Support for many libraries**: See supported libraries for more information.
* **Type-Safe**: If an icon can't be resolved, it will lead to a compilation error.
* **Compile-Time**: Icons are baked into your code at compile time.
* **Only pay for what you need**: Only compile the icons, you actually use.
* **Framework independent**: Although, there is an [adapter for dioxus](https://crates.io/crates/pictogram-dioxus). 
* **NOT** vibe coded. 

## How to use it
```toml
# By default all features are enabled
pictogram = { version = "*", features=["material"] }
```
```rust,ignore
let svg = pictogram::svg!(pictogram::material::action_123::filled);
println!("{}", svg);
```

### Dioxus adapter
The adapter is available [here](https://crates.io/crates/pictogram-dioxus).

```rust,ignore
// Define icons locally - from the index
define_icon!(pictogram::material::social_person::filled);
// Or from your local assets
define_icon!(CustomIcon, "local-path-to-custom-icon.svg");

#[component]
fn SomeComponent() -> Element {
  rsx! {
      // Or use the general component
      Icon {
          icon: pictogram::svg!(pictogram::material::image_crop_free::outlined),
          width: "3rem",
          height: "3rem",
          // Compose icons
          SocialPersonFilled {
            height: 16,
            width: 16,
            x: 4,
            y: 4
        }
      }
      CustomIcon {
        width: "3rem",
        height: "3rem"
      }
  }
}
```

## Supported libraries
Feel free to make a PR to add more libraries or ask for it in an issue.

| Library                 | Feature      | License    | Crate |
| ----------------------- | ------------ | ---------- | ----- |
| Material design icons   | material     | Apache-2.0 | [material](https://crates.io/crates/pictogram-icons-material) |
| Bootstrap               | bootstrap    | MIT        | [bootstrap](https://crates.io/crates/pictogram-icons-bootstrap) |
| Feather                 | feather      | MIT        | [feather](https://crates.io/crates/pictogram-icons-feather) |
| Font Awesome            | font-awesome | CC BY 4.0  | [font-awesome](https://crates.io/crates/pictogram-icons-font-awesome) |
| Tabler                  | tabler       | MIT        | [tabler](https://crates.io/crates/pictogram-icons-tabler) |
| Simple                  | simple       | CC0-1.0    | [simple](https://crates.io/crates/pictogram-icons-simple) |
| Heroicons               | hero         | MIT        | [hero](https://crates.io/crates/pictogram-icons-hero) |
| Ionicons                | ion          | MIT        | [ion](https://crates.io/crates/pictogram-icons-ion) |
| Lucide                  | lucid        | ISC        | [lucide](https://crates.io/crates/pictogram-icons-lucide) |
| Primer Octicons         | oct          | MIT        | [oct](https://crates.io/crates/pictogram-icons-oct) |
| Vscode Codicons         | vscode       | CC BY 4.0  | [vscode](https://crates.io/crates/pictogram-icons-vscode) |

## License
This project is licensed under either

* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
  ([LICENSE-APACHE](LICENSE-APACHE))

* [MIT License](https://opensource.org/licenses/MIT)
  ([LICENSE-MIT](LICENSE-MIT))

at your option.

### Icon Licenses
All icons are licensed under their respective licenses. 
Please contact me, if any repository would like to be removed/updated.