Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toastxc/material-egui
Generates a theme for Egui based on M3 color palettes.
https://github.com/toastxc/material-egui
egui material-design material3 rust rust-lang
Last synced: 2 months ago
JSON representation
Generates a theme for Egui based on M3 color palettes.
- Host: GitHub
- URL: https://github.com/toastxc/material-egui
- Owner: toastxc
- Created: 2024-03-23T11:46:32.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-08T12:39:46.000Z (9 months ago)
- Last Synced: 2024-08-02T12:22:58.013Z (5 months ago)
- Topics: egui, material-design, material3, rust, rust-lang
- Language: Rust
- Homepage:
- Size: 85.9 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-egui - material-egui
README
M3-EGUI
[](https://github.com/toastxc/material-egui/stargazers)
[](https://github.com/toastxc/material-egui/network/members)
[](https://github.com/toastxc/material-egui/pulls)
[](https://github.com/toastxc/material-egui/issues)
[](https://github.com/toastxc/material-egui/graphs/contributors)
[](https://github.com/toastxc/material-egui/blob/main/LICENCE)
## About
M3-EGUI (material-egui) is a library that takes an input color and generates a color palette using M3 colors. It then applies those colors to the Egui components.
## Installation
```rust
cargo install material-egui
```
## Adding to projects
### Cargo.toml
```toml
material-egui = "*"
```
### main.rs
This can be done anywhere that CTX is available.
The same can be done with Ui but this is not recommended
```rust
// input color, is_dark_theme, zoom scale
MaterialColors::new(String::from("F0F"), true, 1.5).apply(&ctx);
// if you'd like the ability to scale windows AND a better default scale, use this
MaterialColors::new(String::from("F0F"), true, 1.5).apply(&ctx, &mut self.zoom);
```
## FAQ
### What features does this have currently?
- [x] material color design
- [x] dark and light theme support
- [x] hot reloading
- [x] Egui default components
- [ ] wallpaper color picking
- [ ] M3 animations
- [ ] M3 styled components
### Will this work on my project?
Yes it will, as long as you have the following minimum versions
```toml
egui = "0.26.2"
eframe = "0.26.2"
```
### Why does (insert element here) look weird / unreadable text?
I have not tested every element combination and there is probably a few edge cases, make sure to create an issue for them to be resolved
### How do I create use the error style?
You will need a scope and the error style changer, this is a temporary solution until I find a better one
```rust
// this scope applies error colors to all elements inside
ui.scope(|ui| {
MaterialColors::new(String::from("F0F"), true, 1.5).error_apply(ui);
ui.button("Error button!")
});
// alternatively, if you already have your colors defined
ui.scope(|ui| {
self.colors.error_apply(ui);
ui.button("Error button!")
});
```
## Thanks
Special thanks to the Egui team, and the people who made `material-colors` who made this project possible.