https://github.com/d-e-s-o/gui

A generic UI library/framework.
https://github.com/d-e-s-o/gui

gui rust rust-crate rust-library

Last synced: 18 days ago
JSON representation

A generic UI library/framework.

• Host: GitHub
• URL: https://github.com/d-e-s-o/gui
• Owner: d-e-s-o
• License: gpl-3.0
• Created: 2018-06-06T05:59:24.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T08:21:33.000Z (5 months ago)
• Last Synced: 2024-12-09T14:00:10.150Z (28 days ago)
• Topics: gui, rust, rust-crate, rust-library
• Language: Rust
• Homepage:
• Size: 503 KB
• Stars: 18
• Watchers: 6
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![pipeline](https://github.com/d-e-s-o/gui/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/d-e-s-o/gui/actions/workflows/test.yml)

[![coverage](https://codecov.io/gh/d-e-s-o/gui/branch/main/graph/badge.svg)](https://codecov.io/gh/d-e-s-o/gui)

[![crates.io](https://img.shields.io/crates/v/gui.svg)](https://crates.io/crates/gui)

[![Docs](https://docs.rs/gui/badge.svg)](https://docs.rs/gui)

[![rustc](https://img.shields.io/badge/rustc-1.58+-blue.svg)](https://blog.rust-lang.org/2022/01/13/Rust-1.58.0.html)

gui

===

- [Documentation][docs-rs]

- [Changelog](CHANGELOG.md)

**gui** (short for **g**eneric **u**ser **i**nterface) is a crate

providing basic user interface functionality. It strives to be

as independent as possible of the underlying system architecture. That

is, it is compatible with windowing as well as terminal based systems

and it does not rely on the specifics of any GUI toolkit.

Part of this story means that it is not an out-of-the-box replacement

for your favorite user interface toolkit (think: [GTK+][gtk], [Qt][qt],

[wxWidgets][wxwidgets] to name popular ones), but that it should be seen

more as a building block, providing certain hooks and basic

functionality typically seen in a UI. The infrastructure for dispatching

events to widgets is an example. To make proper use of it, the

functionality provided by this crate needs to be glued with the

underlying system.

**gui** is used for exploring parts of the design space for user

interface architecture using [Rust][rust-lang]. Design of UI systems in

Rust is generally considered hard and to a large degree an unsolved

problem, although there are various promising designs out there.

The crate uses Rust's `async`/`await` for ergonomic event handling and

message passing between widgets and to the best of the author's knowledge,

is the first doing so.

Features

--------

- completely independent of underlying architecture

  - generic over events and messages used

  - compatible with any rendering library

- `async`/`await` based event handling and message passing support

- no dependencies other than [`async-trait`][async-trait] to work around

  current short comings in Rust

Status

------

The crate is under active development, and while its core has been

reasonably stable for a while, changes should be anticipated in the

future.

Given this current state, changes in API design are to be expected.

Example Usage

-------------

The [`notnow`][notnow] program is relying on the **gui** crate for the

creation of its terminal based UI. The basic workings can be seen there.

[async-trait]: https://crates.io/crates/async-trait

[docs-rs]: https://docs.rs/crate/gui

[gtk]: https://www.gtk.org

[qt]: https://www.qt.io

[wxwidgets]: https://wxwidgets.org

[rust-lang]: https://www.rust-lang.org

[notnow]: https://crates.io/crates/notnow