Assets and Icons

Vektra runtime assets live under the repository root assets/ directory. vektra-assets provides a GPUI AssetSource and includes themes/default/**/* by default. With the icons feature enabled, it also includes the built-in SVG icons.

Icon performance contract

Public Icon construction and size/color resolution are O(1). Vektra neither reads files nor parses SVG itself; paths are delegated to GPUI's resource and SVG cache, so Vektra must not reparse the same path every frame. Normal scale is 100 visible icons, with stress coverage for 100K same-path construction and 10K visible icons. GPUI owns different-path cache capacity and eviction; Vektra adds no unbounded parallel cache.

[dependencies]
vektra = { path = "crates/vektra" }

If your app does not provide custom assets, mount the Vektra assets directly:

application()
    .with_assets(vektra::assets::Assets)
    .run(|cx| {
        // ...
    });

Custom Icons

You can use your app's own icon assets without enabling the icons feature. The host AssetSource only needs to serve the referenced path:

use vektra::{Button, Icon, IconButton, IconSource};

Icon::new(IconSource::asset("icons/logo.svg"));

Button::new("settings")
    .label("设置")
    .start_icon(IconSource::asset("icons/logo.svg"));

IconButton::new("settings", IconSource::asset("icons/logo.svg"))
    .aria_label("设置");

Use Assets::with_overrides when the application has its own asset source. App assets are checked first, and Vektra assets are used as fallback.

application()
    .with_assets(vektra::assets::Assets::with_overrides(AppAssets))
    .run(|cx| {
        // ...
    });

Built-in Icons

Enable the icons feature to use vektra::IconName:

[dependencies]
vektra = { path = "crates/vektra", features = ["icons"] }

use vektra::{Button, Icon, IconButton, IconName};

Icon::new(IconName::Settings);

Button::new("settings")
    .label("设置")
    .start_icon(IconName::Settings);

IconButton::new("settings", IconName::Settings)
    .aria_label("设置");

Applications can also derive IntoIconSource for their own enum. By default, PascalCase variants map to icons/<snake_case>.svg. Use #[icon(path = "...")] when a variant should point to a different file.

#[derive(Debug, Clone, Copy, vektra::IntoIconSource)]
enum AppIconName {
    Logo,
    FavoriteFilled,

    #[icon(path = "icons/heart.svg")]
    Favorite,
}

examples/custom_assets shows custom assets, default enum mapping, explicit path overrides, and fallback to IconName::Settings.