lucide-gpui

This is a simple library to use lucide-icons in your gpui projects.

Warning: This library is currently not actively maintained because gpui doesn't really support component libraries yet.

Installation

Pick one of the bot commits to use a version compatible with a certain gpui version. The following example uses the commit b4595e3 with text [ci] Sync gpui dependency to zed#d7b5c883fec670539ceb40f3baa792bc1204f676:

Add this to your Cargo.toml:

[dependencies]
gpui = { git = "https://github.com/zed-industries/zed.git", rev = "d7b5c88" } # Make sure to use the correct commit
lucide-gpui = { git = "https://github.com/everbuild-org/lucide-gpui.git", rev = "b4595e3" }

Examples

Take a look at the examples folder to see how to use this library. If you just want to run an example, you can do so by running the following command:

Note: If you clone the repository, you'll need to do so recursively to get the submodules ( i.e. git clone --recursive https://github.com/everbuild-org/lucide-gpui.git or git submodule update --init --recursive if you already cloned the repository).

cargo run --example simple # or custom_sizes or custom_colors

Usage

Start by importing the library and adding the hook to your AssetSource.

use lucide_gpui::*;
use gpui::AssetSource;

impl AssetSource for MyAssetSource {
    fn load(&self, path: &str) -> Result<Cow<'static, [u8]>> {
        if let Some(data) = lucide_gpui::asset_load_hook(&path) { return data; }

        // old code
    }

    fn list(&self, _path: &str) -> Result<Vec<SharedString>> {
        // old code
    }
}

Then, you can use the Icon struct to render the icons.

impl Render for MyComponent {
    fn render(&mut self, _cx: &mut ViewContext<Self>) -> impl IntoElement {
        div()
            .child(
                    Icon::icon_fish()
                        .color(Hsla::red())
                        .size(IconSize::Lg),
            )
    }
}

Color & Size can also be omitted, in which case the default values will be used. Or they can be custom Structs, as long as they implement the Into<Hsla> or Into<IconSize> traits.

Look at the corresponding example for more details.

A list of all icons can be found here. Just take the name, add a icon_ prefix, replace - with _ and you are good to go.

Contributing

Contributions are welcome. Just open an issue or a pull request and we can discuss it. You can also reach out to us directly via discord here.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Lucide icons are licensed under the ISC License - see the LICENSE file for details.