me/iced
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Make example work on web and update READMEs

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2019-09-21 13:38:14 +02:00
parent eda1048dbc
commit 86dede4c4c
13 changed files with 101 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

51
examples/README.md
View file

@ -11,31 +11,60 @@ you want to learn about a specific release, check out [the release list].
A simple UI tour showcasing different widgets that can be built using Iced. It
also shows how the library can be integrated into an existing system.
The example is built on top of [`ggez`], a game library for Rust. Currently, it
is using a [personal fork] to [add a `FontCache` type] and
[fix some issues with HiDPI].
The example can run both on native and web platforms, using the same GUI code!
The native renderer of the example is built on top of [`ggez`], a game library
for Rust. Currently, it is using a [personal fork] to [add a `FontCache` type]
and [fix some issues with HiDPI].
The web version uses `iced_web` directly. This crate is still a work in
progress. In particular, the styling of elements is not finished yet
(text color, alignment, sizing, etc).
The implementation consists of different modules:
- __[`tour`]__ contains the actual GUI code: __state__, __messages__,
__update logic__ and __view logic__.
- __[`renderer`]__ implements a simple renderer for each of the used widgets on
top of the graphics module of [`ggez`].
- __[`widget`]__ re-exposes Iced's built-in widgets with the renderer type parameter
replaced with the implemented [`renderer`], for convenience.
- __[`tour`]__ contains the actual cross-platform GUI code: __state__,
__messages__, __update logic__ and __view logic__.
- __[`iced_ggez`]__ implements a simple renderer for each of the used widgets
on top of the graphics module of [`ggez`].
- __[`widget`]__ conditionally re-exposes the correct platform widgets based
on the target architecture.
- __[`main`]__ integrates Iced with [`ggez`] and connects the [`tour`] with
the [`renderer`].
- __[`lib`]__ exposes the [`tour`] types and conditionally implements the
WebAssembly entrypoint in the [`web`] module.
The conditional compilation awkwardness from targetting both native and web
platforms should be handled seamlessly by the `iced` crate in the near future!
If you want to run it as a native app:
```
cargo run --package iced_ggez_tour
cd examples/tour
cargo run
```
If you want to run it on web, you will need [`wasm-pack`]:
```
cd examples/tour
wasm-pack build --target web
```
Then, simply serve the directory with any HTTP server. For instance:
```
python3 -m http.server
```
[![Tour - Iced][gui_gif]][gui_gfycat]
[`ggez`]: https://github.com/ggez/ggez
[`tour`]: tour/src/tour.rs
[`renderer`]: tour/src/renderer
[`iced_ggez`]: tour/src/iced_ggez
[`widget`]: tour/src/widget.rs
[`main`]: tour/src/main.rs
[`lib`]: tour/src/lib.rs
[`web`]: tour/src/web.rs
[personal fork]: https://github.com/hecrj/ggez
[add a `FontCache` type]: https://github.com/ggez/ggez/pull/679
[fix some issues with HiDPI]: https://github.com/hecrj/ggez/commit/dfe2fd2423c51a6daf42c75f66dfaeaacd439fb1