Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.37 KB

README.md

File metadata and controls

36 lines (22 loc) · 1.37 KB
Raw

egui_phosphor

Bundles Phosphor icons with boilerplate to use in your egui app.

Installation

Add the crate as a dependency in Cargo.toml:

egui-phosphor = "0.6.0"

On startup, update the fonts in your egui context:

let mut fonts = egui::FontDefinitions::default();
egui_phosphor::add_to_fonts(&mut fonts, egui_phosphor::Variant::Regular);

cc.egui_ctx.set_fonts(fonts);

The above add_to_fonts helper adds the chosen variant (Regular) as a fallback to the primary egui Proportional font so that when you use Phosphor icons mixed with plain text in labels, the icon font will take over where necessary. If you want to add multiple variants of Phosphor icons, see this example which shows all variants in use.

Usage

Use the constants provided by the crate in your text:

ui.label(egui::RichText::new(format!("FILE_CODE {}", egui_phosphor::regular::FILE_CODE)).size(32.0));

Note: Make sure to use the appropriate character codes for your chosen variant! This means for Variant::Regular you should use regular::FILE_CODE, for Variant::Fill you should use fill::FILE_CODE etc.

License

egui-phosphor is licensed under MIT OR Apache-2.0. Phosphor Icons are licensed under MIT.