Remove web_sys re-export (#2084)

mc1098 · web-flow · commit e503c9acda94 · 2021-09-27T02:07:38.000+02:00
* Remove `web_sys` re-export

Removes re-exporting the `web_sys` dependency from the yew crate and
removes some `web_sys` features that were only enabled for re-exporting.

* re-export events through yew::events
diff --git a/examples/boids/Cargo.toml b/examples/boids/Cargo.toml
@@ -13,3 +13,9 @@ rand = "0.8"
 serde = { version = "1.0", features = ["derive"] }
 yew = { path = "../../packages/yew" }
 gloo = "0.3"
+
+[dependencies.web-sys]
+version = "0.3"
+features = [
+	"HtmlInputElement",
+]
diff --git a/examples/boids/src/slider.rs b/examples/boids/src/slider.rs
@@ -1,8 +1,6 @@
 use std::cell::Cell;
-use yew::{
-    html, web_sys::HtmlInputElement, Callback, Component, Context, Html, InputEvent, Properties,
-    TargetCast,
-};
+use web_sys::HtmlInputElement;
+use yew::{events::InputEvent, html, Callback, Component, Context, Html, Properties, TargetCast};
 
 thread_local! {
     static SLIDER_ID: Cell<usize> = Cell::default();
diff --git a/examples/crm/Cargo.toml b/examples/crm/Cargo.toml
@@ -11,3 +11,9 @@ serde_derive = "1"
 yew = { path = "../../packages/yew" }
 gloo = "0.3"
 
+[dependencies.web-sys]
+version = "0.3"
+features = [
+	"HtmlInputElement",
+	"HtmlTextAreaElement",
+]
diff --git a/examples/crm/src/add_client.rs b/examples/crm/src/add_client.rs
@@ -1,6 +1,8 @@
 use crate::Client;
-use yew::web_sys::{Event, HtmlInputElement, HtmlTextAreaElement};
-use yew::{classes, html, Callback, Component, Context, Html, Properties, TargetCast};
+use web_sys::{HtmlInputElement, HtmlTextAreaElement};
+use yew::{
+    classes, events::Event, html, Callback, Component, Context, Html, Properties, TargetCast,
+};
 
 #[derive(Debug)]
 pub enum Msg {
diff --git a/examples/js_callback/Cargo.toml b/examples/js_callback/Cargo.toml
@@ -8,3 +8,9 @@ license = "MIT OR Apache-2.0"
 [dependencies]
 wasm-bindgen = "0.2"
 yew = { path = "../../packages/yew" }
+
+[dependencies.web-sys]
+version = "0.3"
+features = [
+	"HtmlTextAreaElement",
+]
diff --git a/examples/js_callback/src/main.rs b/examples/js_callback/src/main.rs
@@ -1,5 +1,6 @@
 use wasm_bindgen::prelude::*;
-use yew::{prelude::*, web_sys::HtmlTextAreaElement};
+use web_sys::HtmlTextAreaElement;
+use yew::prelude::*;
 
 mod bindings;
 
diff --git a/examples/keyed_list/Cargo.toml b/examples/keyed_list/Cargo.toml
@@ -13,3 +13,10 @@ log = "0.4"
 rand = "0.8"
 wasm-logger = "0.2"
 yew = { path = "../../packages/yew" }
+
+[dependencies.web-sys]
+version = "0.3"
+features = [
+	"HtmlElement",
+	"HtmlInputElement",
+]
diff --git a/examples/keyed_list/src/main.rs b/examples/keyed_list/src/main.rs
@@ -1,8 +1,8 @@
 use instant::Instant;
 use person::PersonType;
+use web_sys::{HtmlElement, HtmlInputElement};
 use yew::html::Scope;
 use yew::prelude::*;
-use yew::web_sys::{HtmlElement, HtmlInputElement};
 
 mod person;
 mod random;
diff --git a/examples/store/Cargo.toml b/examples/store/Cargo.toml
@@ -10,3 +10,9 @@ yew = { path = "../../packages/yew" }
 yew-agent = { path = "../../packages/yew-agent" }
 wasm-bindgen = "0.2"
 gloo-console = "0.1"
+
+[dependencies.web-sys]
+version = "0.3"
+features = [
+	"HtmlInputElement",
+]
diff --git a/examples/store/src/text_input.rs b/examples/store/src/text_input.rs
@@ -1,5 +1,5 @@
+use web_sys::HtmlInputElement;
 use yew::prelude::*;
-use yew::web_sys::HtmlInputElement;
 
 pub enum Msg {
     Submit(String),
diff --git a/examples/todomvc/Cargo.toml b/examples/todomvc/Cargo.toml
@@ -12,3 +12,9 @@ serde = "1"
 serde_derive = "1"
 yew = { path = "../../packages/yew" }
 gloo = "0.3"
+
+[dependencies.web-sys]
+version = "0.3"
+features = [
+	"HtmlInputElement",
+]
diff --git a/examples/todomvc/src/main.rs b/examples/todomvc/src/main.rs
@@ -1,10 +1,14 @@
 use gloo::storage::{LocalStorage, Storage};
 use state::{Entry, Filter, State};
 use strum::IntoEnumIterator;
-use yew::html::Scope;
-use yew::web_sys::HtmlInputElement as InputElement;
-use yew::{classes, html, Component, Context, FocusEvent, Html, NodeRef, TargetCast};
-use yew::{events::KeyboardEvent, Classes};
+use web_sys::HtmlInputElement as InputElement;
+use yew::{
+    classes,
+    events::{FocusEvent, KeyboardEvent},
+    html,
+    html::Scope,
+    Classes, Component, Context, Html, NodeRef, TargetCast,
+};
 
 mod state;
 
diff --git a/packages/website-test/Cargo.toml b/packages/website-test/Cargo.toml
@@ -17,5 +17,14 @@ weblog = "0.3.0"
 yew = { path = "../../packages/yew/" }
 yew-router = { path = "../../packages/yew-router/" }
 
+[dev-dependencies.web-sys]
+version = "0.3"
+features = [
+	"Element",
+	"EventTarget",
+	"HtmlElement",
+	"HtmlInputElement",
+]
+
 [build-dependencies]
 glob = "0.3"
diff --git a/packages/yew-macro/tests/html_macro/html-element-pass.rs b/packages/yew-macro/tests/html_macro/html-element-pass.rs
@@ -37,12 +37,13 @@ pub struct u8;
 pub struct usize;
 
 fn compile_pass() {
-    let onclick = <::yew::Callback<::yew::MouseEvent> as ::std::convert::From<_>>::from(
-        |_: ::yew::MouseEvent| (),
+    let onclick = <::yew::Callback<::yew::events::MouseEvent> as ::std::convert::From<_>>::from(
+        |_: ::yew::events::MouseEvent| (),
     );
     let parent_ref = <::yew::NodeRef as ::std::default::Default>::default();
 
-    let dyn_tag = || <::std::string::String as ::std::convert::From<&::std::primitive::str>>::from("test");
+    let dyn_tag =
+        || <::std::string::String as ::std::convert::From<&::std::primitive::str>>::from("test");
     let mut extra_tags_iter = ::std::iter::IntoIterator::into_iter(::std::vec!["a", "b"]);
 
     let cow_none: ::std::option::Option<::std::borrow::Cow<'static, ::std::primitive::str>> =
@@ -103,7 +104,7 @@ fn compile_pass() {
             <track kind={::std::option::Option::Some(::std::borrow::Cow::Borrowed("subtitles"))} src={::std::clone::Clone::clone(&cow_none)} />
             <track kind={::std::option::Option::Some(::std::borrow::Cow::Borrowed("5"))} mixed="works" />
             <input value={::std::option::Option::Some(::std::borrow::Cow::Borrowed("value"))}
-                onblur={::std::option::Option::Some(<::yew::Callback<::yew::FocusEvent> as ::std::convert::From<_>>::from(|_| ()))}
+                onblur={::std::option::Option::Some(<::yew::Callback<::yew::events::FocusEvent> as ::std::convert::From<_>>::from(|_| ()))}
             />
         </div>
     };
diff --git a/packages/yew/Cargo.toml b/packages/yew/Cargo.toml
@@ -32,22 +32,16 @@ scoped-tls-hkt = "0.1"
 version = "0.3"
 features = [
   "AnimationEvent",
-  "console",
   "Document",
   "DragEvent",
   "Element",
   "ErrorEvent",
   "Event",
   "EventInit",
   "EventTarget",
-  "File",
-  "FileList",
-  "FileReader",
   "FocusEvent",
   "HtmlElement",
-  "HtmlButtonElement",
   "HtmlInputElement",
-  "HtmlSelectElement",
   "HtmlTextAreaElement",
   "InputEvent",
   "InputEventInit",
diff --git a/packages/yew/src/functional/hooks/use_ref.rs b/packages/yew/src/functional/hooks/use_ref.rs
@@ -9,7 +9,8 @@ use std::{cell::RefCell, rc::Rc};
 ///
 /// # Example
 /// ```rust
-/// # use yew::{prelude::*, web_sys::{Event, HtmlInputElement}};
+/// # use yew::prelude::*;
+/// # use web_sys::HtmlInputElement;
 /// # use std::rc::Rc;
 /// # use std::cell::RefCell;
 /// # use std::ops::{Deref, DerefMut};
diff --git a/packages/yew/src/html/listener/mod.rs b/packages/yew/src/html/listener/mod.rs
@@ -37,7 +37,8 @@ where
     /// # Example
     ///
     /// ```
-    /// use yew::{prelude::*, web_sys::{Event, HtmlTextAreaElement}};
+    /// use yew::prelude::*;
+    /// use web_sys::HtmlTextAreaElement;
     /// # enum Msg {
     /// #   Value(String),
     /// # }
@@ -93,7 +94,8 @@ where
     /// # Example
     ///
     /// ```
-    /// use yew::{prelude::*, web_sys::{Event, HtmlInputElement}};
+    /// use yew::prelude::*;
+    /// use web_sys::HtmlInputElement;
     /// # enum Msg {
     /// #   Value(String),
     /// # }
diff --git a/packages/yew/src/lib.rs b/packages/yew/src/lib.rs
@@ -265,8 +265,6 @@ pub mod scheduler;
 pub mod utils;
 pub mod virtual_dom;
 
-pub use web_sys;
-
 /// The module that contains all events available in the framework.
 pub mod events {
     pub use crate::html::TargetCast;
diff --git a/website/docs/concepts/components.md b/website/docs/concepts/components.md
@@ -102,9 +102,9 @@ is also a parameter called `first_render` which can be used to determine whether
 being called on the first render, or instead a subsequent one.
 
 ```rust
+use web_sys::HtmlInputElement;
 use yew::{
-    Component, Context, html, Html, NodeRef, 
-    web_sys::HtmlInputElement
+    Component, Context, html, Html, NodeRef,
 };
 
 pub struct MyComponent {
diff --git a/website/docs/concepts/components/callbacks.md b/website/docs/concepts/components/callbacks.md
@@ -131,7 +131,7 @@ The function passed to `callback` must always take a parameter. For example, the
 If you need a callback that might not need to cause an update, use `batch_callback`.
 
 ```rust
-use yew::{html, Component, Context, Html, KeyboardEvent};
+use yew::{events::KeyboardEvent, html, Component, Context, Html};
 
 enum Msg {
     Submit,
diff --git a/website/docs/concepts/components/refs.md b/website/docs/concepts/components/refs.md
@@ -14,7 +14,8 @@ a canvas element after it has been rendered from `view`.
 The syntax is:
 
 ```rust
-use yew::{html, web_sys::Element, Component, Context, Html, NodeRef};
+use web_sys::Element;
+use yew::{html, Component, Context, Html, NodeRef};
 
 struct Comp {
     node_ref: NodeRef,
diff --git a/website/docs/concepts/function-components/pre-defined-hooks.md b/website/docs/concepts/function-components/pre-defined-hooks.md
@@ -48,9 +48,10 @@ If you need the component to be re-rendered on state change, consider using [`us
 ### Example
 
 ```rust
+use web_sys::HtmlInputElement;
 use yew::{
+    events::Event,
     function_component, html, use_ref, use_state,
-    web_sys::{Event, HtmlInputElement},
     Callback, TargetCast,
 };
 
diff --git a/website/docs/concepts/html/elements.md b/website/docs/concepts/html/elements.md
@@ -12,9 +12,9 @@ Using `web-sys`, you can create DOM elements and convert them into a `Node` - wh
 used as a `Html` value using `VRef`:
 
 ```rust
+use web_sys::{Element, Node};
 use yew::{
-    Component, Context, html, Html, utils::document, 
-    web_sys::{Element, Node}
+    Component, Context, html, Html, utils::document,
 };
 
 struct Comp;
diff --git a/website/docs/concepts/html/events.md b/website/docs/concepts/html/events.md
@@ -188,9 +188,10 @@ wasm-bindgen = "0.2"
 ```rust
 //highlight-next-line
 use wasm_bindgen::JsCast;
+use web_sys::{EventTarget, HtmlInputElement};
 use yew::{
+    events::Event,
     html,
-    web_sys::{Event, EventTarget, HtmlInputElement},
     Component, Context, Html,
 };
 
@@ -295,9 +296,10 @@ from events.
 but it works in a very similar way to `JsCast`.
 
 ```rust
+use web_sys::HtmlInputElement;
 use yew::{
+    events::Event,
     html,
-    web_sys::{Event, HtmlInputElement},
     // Need to import TargetCast
     //highlight-next-line
     Component, Context, Html, TargetCast,
@@ -366,8 +368,10 @@ does the cast on the target of the event. `TargetCast::target_unchecked_into` is
 [`NodeRef`](../components/refs.md) can be used instead of querying the event given to a `Callback`.
 
 ```rust
-//highlight-next-line
-use yew::{html, web_sys::HtmlInputElement, Component, Context, Html, NodeRef};
+//highlight-start
+use web_sys::HtmlInputElement;
+use yew::{html, Component, Context, Html, NodeRef};
+//highlight-end
 
 pub struct Comp {
     //highlight-next-line
@@ -425,7 +429,8 @@ You might also see by using `NodeRef` we don't have to send the `String` back in
 `Msg::InputValue` as we always have `my_input` in the component state - so we could do the following:
 
 ```rust
-use yew::{html, web_sys::HtmlInputElement, Component, Context, Html, NodeRef};
+use web_sys::HtmlInputElement;
+use yew::{html, Component, Context, Html, NodeRef};
 
 pub struct Comp {
     my_input: NodeRef,
@@ -512,9 +517,10 @@ yourself ([there is a more concise way thanks to `gloo`](#using-gloo-concise)).
 
 ```rust
 use wasm_bindgen::{prelude::Closure, JsCast};
+use web_sys::HtmlElement;
 use yew::{
+    events::Event,
     html,
-    web_sys::{Event, HtmlElement},
     Component, Context, Html, NodeRef,
 };
 
@@ -617,9 +623,10 @@ gloo-events = "0.1"
 ```
 
 ```rust
+use web_sys::HtmlElement;
 use yew::{
+    events::Event,
     html,
-    web_sys::{Event, HtmlElement},
     Component, Context, Html, NodeRef,
 };
 
