egui/egui_web/README.md

# egui_web

[![Latest version](https://img.shields.io/crates/v/egui_web.svg)](https://crates.io/crates/egui_web)
[![Documentation](https://docs.rs/egui_web/badge.svg)](https://docs.rs/egui_web)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
![Apache](https://img.shields.io/badge/license-Apache-blue.svg)

This crates allows you to compile GUI code written with [egui](https://crates.io/crates/egui) to [WASM](https://en.wikipedia.org/wiki/WebAssembly) to run on a web page.

[Run the web demo](https://www.egui.rs/#demo) to try it now.

Check out [eframe_template](https://github.com/emilk/eframe_template) for an example of how to set it up.

## Downsides with using egui on the web

`egui_web` uses WebGL (via [`glow`](https://crates.io/crates/glow)) and WASM, and almost nothing else from the web tech stack. This has some benefits, but also produces some challenges and serious downsides.

* Rendering: Getting pixel-perfect rendering right on the web is very difficult.
* Search: you cannot search an egui web page like you would a normal web page.
* Bringing up an on-screen keyboard on mobile: there is no JS function to do this, so `egui_web` fakes it by adding some invisible DOM elements. It doesn't always work.
* Mobile text editing is not as good as for a normal web app.
* Accessibility: There is an experimental screen reader for `egui_web`, but it has to be enabled explicitly. There is no JS function to ask "Does the user want a screen reader?" (and there should probably not be such a function, due to user tracking/integrity concerns).
* No integration with browser settings for colors and fonts.
* On Linux and Mac, Firefox will copy the WebGL render target from GPU, to CPU and then back again (https://bugzilla.mozilla.org/show_bug.cgi?id=1010527#c0), slowing down egui.

In many ways, `egui_web` is trying to make the browser do something it wasn't designed to do (though there are many things browser vendors could do to improve how well libraries like egui work).

The suggested use for `egui_web` are for web apps where performance and responsiveness are more important than accessibility and mobile text editing.
Improve README files for all crates 2021-07-29 20:04:20 +00:00			`# egui_web`

Update links to point to https://github.com/emilk/egui because I renamed the github repository from "emigui" to "egui" 2020-08-10 17:38:46 +00:00			`[![Latest version](https://img.shields.io/crates/v/egui_web.svg)](https://crates.io/crates/egui_web)`
			`[![Documentation](https://docs.rs/egui_web/badge.svg)](https://docs.rs/egui_web)`
Improve README files for all crates 2021-07-29 20:04:20 +00:00			`[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)`
Update links to point to https://github.com/emilk/egui because I renamed the github repository from "emigui" to "egui" 2020-08-10 17:38:46 +00:00			`![MIT](https://img.shields.io/badge/license-MIT-blue.svg)`
			`![Apache](https://img.shields.io/badge/license-Apache-blue.svg)`

Rename Egui to egui Also update iamges in README.md 2021-01-17 13:48:59 +00:00			`This crates allows you to compile GUI code written with [egui](https://crates.io/crates/egui) to [WASM](https://en.wikipedia.org/wiki/WebAssembly) to run on a web page.`
[doc] improve docstrings in Egui 2020-08-09 15:24:32 +00:00
emilk.github.io -> www.egui.rs 2022-01-30 21:01:33 +00:00			`[Run the web demo](https://www.egui.rs/#demo) to try it now.`
Expand egui_web/README.md with list of shortcomings 2021-08-16 19:17:15 +00:00
rename egui_template to eframe_template 2021-10-18 18:19:43 +00:00			`Check out [eframe_template](https://github.com/emilk/eframe_template) for an example of how to set it up.`
Expand egui_web/README.md with list of shortcomings 2021-08-16 19:17:15 +00:00
			`## Downsides with using egui on the web`

Typo fixes in egui_web README (#1433) 2022-03-30 08:19:42 +00:00			`egui_web` uses WebGL (via [`glow`](https://crates.io/crates/glow)) and WASM, and almost nothing else from the web tech stack. This has some benefits, but also produces some challenges and serious downsides.
Expand egui_web/README.md with list of shortcomings 2021-08-16 19:17:15 +00:00
Improve docs 2021-10-23 03:58:10 +00:00			`* Rendering: Getting pixel-perfect rendering right on the web is very difficult.`
			`* Search: you cannot search an egui web page like you would a normal web page.`
Expand egui_web/README.md with list of shortcomings 2021-08-16 19:17:15 +00:00			* Bringing up an on-screen keyboard on mobile: there is no JS function to do this, so `egui_web` fakes it by adding some invisible DOM elements. It doesn't always work.
			`* Mobile text editing is not as good as for a normal web app.`
Typo fixes in egui_web README (#1433) 2022-03-30 08:19:42 +00:00			* Accessibility: There is an experimental screen reader for `egui_web`, but it has to be enabled explicitly. There is no JS function to ask "Does the user want a screen reader?" (and there should probably not be such a function, due to user tracking/integrity concerns).
Expand egui_web/README.md with list of shortcomings 2021-08-16 19:17:15 +00:00			`* No integration with browser settings for colors and fonts.`
			`* On Linux and Mac, Firefox will copy the WebGL render target from GPU, to CPU and then back again (https://bugzilla.mozilla.org/show_bug.cgi?id=1010527#c0), slowing down egui.`

			In many ways, `egui_web` is trying to make the browser do something it wasn't designed to do (though there are many things browser vendors could do to improve how well libraries like egui work).
Misc code cleanup, docs fixes, etc 2022-02-19 19:51:51 +00:00
Typo fixes in egui_web README (#1433) 2022-03-30 08:19:42 +00:00			The suggested use for `egui_web` are for web apps where performance and responsiveness are more important than accessibility and mobile text editing.