Crate iced

source ·
Expand description

Iced is a cross-platform GUI library focused on simplicity and type-safety. Inspired by Elm.

Features

Check out the repository and the examples for more details!

Overview

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

  • State — the state of your application
  • Messages — user interactions or meaningful events that you care about
  • View logic — a way to display your state as widgets that may produce messages on user interaction
  • Update logic — a way to react to messages and update your state

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 {
    // The counter value
    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("A cool counter", 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.

Usage

Use run or the program builder.

Re-exports

Modules

  • advancedadvanced
    Leverage advanced concepts like custom widgets.
  • Align and position widgets.
  • Draw lines around containers.
  • Access the clipboard.
  • Run asynchronous actions.
  • Handle events of a user interface.
  • Choose your preferred executor to power your application.
  • Load and use fonts.
  • Colors that transition progressively.
  • Listen and react to keyboard events.
  • Listen and react to mouse events.
  • multi_windowmulti-window
    Leverage multi-window support in your application.
  • Display interactive elements on top of other widgets.
  • Create and run iced applications step by step.
  • Configure your application.
  • Listen to external events in your application.
  • systemsystem
    Retrieve system information.
  • Use the built-in theme and styles.
  • Listen and react to time.
  • Listen and react to touch events.
  • Use the built-in widgets or create your own.
  • Configure the window of your application in native platforms.

Macros

  • Creates a Color with shorter and cleaner syntax.

Structs

Enums

  • Alignment on the axis of a container.
  • The background of some element.
  • The strategy used to fit the contents of a widget to its bounding box.
  • An error that occurred while running an application.
  • A user interface event.
  • A fill which transitions colors progressively along a direction, either linearly, radially (TBD), or conically (TBD).
  • The strategy used to fill space in a specific dimension.
  • The strategy used to rotate the content.
  • A built-in theme.

Traits

Functions

  • Creates an iced Program given its title, update, and view logic.
  • Runs a basic iced application with default Settings given its title, update, and view logic.

Type Aliases