Add wrappers for alert, confirm, and prompt functions (#123)

* Add wrappers for alert, confirm, and prompt functions

Fixes: #122

* Update crates/dialogs/src/lib.rs

Co-authored-by: Luke Chu <[email protected]>

* Docs + README with `update-readmes.sh` script

* Fix licence

Co-authored-by: Luke Chu <[email protected]>

Author: ranile

Cargo.toml

@@ -15,6 +15,7 @@ gloo-timers = { version = "0.2.0", path = "crates/timers" }
 gloo-console-timer = { version = "0.1.0", path = "crates/console-timer" }
 gloo-events = { version = "0.1.0", path = "crates/events" }
 gloo-file = { version = "0.1.0", path = "crates/file" }
+gloo-dialogs = { version = "0.1.0", path = "crates/dialogs" }
 
 [features]
 default = []

crates/dialogs/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "gloo-dialogs"
+description = "Convenience crate for working with dialogs in browser"
+version = "0.1.0"
+authors = ["Rust and WebAssembly Working Group"]
+edition = "2018"
+license = "MIT OR Apache-2.0"
+readme = "README.md"
+repository = "https://github.com/rustwasm/gloo/tree/master/crates/dialogs"
+homepage = "https://github.com/rustwasm/gloo"
+categories = ["api-bindings", "asynchronous", "wasm"]
+
+[dependencies]
+wasm-bindgen = "0.2"
+
+[dependencies.web-sys]
+version = "0.3"
+features = [
+    "Window"
+]

crates/dialogs/README.md

@@ -0,0 +1,27 @@
+<div align="center">
+
+  <h1><code>gloo-dialogs</code></h1>
+
+  <p>
+    <a href="https://dev.azure.com/rustwasm/gloo/_build?definitionId=6"><img src="https://img.shields.io/azure-devops/build/rustwasm/gloo/6.svg?style=flat-square" alt="Build Status" /></a>
+    <a href="https://crates.io/crates/gloo-dialogs"><img src="https://img.shields.io/crates/v/gloo-dialogs.svg?style=flat-square" alt="Crates.io version" /></a>
+    <a href="https://crates.io/crates/gloo-dialogs"><img src="https://img.shields.io/crates/d/gloo-dialogs.svg?style=flat-square" alt="Download" /></a>
+    <a href="https://docs.rs/gloo-dialogs"><img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square" alt="docs.rs docs" /></a>
+  </p>
+
+  <h3>
+    <a href="https://docs.rs/gloo-dialogs">API Docs</a>
+    <span> | </span>
+    <a href="https://github.com/rustwasm/gloo/blob/master/CONTRIBUTING.md">Contributing</a>
+    <span> | </span>
+    <a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
+  </h3>
+
+  <sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
+</div>
+
+This crate provides wrapper for `alert`, `prompt` and `confirm` functions.
+`web-sys` provides a raw API which is hard to use. This crate provides an easy-to-use,
+idiomatic Rust API for these functions.
+
+See the documentation for [`alert`], [`prompt`] and [`confirm`] for more information.

crates/dialogs/src/lib.rs

@@ -0,0 +1,44 @@
+//! This crate provides wrapper for `alert`, `prompt` and `confirm` functions.
+//! `web-sys` provides a raw API which is hard to use. This crate provides an easy-to-use,
+//! idiomatic Rust API for these functions.
+//!
+//! See the documentation for [`alert`], [`prompt`] and [`confirm`] for more information.
+
+use wasm_bindgen::prelude::*;
+
+/// Calls the alert function.
+///
+/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/alert)
+pub fn alert(message: &str) {
+    window().alert_with_message(message).unwrap_throw()
+}
+
+/// Calls the confirm function.
+///
+/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm)
+pub fn confirm(message: &str) -> bool {
+    window().confirm_with_message(message).unwrap_throw()
+}
+
+/// Calls the `prompt` function.
+///
+/// A default value can be supplied which will be returned if the user doesn't input anything.
+/// This function will return `None` if the value of `default` is `None` and the user cancels
+/// the operation.
+///
+/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/prompt)
+pub fn prompt(message: &str, default: Option<&str>) -> Option<String> {
+    match default {
+        Some(default) => window()
+            .prompt_with_message_and_default(message, default)
+            .expect_throw("can't read input"),
+        None => window()
+            .prompt_with_message(message)
+            .expect_throw("can't read input"),
+    }
+}
+
+#[inline]
+fn window() -> web_sys::Window {
+    web_sys::window().expect_throw("can't access window")
+}

crates/file/README.md

@@ -20,10 +20,14 @@
   <sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
 </div>
 
+Provides wrappers for working with `Blob`s and `File`s from JavaScript.
 
-Working with files and blobs on the Web.
+A `File` is just a `Blob` with some extra data: a name and a last modified time.
 
-These APIs come in two flavors:
+In the File API, `Blob`s are opaque objects that lazily fetch their contained data when
+asked. This allows a `Blob` to represent some resource that isn't completely available, for
+example a WebSocket message that is being received or a file that needs to be read from disk.
 
-1. a callback style (that more directly mimics the JavaScript APIs), and
-2. a `Future` API.
+You can asynchronously access the contents of the `Blob` through callbacks,
+but that is rather inconvenient, so this crate provides some functions which
+return a `Future` instead.

src/lib.rs

@@ -8,3 +8,4 @@ pub use gloo_console_timer as console_timer;
 pub use gloo_events as events;
 pub use gloo_file as file;
 pub use gloo_timers as timers;
+pub use gloo_dialogs as dialogs;