Icons

[dependencies]
zaxis = { version = "=0.0.3", features = ["bundled-icons"] }

use zaxis::{icons, vec2, Image};

ui.image(&icons::USER);
ui.add(Image::new(&icons::SETTINGS).size(vec2(20.0, 20.0)).tint(Color::gray(200)));
if ui.add(Image::new(&icons::TRASH).size(vec2(16.0, 16.0)).interactive(true)).clicked() {
    // ...
}

The opt-in bundled-icons feature re-exports the separate z-icons crate as zaxis::icons. It contains the complete Lucide set (1866 icons) as static SVG data. Icons are ordinary images: the &'static Icon converts into an ImageSource, so every Image option applies.

NamesCopy Anchor Link

Each icon is a static named after its Lucide file in SCREAMING_SNAKE_CASE: user → icons::USER, arrow-left → icons::ARROW_LEFT, grid-2x2 → icons::GRID_2X2. Names starting with a digit get a leading underscore. Lucide renames icons between versions (for example trash-2 is now trash); the compiler reports a removed name. Look names up on lucide.dev/icons.

Icon::name() returns the Lucide name and Icon::svg() the UTF-8 SVG bytes. Icon::svg_str() borrows the same document as static UTF-8 text.

Using z-icons without zaxisCopy Anchor Link

z-icons is an independent no_std crate with no runtime dependencies. Applications can depend on it directly and pass SVG bytes or text to their own renderer. See its README for installation, custom icons, allocation-free output and the standalone export example.

let svg = z_icons::USER.render().color("#2563eb").size(32, 32).to_string();
// Use svg.as_bytes() with your application's SVG loader.

render() defaults to currentColor for inline SVG and can set color, intrinsic dimensions and stroke width. Use an explicit color for external images. Raw svg() retains white strokes for tinting, so the existing zaxis integration is unchanged.

For runtime discovery, enable the z-icons feature catalog: z_icons::get("user") returns an icon by its exact name and z_icons::all() lists the sorted set. Using the catalog retains all bundled SVG data; static constants need no feature.

Size and colorCopy Anchor Link

Icons are drawn on a 24 × 24 viewBox with a 2-unit stroke that scales with the size. Strokes are stored white instead of currentColor, so Image::tint sets the color and one raster serves every tint. Layout uses logical pixels; the raster resolution follows DPI as for any SVG. Without .size(...) an icon is 24 × 24.

Binary sizeCopy Anchor Link

Every icon is a separate static, so the linker drops those you do not reference. The default build has no catalog referencing all icons. Only the SVG sources you use need to be embedded; parsing and rasterization in zaxis happen at run time through the image cache.

Custom iconsCopy Anchor Link

Image::new(include_bytes!("icon.svg")) works the same way. For Lucide-style icons that use currentColor, replace it with #fff to make them tintable.

UpdatingCopy Anchor Link

python crates/z-icons/generate.py <path-to-lucide-checkout> regenerates icons/ and src/generated.rs.

LicenseCopy Anchor Link

Lucide is ISC licensed; some icons derive from Feather (MIT). Redistribution must include LICENSE-LUCIDE, which ships in the crate.

ExampleCopy Anchor Link

cargo run --example icons --features bundled-icons shows a filterable gallery with size and color controls.