![]() See [#xilem > Environment System](https://xi.zulipchat.com/#narrow/channel/354396-xilem/topic/Environment.20System/with/529496085) and [#xilem > Giving `message` access to the Element](https://xi.zulipchat.com/#narrow/channel/354396-xilem/topic/Giving.20.60message.60.20access.20to.20the.20Element/with/529436165) for motivation. This is a massive refactor, to significant improve the capabilities of Xilem. The main difficulty so far has been sequences, as we need to skip the right amount of items. This will either require storing large amounts of item, or restoring the `count` method on sequences. Obviously Xilem and Xilem Web are not yet done in this PR. --------- Co-authored-by: Philipp Mildenberger <philipp@mildenberger.me> |
||
---|---|---|
.. | ||
examples | ||
src | ||
tests | ||
.gitignore | ||
Cargo.toml | ||
LICENSE | ||
README.md |
README.md
Xilem Core
Xilem Core provides primitives which are used by Xilem (a cross-platform GUI toolkit) and Xilem Web (a web frontend framework). If you are using Xilem, its documentation will probably be more helpful for you.
Xilem apps will interact with some of the functions from this crate, in particular memoize
.
Xilem apps which use custom widgets (and therefore must implement custom views), will implement the View
trait.
If you wish to implement the Xilem pattern in a different domain (such as for a terminal user interface), this crate can be used to do so. Though, while Xilem Core should be able to support all kinds of domains, the crate prioritizes the ergonomics for users of Xilem.
Hot reloading
Xilem Core does not currently include infrastructure to enable hot reloading, but this is planned. The current proposal would split the application into two processes:
- The app process, which contains the app state and create the views, which would be extremely lightweight and can be recompiled and restarted quickly.
- The display process, which contains the widgets and would be long-lived, updating to match the new state of the view tree provided by the app process.
Quickstart
no_std
support
Xilem Core supports running with #![no_std]
, but does require alloc
to be available.
Minimum supported Rust Version (MSRV)
This version of Xilem Core has been verified to compile with Rust 1.88 and later.
Future versions of Xilem Core might increase the Rust version requirement. It will not be treated as a breaking change and as such can even happen with small patch releases.
Community
Discussion of Xilem Core development happens in the Linebender Zulip, specifically the #xilem channel. All public content can be read without logging in.
Contributions are welcome by pull request. The Rust code of conduct applies.
License
Licensed under the Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0)