A Cargo workspace for building desktop applications with GPUI Kit (gpui-kit). It provides a modular asset-management layer, an embedded Lucide icon set, and reusable UI examples.
The example-gallery application demonstrates the workspace in action: a searchable, filterable grid of icons from every registered source with a right-side info panel for copying names, paths, SVG content, and downloading individual icons.
gpui-assets/
├── Cargo.toml # Workspace definition and shared dependencies
├── crates/
│ ├── assets/ # Universal asset-source registry (AssetsRegistry)
│ ├── macros/ # Proc-macros (icon_named!)
│ ├── lucide/ # Embedded Lucide icons + generated icon enum
│ └── mdi/ # Embedded Material Design Icons + generated icon enum
├── examples/
│ ├── example-assets/ # Minimal GPUI Kit window example
│ ├── example-gallery/ # Gallery of icons from all sources with search and source filter
│ └── example-custom-prefix/ # Custom asset sources registered under non-default prefixes
└── README.md / AGENTS.md
| Crate | Description |
|---|---|
gpui-assets |
AssetsRegistry — a registry of AssetSources with prefix routing and global fallback. |
gpui-assets-macros |
icon_named! proc-macro that generates an IconNamed enum from a directory of SVGs. |
gpui-lucide |
LucideAssets (RustEmbed-based AssetSource) and LucideIcon enum for bundled icons. |
gpui-mdi |
MdiAssets (RustEmbed-based AssetSource) and MdiIcon enum for bundled Material Design Icons. |
example-assets |
Runnable example showing AssetsRegistry + IconName::ArrowRight + LucideIcon::Table. |
example-gallery |
Gallery that renders icons from all bundled sources (Lucide, MDI, fallback) with search, source filter, theme/size controls, and a right-side info panel for copy/download actions. |
example-custom-prefix |
Runnable example that defines its own CustomLucideAssets/CustomMdiAssets sources and registers them under custom prefixes. |
Build the workspace:
cargo build --workspaceRun the examples:
cargo run -p example-assets
cargo run -p example-galleryRun tests:
cargo test --workspaceOn Windows, real-time antivirus scanners may lock freshly-built test binaries. If
cargo testfails with access-denied errors, set an alternate target directory:CARGO_TARGET_DIR=/tmp/gpui-test-target cargo test --workspace
use gpui_kit::component::Icon;
use gpui_lucide::icons::LucideIcon;
Icon::new(LucideIcon::Pin);To wire assets into a GPUI Kit application:
use gpui_assets::AssetsRegistry;
use gpui_lucide::LucideAssets;
use gpui_mdi::MdiAssets;
let assets = AssetsRegistry::new()
.use_source(LucideAssets)
.use_source(MdiAssets)
.fallback(gpui_kit::assets::Assets);
let app = gpui_kit::application().with_assets(assets);The crates in this workspace are not published to crates.io, so add them as git or path dependencies in your Cargo.toml:
[dependencies]
gpui-assets = { git = "https://github.com/filippovd/gpui-assets" }
gpui-lucide = { git = "https://github.com/filippovd/gpui-assets" }
gpui-mdi = { git = "https://github.com/filippovd/gpui-assets" }
gpui-kit = "0.7"Then wire the registry and use icons as shown above:
use gpui_assets::AssetsRegistry;
use gpui_kit::component::Icon;
use gpui_lucide::{LucideAssets, icons::LucideIcon};
use gpui_mdi::{MdiAssets, icons::MdiIcon};
fn main() {
let assets = AssetsRegistry::new()
.use_source(LucideAssets)
.use_source(MdiAssets)
.fallback(gpui_kit::assets::Assets);
let app = gpui_kit::application().with_assets(assets);
app.run(|cx| {
gpui_kit::init(cx);
// open windows, render Icon::new(LucideIcon::Pin), etc.
});
}If you want to bundle your own subset of icons or use a different prefix, follow the pattern in examples/example-custom-prefix/: define a local RustEmbed-backed source, implement PrefixedAssetSource, generate an enum with icon_named!, and register it with AssetsRegistry.
The gpui-lucide and gpui-mdi crates demonstrate the full pattern for adding a bundled asset source with a routing prefix. To create another one (for example, heroicons):
-
Add the assets — create
assets/heroicons/icons/and place the SVG files there. -
Create a crate at
crates/heroicons/and add it to[workspace.members]in the rootCargo.toml. -
Implement
AssetSourceusingRustEmbed:use std::borrow::Cow; use gpui::{AssetSource, Result, SharedString}; use rust_embed::RustEmbed; pub const HEROICONS_PREFIX: &str = "heroicons"; #[derive(RustEmbed)] #[folder = "../../assets/heroicons/icons"] #[include = "*.svg"] pub struct HeroiconsAssets; impl AssetSource for HeroiconsAssets { fn load(&self, path: &str) -> Result<Option<Cow<'static, [u8]>>> { let path = path.strip_prefix('/').unwrap_or(path); Ok(HeroiconsAssets::get(path).map(|file| file.data)) } fn list(&self, path: &str) -> Result<Vec<SharedString>> { let prefix = path.strip_prefix('/').unwrap_or(path); Ok(HeroiconsAssets::iter() .filter(|p| p.starts_with(prefix)) .map(SharedString::from) .collect()) } }
-
Generate the icon enum with
icon_named!:use gpui::{IntoElement, RenderOnce}; use gpui_assets_macros::icon_named; use gpui_component::IconNamed; icon_named!( HeroiconsIcon, "heroicons", "../../assets/heroicons/icons", [Debug, Copy, PartialEq, Eq] ); impl RenderOnce for HeroiconsIcon { fn render(self, _: &mut gpui::Window, _cx: &mut gpui::App) -> impl IntoElement { gpui_component::Icon::new(self) } }
-
Implement
PrefixedAssetSourceso the source knows its own prefix:use gpui_assets::PrefixedAssetSource; impl PrefixedAssetSource for HeroiconsAssets { fn default_prefix() -> &'static str { HEROICONS_PREFIX } }
-
Re-export the prefix,
AssetSourcestruct, andiconsmodule fromsrc/lib.rs. -
Register the source with
AssetsRegistry:use gpui_assets::AssetsRegistry; use gpui_heroicons::HeroiconsAssets; let assets = AssetsRegistry::new() .use_source(HeroiconsAssets) .fallback(gpui_kit::assets::Assets);
The generated icon enum implements IconNamed, so each variant maps to a prefixed path like heroicons:/arrow-right.svg. AssetsRegistry routes such paths to the registered source and forwards unprefixed paths to the fallback. use_source is shorthand for .use_prefix(HEROICONS_PREFIX, HeroiconsAssets).
See crates/lucide/ and crates/mdi/ for complete working examples, and AGENTS.md for the full step-by-step agent guide.
Drop new .svg files into the icons/ folder of any existing source (e.g. assets/lucide/icons/ or assets/mdi/icons/). The icon_named! macro regenerates the corresponding enum at compile time, so the new icon is immediately available as LucideIcon::{PascalCaseName} or MdiIcon::{PascalCaseName}.
All dependencies are declared in the root Cargo.toml under [workspace.dependencies] and referenced via { workspace = true } in member crates.
Key dependencies:
gpui(gpui-pre) — GPUI UI framework from crates.io (libraries).gpui-component— Styled component layer used by icon crates forIconNamed/Icon.gpui-kit— Application facade that re-exports GPUI, platform, components, and default assets.rust-embed— Compile-time asset embedding.
MIT OR Apache-2.0
