https://github.com/poignardazur/panoramix
A prototype implementation of reactive UI in rust
https://github.com/poignardazur/panoramix
Last synced: about 1 year ago
JSON representation
A prototype implementation of reactive UI in rust
- Host: GitHub
- URL: https://github.com/poignardazur/panoramix
- Owner: PoignardAzur
- License: mit
- Created: 2020-12-31T12:50:39.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-12-09T15:51:07.000Z (over 3 years ago)
- Last Synced: 2024-10-14T06:23:15.270Z (over 1 year ago)
- Language: Rust
- Size: 607 KB
- Stars: 82
- Watchers: 8
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Panoramix
[](https://crates.io/crates/panoramix)
[](https://docs.rs/panoramix/)
[](https://github.com/linebender/druid/blob/master/LICENSE)
[](https://xi.zulipchat.com)
**Note:** The development of Panoramix is currently (as of December 2022) on hold as I work on [masonry](https://github.com/PoignardAzur/masonry-rs). I do intend to resume eventually.
**Panoramix is an experimental GUI framework for the Rust programming language.**
The framework is **data-driven and declarative**, drawing some inspiration from [React](https://github.com/facebook/react), and implemented on top of the [Druid](https://github.com/linebender/druid) toolkit (hence the name).
It aims to use **simple, idiomatic Rust**: Panoramix doesn't use unsafe code, cells, mutexes, or DSL macros.
## Getting started
Here is our "hello world" example:
```rust
use panoramix::elements::{Button, Label};
use panoramix::{component, Column, CompCtx, Element, NoEvent, RootHandler};
#[component]
fn HelloBox(ctx: &CompCtx, _props: ()) -> impl Element {
let md = ctx.use_metadata::();
Column!(
Label::new("Hello world!"),
Button::new("Say hello").on_click(md, |_, _| {
println!("Hello world");
})
)
}
fn main() -> Result<(), panoramix::PlatformError> {
RootHandler::new(HelloBox).with_tracing(true).launch()
}
```
See [the documentation](https://docs.rs/panoramix/) for details, and the [Writing a new component](misc_docs/writing_a_component.md) tutorial.
## Contributing
Issues and PRs are welcome.
PRs that add "basic block" widgets in particular will be appreciated.
See [CONTRIBUTING.md](CONTRIBUTING.md) for the rules to follow when making a PR. Issues don't have a mandatory format, but if you submit one, please follow common-sense rules: be polite, be professional, have a plan to kill everyone you meet, and if you have a problem, please include detailed steps to reproduce.
See [ARCHITECTURE.md](ARCHITECTURE.md) for a high-level presentation of the project code.
To ask questions and discuss development work, go to [Druid's Zulip chat](https://xi.zulipchat.com/), in the `#panoramix` channel.
## Usage
In your `Cargo.toml`, add the following:
```toml
panoramix = "0.1.0"
```
If you want the bleeding-edge version, add the following instead:
```toml
panoramix = { git = "https://github.com/PoignardAzur/panoramix.git" }
```
**Note for Linux users:** Panoramix is built on top of Druid, using the GTK backend, which requires a dev version of GTK3. See [GTK installation page](https://www.gtk.org/docs/installations/linux/#installing-gtk-from-packages) for install info.
Eg on Ubuntu-based distributions, you should run `sudo apt install libgtk-3-dev`.
## Roadmap
The short term roadmap is:
- Streamline styling options, especially for common low-effort use cases.
- Implement two-way bindings.
- Refactor event handling.
- Finish doc.
- Improve performance.
- Write benchmarks.
On the longer timescale, there are two broad goals:
- Achieve feature parity with React.
- Use Panoramix to build a debugging framework, similar to chrome-devtools. TODO - Write blog posts about this.
See [ROADMAP.md](ROADMAP.md) for details.
## Authors
This crate has been almost entirely written by Olivier FAURE. Any other contributor will be added to [AUTHORS.md](AUTHORS.md).
This project has been possible thanks to the extremely clean and approchable work of Raph Levien and Colin Rofls, as well as some mentoring on their part, and general interaction with the Druid community. In particular, Panoramix is inspired from [Crochet](https://github.com/raphlinus/crochet/).