47 releases

✓ Uses Rust 2018 edition

0.3.1-alpha2 Apr 22, 2020
0.3.1-alpha1 Nov 15, 2019
0.2.31 Jan 20, 2020
0.2.29 Mar 24, 2019
0.0.6 Dec 17, 2015

#6 in GUI

Download history 142/week @ 2020-02-09 150/week @ 2020-02-16 247/week @ 2020-02-23 103/week @ 2020-03-01 171/week @ 2020-03-08 110/week @ 2020-03-15 295/week @ 2020-03-22 92/week @ 2020-03-29 204/week @ 2020-04-05 306/week @ 2020-04-12 153/week @ 2020-04-19 103/week @ 2020-04-26 112/week @ 2020-05-03 157/week @ 2020-05-10 86/week @ 2020-05-17 134/week @ 2020-05-24

687 downloads per month
Used in 2 crates

MIT and MPL-2.0 licenses

280KB

OrbTk

Build and test MIT licensed crates.io docs.rs

The Orbital Widget Toolkit is a multi platform (G)UI toolkit for building scalable user interfaces with the programming language Rust. It's based on the Entity Component System Pattern and provides a functional-reactive like API.

The main goals of OrbTk are speed, ease of use, and being cross platform.

Calculator

Features:

  • Modern lightweight API
  • Cross platform
  • Modular crates
  • Based on Entity Component System library DCES
  • Flexible event system
  • Integrated widget library
  • Custom widgets
  • Theming
  • Integrated debugging tools

Platforms

  • Redox OS (native | cargo-node)
  • Linux (native | cargo-node)
  • macOS (native | cargo-node)
  • Windows (native | cargo-node)
  • openBSD (not tested, but should work)
  • Web (cargo-node)
  • Android (native planned after 0.3 | cargo-node)
  • iOS (native planned after 0.3 | cargo-node planned after 0.3)
  • Ubuntu Touch (native planned after 0.3 | cargo-node planned for 0.3)

Planned features

  • Conformable use of async
  • More default widgets
  • More examples
  • Book
  • Animations
  • Split application in modules
  • Theme update
  • 3D context
  • More integrated debugging tools

Usage

To include OrbTk in your project, just add the dependency line to your Cargo.toml file:

orbtk = "0.3.1-alpha1"

To use the latest development version of OrbTk, just add the dependency line to your Cargo.toml file:

orbtk = { git = "https://github.com/redox-os/orbtk.git", branch = "develop" }

You could also check out the OrbTk template project to start a new project: https://github.com/redox-os/orbtk-template.

Minimal Example

use orbtk::prelude::*;

fn main() {
      Application::new()
        .window(|ctx| {
            Window::create()
                .title("OrbTk - minimal example")
                .position((100.0, 100.0))
                .size(420.0, 730.0)
                .child(TextBlock::create().text("OrbTk").build(ctx))
                .build(ctx)
        })
        .run();
}

Base concepts

Widget

Widgets are the building blocks of user interfaces created with OrbTk like Buttons, TextBoxes, ListViews, Views (Screens) and Grid(Layout)s. Each widget does implement the Widget trait and is generated by the widget! macro. A widget consists of a name like Button and a list of its properties like text: String16, background: Brush or count: u32. After the build method of a widget is called, the widget exists as Entity (index) and its properties as Components in the Entity Component System. The struct of a widget serves itself as builder.

Base usage of the widget! macro:

widget!(
    MyWidget {
      background: Brush,
      count: u32,
      text: String16,
      ...
    }
);

Widget Templates

Each widget has to implement the Template trait. A template is used to define the default property values of a widget and to define its structure. A Button e.g. consists of a Container widget, a StackPanel widget and a TextBlock widget.

Base usage of the Template trait:

impl Template for MyWidget {
    fn template(self, id: Entity, ctx: &mut BuildContext) -> Self {
         self.name("MyWidget")
            .background("#000000")
            .count(0)
            .text("Initial text")
            .child(
                Container::create()
                    // Container references the same background as MyWidget
                    .background(id)
                    .child(
                        TextBlock::create()
                            // TextBlock references the same text as MyWidget
                            .text(id)
                            .build(ctx)
                    )
                    .build(ctx)
            )
    }
}

Widget State

The state of a widget is used to update its inner state. Each state has to implement the State trait. The inner state of a widget is represented by the current values of its properties.

Base usage of the state trait:

#[derive(Default, AsAny)]
struct MyWidgetState {
    ...
}

impl State for MyWidgetState {
    fn update(&mut self, _: &mut Registry, ctx: &mut Context<'_>) {
        // update the widget
        ...
    }
}

widget!(
    // Add MyState as state of MyWidget
    MyWidget<MyState> {
        ...
    }
);

The Context parameter of the update method give you access the states widget (entity) and its properties (components). It also provides functions to access the children of the widget and functions to manipulate the widget tree.

Run Examples

You can find examples in the examples/ directory.

You can start the widgets example by executing the following command:

cargo run --example widgets --release

OrbTk has also an integrated debug tools. If you want to show the bounds of all widgets (also non visual widgets) and want to see a debug print of the whole widget tree you could run the examples as follows:

cargo run --example widgets --release --features debug

Run Examples with cargo-node

To run the examples on as browser, electron or cordova app you have to install

cargo install -f cargo-node

Before you could use cargo node you have to install npm version 6.9.0. It is included in the Node.js version 10.16.3. You could download it from https://nodejs.org/dist/v10.16.3/.

Rust's cargo is presumed. All other dependencies of cargo node will be installed automatic.

Start examples

You can start the widgets example by executing the following command:

  • Run as browser app:
cargo node run --target browser --example widgets
  • Run as electron app:
cargo node run --target electron --example widgets
  • Run as cordova app on android:
cargo node run --target android --example widgets

Build and run documentation

You can build and run the latest documentation by executing the following command:

cargo doc --no-deps --open

Sub Crates

  • api: base api elements of OrbTk e.g. widget and application parts
  • css-engine: parse and read values from a css file
  • proc-macros: procedural helper macros
  • render: cross platform 2D/3D render library
  • shell: cross platform window and event handling
  • theme: OrbTks default theme (light and dark)
  • tree: tree structure based on DCES
  • utils: helper structs and traits
  • widgets: base widget library

Inspirations

Showcases

Contribution

If you want to help bring OrbTk further or you have feedback check our issues https://github.com/redox-os/orbtk/issues. You could also discuss with us about OrbTk on the Redox chat https://redox-os.org/community/ (join the OrbTk channel).

License

Licensed under MIT license (LICENSE).

Dependencies

~5.5MB
~86K SLoC