Lib.rs

🎨 acrylic

This is a work-in-progress, cross-platform, small, web-inspired user interface toolkit.

🪂 Features

• feels familiar to web developers
• support for templating
• frame + pixel perfect
• input API designed for improved accessibility
• pure and safe rust
• no_std friendly (very poor support at the moment)

🏗️ Progress (core crate)

• ☑ XML parsing
• ☑ flexbox-like layout
• ☑ textual nodes
• ☑ PNG images
• ☑ round containers
• ☑ input events
• ☑ event handlers
• ☑ text editing
• ☐ scrolling
• ☐ rich text
• ☐ external links
• ☐ video playback
• ☐ sound playback

🪀 Live Demos

• https://l0.pm/acrylic/

more coming soon!

🧱 Supported platforms

There is also acrylic-png for debugging purposes.

⚡️ Quickstart

We will first create directories for our application:

$ mkdir -p my-app/src my-app/assets
$ cd my-app

Create a basic layout for your user interface:

<!-- my-app/src/layout.xml -->

<x rem="1">
	<inflate />
	<y fixed="400" gap="10">
		<inflate />
		<png src="ferris.png" />
		<x fixed="40" gap="10">
			<inflate />
			<p txt="Rust rocks!" />
			<inflate />
		</x>
		<inflate />
	</y>
	<inflate />
</x>

See this for documentation on these tags and attributes.

Create a rust file which will start our application:

// my-app/src/app.rs

use platform::app;
use platform::log;
use platform::blit;
use acrylic::app::Application;
use acrylic::xml::ViewLoader;

app!("assets/", {
	let loader = ViewLoader::new("default.xml");
	Application::new(&log, &blit, (), loader)
});

Download a sample PNG image:

$ curl https://rustacean.net/assets/rustacean-flat-happy.png > assets/ferris.png

As our most functional platform is acrylic-web, we are going to build for it. Install the corresponding rustc target, a minimal http server and a page which will start our app.

$ rustup target add wasm32-unknown-unknown
$ cargo install httpserv
$ curl https://raw.githubusercontent.com/NathanRoyer/acrylic/main/acrylic-web/index.html > index.html
$ httpserv > /dev/null &

Create a cargo manifest for this platform:

# my-app/Cargo.toml
[package]
name = "my-app"
version = "0.1.0"
edition = "2021"

[lib]
crate-type = [ "cdylib" ]
path = "src/app.rs"

[dependencies]
acrylic = "0.1.30"
platform = { package = "acrylic-web", version = "0.1.30" }

Build:

$ cargo build -r --target wasm32-unknown-unknown

Then go to http://localhost:8080/#release. You should see something like this:

☕ Contact & Contributions

Contact

You can contact me via email or on Discord: bitsneak#1889.

You can use these for any question regarding this project.

Contributions

We gladly accept all contributions via Github PRs.

If you contribute rust code, please put all dependencies behind features; adding tens of dependencies to this crate or another one of this project might be a reason for not merging your PR.

👉 See Also

• egui
• slint

🕯️ License

• MIT for the code
• SIL Open Font License for the embedded Noto Font