https://github.com/rust-native-ui/libui-rs

Rust bindings to the minimalist, native, cross-platform UI toolkit `libui`
https://github.com/rust-native-ui/libui-rs

Last synced: about 1 month ago
JSON representation

Rust bindings to the minimalist, native, cross-platform UI toolkit `libui`

• Host: GitHub
• URL: https://github.com/rust-native-ui/libui-rs
• Owner: rust-native-ui
• License: apache-2.0
• Created: 2018-01-10T00:00:39.000Z (almost 7 years ago)
• Default Branch: trunk
• Last Pushed: 2023-02-17T13:56:46.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T19:59:03.758Z (4 months ago)
• Language: Rust
• Size: 6.83 MB
• Stars: 926
• Watchers: 18
• Forks: 76
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING/CONTRIBUTING.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

• awesome-rust - rust-native-ui/libui-rs
• awesome-rust-cn - rust-native-ui/libui-rs

README

        
# Improved User Interface

## A cross-platform UI toolkit for Rust based on libui

[![travis-ci build status](https://travis-ci.com/rust-native-ui/libui-rs.svg?branch=trunk)](https://travis-ci.com/rust-native-ui/libui-rs)

[![libui-rs appveyor build status badge](https://ci.appveyor.com/api/projects/status/github/noracodes/libui-rs)](https://ci.appveyor.com/project/rust-native-ui/libui-rs)

![actively developed badge](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)

iui: [![iui crates.io version badge](https://img.shields.io/crates/v/iui.svg)](https://crates.io/crates/iui/)

[![docs.rs for iui](https://docs.rs/iui/badge.svg)](https://docs.rs/iui)

![rustc 1.40](https://img.shields.io/badge/rustc-1.40-blue)

ui-sys: [![ui-sys crates.io version badge](https://img.shields.io/crates/v/ui-sys.svg)](https://crates.io/crates/ui-sys/)

[![docs.rs for ui-sys](https://docs.rs/ui-sys/badge.svg)](https://docs.rs/ui)

![rustc 1.40](https://img.shields.io/badge/rustc-1.40-blue)

`iui` is a **simple** (about 4 kLOC of Rust), **small** (about 800kb, including `libui`), **easy to distribute** (one shared library) GUI library, providing a **Rusty** user interface library that binds to **native APIs** via the [libui](https://github.com/andlabs/libui) and the `ui-sys` bindings crate.

`iui` wraps native retained mode GUI libraries, like Win32API on Windows, Cocoa on Mac OS X, and GTK+ on Linux and elsewhere. Thus all `iui` apps have a native look and feel and start from a highly performant base which is well integrated with the native ecosystem on each platform. Because it implements only the least common subset of these platform APIs, your apps will work on all platforms and won't have significant behavioral inconsistencies, with no additional effort on your part.

## Using

Add `iui` to your project with:

```toml

iui = "0.3"

```

Then, in your code, all you have to do is:

1. create a [`UI`](https://docs.rs/iui/*/iui/struct.UI.html#method.init) handle, initializing the UI library and guarding against memory unsafety

1. make a [window](https://docs.rs/iui/*/iui/controls/struct.Window.html), or a few, with title and platform-native decorations, into which your app will be drawn

1. add all your [controls](https://docs.rs/iui/*/iui/controls/index.html), like buttons and text inputs, laid out with both axial and grid layout options

1. implement some [callbacks](https://docs.rs/iui/*/iui/controls/struct.Button.html#method.on_clicked) for user input, taking full advantage of Rust's concurrency protections

1. call [`UI::main`](https://docs.rs/iui/*/iui/struct.UI.html#method.main), or take control over the event processing with an [`EventLoop`](https://docs.rs/iui/*/iui/struct.EventLoop.html), and voíla! A GUI!

Or, you can track the `trunk` branch, which may be broken and whose API often changes, with:

```toml

iui = { git = "https://github.com/rust-native-ui/libui-rs.git" branch="trunk" }

```

We have documentation on [docs.rs](https://docs.rs/iui) for released versions and on [github](https://rust-native-ui.github.io/libui-rs/iui/index.html) for `trunk`.

## Examples

![Three example GUI applications running on Linux](images/themed.png)

![Three example GUI applications running on Ubuntu](images/ubuntu.png)

Check out the [`examples/`](https://github.com/rust-native-ui/libui-rs/tree/0.3.0/iui/examples) directory from the latest release for these examples and more.

## Organization

This repository contains multiple Rust crates: 

* `iui` is the safe Rust wrapper, to be used by most users.

* `ui-sys` is the raw unsafe bindings to the `libui` C code. `libui` is included as a submodule.

Also be sure to look at our [changelog](CHANGELOG.md) and learn [how to contribute](CONTRIBUTING/CONTRIBUTING.md).

### Building ui-sys

`ui-sys` includes `libui` as a sub-module and allows it to be built on-the-fly with the

default features `fetch` and `build`. With `fetch` disabled, it will simply build the

existing sources without updating them, and with `build` disabled it will build nothing,

assuming either a system or local (in `./lib/`) version of `libui` is available.

Note that _most of the time_, building `libui` on the fly is what you want.

## Acknowledgments

Based on work by [@pcwalton](https://github.com/pcwalton/).