iced README

The project's README from github.com/iced-rs/iced. As one markdown file: README.md.

Iced

Documentation Crates.io License Downloads Test Status Zulip Chat Discord Server

A cross-platform GUI library for Rust focused on simplicity and type-safety. Inspired by Elm.

Features

Iced is currently experimental software. Take a look at the roadmap and check out the issues.

Overview

Inspired by The Elm Architecture, Iced expects you to split user interfaces into four different concepts:

We can build something to see how this works! Let's say we want a simple counter that can be incremented and decremented using two buttons.

We start by modelling the state of our application:

#[derive(Default)]
struct Counter {
    value: i32,
}

Next, we need to define the possible user interactions of our counter: the button presses. These interactions are our messages:

#[derive(Debug, Clone, Copy)]
pub enum Message {
    Increment,
    Decrement,
}

Now, let's show the actual counter by putting it all together in our view logic:

use iced::widget::{button, column, text, Column};

impl Counter {
    pub fn view(&self) -> Column<'_, Message> {
        // We use a column: a simple vertical layout
        column![
            // The increment button. We tell it to produce an
            // `Increment` message when pressed
            button("+").on_press(Message::Increment),

            // We show the value of the counter here
            text(self.value).size(50),

            // The decrement button. We tell it to produce a
            // `Decrement` message when pressed
            button("-").on_press(Message::Decrement),
        ]
    }
}

Finally, we need to be able to react to any produced messages and change our state accordingly in our update logic:

impl Counter {
    // ...

    pub fn update(&mut self, message: Message) {
        match message {
            Message::Increment => {
                self.value += 1;
            }
            Message::Decrement => {
                self.value -= 1;
            }
        }
    }
}

And that's everything! We just wrote a whole user interface. Let's run it:

fn main() -> iced::Result {
    iced::run(Counter::update, Counter::view)
}

Iced will automatically:

  1. Take the result of our view logic and layout its widgets.
  2. Process events from our system and produce messages for our update logic.
  3. Draw the resulting user interface.

Read the book, the documentation, and the examples to learn more!

Implementation details

Iced was originally born as an attempt at bringing the simplicity of Elm and The Elm Architecture into Coffee, a 2D game library I am working on.

The core of the library was implemented during May 2019 in this pull request. The first alpha version was eventually released as a renderer-agnostic GUI library. The library did not provide a renderer and implemented the current tour example on top of ggez, a game library.

Since then, the focus has shifted towards providing a batteries-included, end-user-oriented GUI library, while keeping the ecosystem modular.

Contributing / Feedback

If you want to contribute, please read our contributing guidelines for more details.

Feedback is also welcome! You can create a new topic in our Zulip forum or come chat to our Discord server.

Sponsors

The development of Iced is sponsored by the Cryptowatch team at Kraken.com

iced (iced-rs/iced)

Searching Database…

31.8K ·GitHub
Iced
What is this?Iced is a cross-platform GUI library for Rust, focused on simplicity and type-safety and inspired by the Elm architecture.
How does the Elm-inspired model work when writing an app?It is a Rust library built around The Elm Architecture: you split your app into State, Messages, view logic and update logic, and Iced handles layout, events and rendering.
How do I get started building an app with it?Add iced as a dependency of your Rust project and write the four pieces from the README counter example; the book, docs and examples folder take you further.
Is it stable enough for production use?The README states plainly that Iced is currently experimental software; it links a roadmap and the issue tracker so you can judge maturity yourself.
Where can an app built with it run?Windows, macOS, Linux and the Web. The ecosystem is modular: a renderer-agnostic native runtime, a winit windowing shell, and two built-in renderers.
What widgets do I get out of the box?Built-in widgets include text inputs, scrollables and more, with a responsive layout. You can also create your own custom widgets.
Why did the author build this?It began as an attempt to bring the simplicity of Elm and The Elm Architecture into Coffee, the author's 2D game library; the core landed in May 2019 and grew into a batteries-included GUI library.
Does it support async work like network requests?Yes — Iced offers first-class support for async actions, so you can use futures directly instead of managing threads yourself.
Is there any tooling for debugging UIs?Yes, there is debug tooling with performance metrics and time traveling, handy for inspecting how messages flow through your app.
What are similar projects?slint, nicegui, fyne, gpui-kit, Nuklear, imgui, PySimpleGUI, nuklear
Which topics is it in?interface, user-interface, gui-framework, reactive-programming, widgets, widget, toolkit, metal, ui-library, vulkan, async, graphics
Creator
iced-rs
Size
22.6 MB
Stars
31.8K
Updated
CommitOct 17Release0.14.0Dec 07
Age
7y
Commits · 90 Days