gpui-kit-assets 0.6.1

Default bundled assets for GPUI Kit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! Bundled Lucide icons shared by GPUI Kit presentation and behavior layers.
//!
//! [`IconName`] and [`IconNamed`] do not depend on GPUI Component. Register
//! [`Assets`] for the default component bundle, or [`AllAssets`] for the full
//! catalog. Applications can provide their own source for additional icons.

mod icon;
pub use icon::{IconName, IconNamed};

/// Embed application assets for GPUI Component.
///
/// This assets provides icons svg files for [IconName].
///
/// ## Usage
///
/// ```rust,no_run
/// use gpui::*;
/// use gpui_kit_assets::Assets;
///
/// let app = gpui_platform::application().with_assets(Assets);
/// ```
///
/// ## Platform Differences
///
/// - **Native (Desktop)**: Icons are embedded in the binary using RustEmbed
/// - **WASM (Web)**: Icons are downloaded from CDN using web_sys::Request
///   - This significantly reduces WASM bundle size
///   - Icons are downloaded on-demand when first used
///   - Downloaded icons are cached in memory
#[cfg(not(target_family = "wasm"))]
mod native_assets;

#[cfg(target_family = "wasm")]
mod wasm_assets;

#[cfg(not(target_family = "wasm"))]
pub use native_assets::{AllAssets, Assets};

#[cfg(target_family = "wasm")]
pub use wasm_assets::Assets;

/// On WASM, the complete catalog uses the same on-demand CDN source.
#[cfg(target_family = "wasm")]
pub use wasm_assets::Assets as AllAssets;

// Public only so exported macros can resolve dependencies in downstream crates,
// including applications that depend solely on the gpui-kit umbrella crate.
#[doc(hidden)]
pub mod __private {
    pub use crate::icon::embedded::*;
    pub use gpui::{AssetSource, Result, SharedString};
}

/// Embed only the selected icons in a native or WebAssembly application.
///
/// ```ignore
/// use gpui_kit::assets::{icon_assets, IconName};
/// icon_assets!(AppAssets, [Search, Check]);
/// // gpui_kit::application().with_assets(AppAssets)
/// ```
///
/// Unlisted paths return `Ok(None)`. The selected SVG bytes are borrowed from
/// static storage; loading them does not copy them or build a runtime cache.
/// This source contains only the selected icons. Applications using components
/// can compose it with `Assets` to retain their default icons.
#[macro_export]
macro_rules! icon_assets {
    ($vis:vis $name:ident, [$($icon:ident),* $(,)?]) => {
        #[derive(Clone, Copy, Debug, Default)]
        $vis struct $name;

        impl $crate::__private::AssetSource for $name {
            fn load(&self, path: &str) -> $crate::__private::Result<Option<::std::borrow::Cow<'static, [u8]>>> {
                $(if path == $crate::__private::$icon.0 {
                    return Ok(Some(::std::borrow::Cow::Borrowed($crate::__private::$icon.1)));
                })*
                let _ = path;
                Ok(None)
            }

            fn list(&self, path: &str) -> $crate::__private::Result<::std::vec::Vec<$crate::__private::SharedString>> {
                let paths: &[&str] = &[$($crate::__private::$icon.0),*];
                Ok(paths.iter().copied().filter(|name| name.starts_with(path)).map(Into::into).collect())
            }
        }
    };
}