egui-phosphor

Since all Phosphor variants share the same codepoints, only one variant can be the default fallback for the Proportional font. To use multiple variants (e.g., Regular and Fill):

1. Add the primary variant using add_to_fonts (this sets it as the fallback).
2. Add additional variants using add_as_family.
3. Access additional variants using their specific rich helper or by selecting the family.

Example with subsetting:

egui_phosphor::subset! {
    pub mod icons {
        use regular::{GEAR, HOUSE};
        use fill::{GEAR, HEART};
    }
}

icons::regular::add_to_fonts(&mut fonts);
icons::fill::add_as_family(&mut fonts);

// Using the fallback variant:
ui.label(format!("{} Settings", icons::regular::GEAR));

// Using an additional variant via the rich helper:
ui.label(icons::fill::rich(format!("{} Favourite", icons::fill::HEART)));

The subset feature allows you to reduce the font size at compile time by including only the specific icons you need. This reduces the final binary size but adds approximately 0.3s to the crate rebuild time when the subset changes.

1. Enable the subset feature in Cargo.toml:

egui-phosphor = { version = "0.14", features = ["subset"] }

2. Use the subset! macro to define a module containing only your required icons:

egui_phosphor::subset! {
    pub mod icons {
        use regular::{GEAR, HOUSE, TRASH};
    }
}

3. Register the subsetted icons and use them in your UI:

// On startup:
let mut fonts = egui::FontDefinitions::default();
icons::regular::add_to_fonts(&mut fonts);
cc.egui_ctx.set_fonts(fonts);

// In your UI:
ui.label(format!("{} Settings", icons::regular::GEAR));

To ensure icons render correctly alongside text, you must update your egui::FontDefinitions on startup. Use egui_phosphor::add_to_fonts to add your chosen variant as a fallback to the primary Proportional font. This allows the icon font to take over automatically when an icon character is encountered in a text string.

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

cc.egui_ctx.set_fonts(fonts);

Add egui-phosphor to your Cargo.toml dependencies to use Phosphor icons in your egui application.

egui-phosphor = "0.14"

The egui-phosphor crate requires you to select at least one font variant as a Cargo feature. If no variant is selected, the crate will fail to compile.

Available variants (as Cargo features):

• thin
• light
• regular
• bold
• fill

If you are unsure which one to use, enable default features in your Cargo.toml to use the standard variant.

[dependencies]
egui-phosphor = { version = "0.14.0", features = ["regular"] }

Access icons via the constants provided by the crate. You must use the constants corresponding to the specific variant you have loaded (e.g., regular::ICON_NAME for Variant::Regular).

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

The Variant enum allows you to programmatically access the raw font bytes or convert them into egui::FontData for use in your egui application.

Note that the available variants in the enum are determined by the Cargo features enabled at compile time. If a feature is not enabled, its corresponding Variant variant will not be available.

use egui_phosphor::Variant;

// Get the raw bytes for the selected variant
let bytes = Variant::Regular.font_bytes();

// Convert directly to egui::FontData for integration with egui
let font_data = Variant::Regular.font_data();

Use add_to_fonts to quickly register a Phosphor icon variant into your egui::FontDefinitions. This function registers the font under the name "phosphor" and adds it to the FontFamily::Proportional list as a fallback. This allows you to mix icons directly into ordinary text labels without specifying a font family explicitly.

// Assuming you have egui::FontDefinitions initialized
// and have imported the necessary types from egui_phosphor

egui_phosphor::add_to_fonts(&mut fonts, egui_phosphor::Variant::Regular);

The add_font_bytes_to_fonts function inserts raw font bytes under a specific name and makes it a fallback for FontFamily::Proportional.

Behavior Details:

• It inserts the font at index 1 (or index 0 if the list is empty) of the Proportional family. This ensures it does not shadow the primary text font but remains available for icon resolution in standard labels.
• name must be unique; subsequent calls with the same name will overwrite previous ones.
• Because all Phosphor variants share the same codepoints, Proportional can only resolve to one variant. For multiple variants, use add_font_bytes_as_family and select them explicitly via FontFamily::Name.

egui_phosphor::add_font_bytes_to_fonts(&mut fonts, "my_custom_name", bytes);

The Variant enum provides the following methods to access font assets: