Relm4 icons - Icons for your gtk-rs and Relm4 applications!

More than 3000 icons, ready for use in your app!

Installing librsvg

The relm4-icons crate relies on librsvg for rendering SVG icons. Ensure that librsvg is installed on your system before using this crate. The installation process varies depending on your operating system.

# Linux (Debian/Ubuntu)
sudo apt update
sudo apt install librsvg2-dev

# Macos
brew install librsvg

# Windows
gvsbuild build librsvg

Usage

1. Find your icons 🔍

You can either use the of the over 3000 shipped icons or your own icons. You can browse the shipped icons using one of the following methods:

For icons from the GNOME icon-development-kit:

Install Icon library
Browse the GNOME icon resource

For icons from Fluent UI System Icons:

Browse the fluent icon library catalog

For browsing all shipped icons:

Use the icon previews provided by in this repo: 16x16, 32x32 and 64x64

Sometimes, icons-development-kit and Fluent UI System Icons have overlapping icon names, so the postfix "-alt" is added.

2. Add Relm4 icons ✍

relm4-icons = "0.10"

[build-dependencies]
relm4-icons-build = "0.10"

3. Add the icons to your project 📦

Add the following to your build.rs:

fn main() {
    relm4_icons_build::bundle_icons(
        // Name of the file that will be generated at `OUT_DIR`
        "icon_names.rs",
        // Optional app ID
        Some("com.example.myapp"),
        // Custom base resource path:
        // * defaults to `/com/example/myapp` in this case if not specified explicitly
        // * or `/org/relm4` if app ID was not specified either
        None::<&str>,
        // Directory with custom icons (if any)
        None::<&str>,
        // List of icons to include
        [
            "ssd",
            "size-horizontally",
            "cross-small",
        ],
    );
}

4. Load the icons 🛫

Add this to your initialization code:

mod icon_names {
    pub use shipped::*; // Include all shipped icons by default
    include!(concat!(env!("OUT_DIR"), "/icon_names.rs"));
}

fn main() {
    ///...///
    relm4_icons::initialize_icons(icon_names::GRESOURCE_BYTES, icon_names::RESOURCE_PREFIX);
}

5. Use the icons 🎉

Use set_icon_name and similar methods to use your icons, for example with ButtonExt, StackPage, MenuButton or Image.

Example

let button = gtk::Button::default();
button.set_icon_name("plus");

You can also use the icon_names module for extra compile-time generated icon names.

use crate::icon_names;

let button = gtk::Button::default();
button.set_icon_name(icon_names::PLUS);

How it works

Crate

Collect all icons specified in the config file
Build a gresource bundle containing only the selected icons
Include the gresource file in the compiled binary
On initialization load the gresource file

Add new icons

To add new icons, move them into the icons folder and make sure their file name ends with -symbolic.svg. Then run the following commands:

cd update_icons
cargo run

Existing icon sets can be updated as submodules with following commands:

git submodule update --remote --checkout
rm -rf build_icons/icons/fluentui-system-icons
rm -rf build_icons/icons/icon-development-kit
cd update_icons
cargo run --bin fetch_icons
cargo run

Credit

GNOME contributors for providing so many outstanding icons
gvdb-rs for providing a great crate for interacting with gresources in pure Rust
gtk-rs for outstanding Rust bindings for GTK4

Legal

The source code of Relm4 icons is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

Icons

The icons in the icons/icon-development-kit folder are licensed under the terms of the CC0 license and therefore public domain.
The icons in the icons/fluentui-system-icons folder are licensed under the terms of the MIT license.

Both licenses should work for both open source and proprietary applications (without warranty).

relm4-icons 0.10.0