bevy_pages 0.2.0

A lightweight and elegant framework to upgrade your Bevy UI experience.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

# bevy_pages


**A lightweight and elegant framework to upgrade your Bevy UI experience.**

---

[![crates.io](https://img.shields.io/crates/v/bevy_pages)](https://crates.io/crates/bevy_pages)
[![docs.rs](https://docs.rs/bevy_pages/badge.svg)](https://docs.rs/bevy_pages)
[![Following released Bevy versions](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://bevy.org/learn/quick-start/plugin-development/#main-branch-tracking)

---

This is a crate extending [bevy](https://bevy.org) to add support for XML-based UI pages. Kinda like an HTML page, but
with XML

## Features


- **🪽 Lightweight:** Bevy is already huge enough. This crate focuses on extending bevy with minimum overhead and quick
  compilation, so it only has a few core dependencies and even the XML parsing is partially done manually.

- **⚡ Fast:** The only existent overhead is parsing the XML files, which is already very fast. The plugin itself only
  adds basic functionality for handling events and elements.

- **📜 Expressive:** Use the power of XML to create dynamic and interactive UIs with ease and simple syntax.

- **✒️ Fully documented:** I added my signature `#[warn(missing_docs)]` 😊

- **👁️ Built-in Auto-Completion:** Use the official [XSD Schema](schema.xsd) to enable auto-completion inside your
  favorite IDE.

- **✨ Extended Widget Catalog:** The framework has a lot of complex extra widgets like a dropdown, a scroll view or a
  text input widget.

## Getting Started


After adding `bevy_pages` to your project, you can start coding your XML pages.

An XML page roughly looks like this:

```xml
<?xml version="1.0" encoding="utf-8"?>
<Page

        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/DraftedDev/bevy_pages/master/schema.xsd">
    <!-- Your page content here -->
</Page>
```

**NOTE:** If you have issues with the remote `schema.xsd`, you are free to download it locally and link it in your XML.

You will also need to add the `PagesPlugin` to your app and use the `PageSpawner` to spawn your page:

```rust
fn spawn_my_page(assets: Res<AssetServer>, mut spawner: ResMut<PageSpawner>) {
    let page = assets.load("my_page.xml");

    spawner.spawn(page);
}
```

### Learning Resources

- [The Official Guide](guide/README.md)
- [The Quick Start Tutorial](guide/quick-start.md)
- [The Official Examples](examples)

## Bevy Support

The following table shows the supported `bevy` versions:

| bevy | bevy_pages     |
|------|----------------|
| 0.19 | 0.1.0 - latest |