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
Что это такое?Iced — это кроссплатформенная библиотека для создания графических интерфейсов на Rust. Она делает ставку на простоту и типобезопасность и вдохновлена архитектурой Elm.
Как устроена модель, вдохновлённая Elm, при написании приложения?Это библиотека для Rust, построенная вокруг архитектуры Elm (The Elm Architecture): вы разделяете приложение на состояние (State), сообщения (Messages), логику отображения и логику обновления, а Iced берёт на себя раскладку, события и отрисовку.
С чего начать писать приложение с его помощью?Добавьте iced как зависимость в свой проект на Rust и напишите четыре части из примера со счётчиком в README; дальше вас ведут книга, документация и папка с примерами.
Насколько он стабилен — можно ли использовать в продакшене?В README прямо сказано, что Iced — пока экспериментальный проект; там же есть ссылки на дорожную карту и трекер задач, чтобы вы могли сами оценить его зрелость.
Где может работать приложение, написанное с его помощью?Windows, macOS, Linux и веб. Экосистема модульная: не привязанный к конкретному рендереру нативный рантайм, оконная оболочка на базе winit и два встроенных рендерера.
Какие виджеты доступны сразу из коробки?Встроенные виджеты включают текстовые поля ввода, прокручиваемые области и многое другое, плюс адаптивная раскладка. Можно также создавать свои собственные виджеты.
Зачем автор создал этот проект?Всё началось с попытки перенести простоту Elm и архитектуры Elm в Coffee — 2D-библиотеку автора для игр; ядро появилось в мае 2019 года и выросло в библиотеку для GUI «всё включено».
Поддерживает ли он асинхронную работу, например сетевые запросы?Да — Iced изначально хорошо поддерживает асинхронные действия, так что можно работать с futures напрямую, а не управлять потоками вручную.
Есть ли инструменты для отладки интерфейсов?Да, есть средства отладки с метриками производительности и «машиной времени» — удобно смотреть, как сообщения проходят через ваше приложение.
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