From e2dcc81958f132bb76fa3287153cf23a2c1fd023 Mon Sep 17 00:00:00 2001 From: Maccesch Date: Fri, 14 Jul 2023 16:43:42 +0100 Subject: [PATCH] moved websocket into network category and removed feature --- .idea/leptos-use.iml | 2 ++ Cargo.toml | 3 ++- docs/book/src/SUMMARY.md | 8 ++++---- docs/book/src/functions.md | 2 ++ docs/book/src/network/use_websocket.md | 3 +++ docs/book/src/websocket/use_websocket.md | 3 --- examples/use_websocket/Cargo.toml | 2 +- examples/use_websocket/src/main.rs | 5 ++++- src/lib.rs | 4 ++-- src/use_active_element.rs | 2 +- src/{websocket => }/use_websocket.rs | 0 src/watch.rs | 4 ++-- src/websocket/mod.rs | 3 --- 13 files changed, 23 insertions(+), 18 deletions(-) create mode 100644 docs/book/src/network/use_websocket.md delete mode 100644 docs/book/src/websocket/use_websocket.md rename src/{websocket => }/use_websocket.rs (100%) delete mode 100644 src/websocket/mod.rs diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml index 8904b5c..9ce1da2 100644 --- a/.idea/leptos-use.iml +++ b/.idea/leptos-use.iml @@ -45,6 +45,7 @@ + @@ -68,6 +69,7 @@ + diff --git a/Cargo.toml b/Cargo.toml index aaa5bcd..47de1d8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -26,6 +26,7 @@ lazy_static = "1" [dependencies.web-sys] version = "0.3" features = [ + "BinaryType", "CssStyleDeclaration", "CloseEvent", "CustomEvent", @@ -57,6 +58,7 @@ features = [ "TouchEvent", "TouchList", "VisibilityState", + "WebSocket", "Window", ] @@ -64,7 +66,6 @@ features = [ docs = [] math = ["num"] storage = ["serde", "serde_json", "web-sys/StorageEvent"] -websocket = ["web-sys/BinaryType", "web-sys/WebSocket"] [package.metadata.docs.rs] all-features = true diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index b24df4c..74c39d5 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -11,10 +11,6 @@ - [use_session_storage](storage/use_session_storage.md) - [use_storage](storage/use_storage.md) -# @WebSocket - -- [use_websocket](websocket/use_websocket.md) - # Elements - [use_active_element](elements/use_active_element.md) @@ -45,6 +41,10 @@ - [use_mouse](sensors/use_mouse.md) - [use_scroll](sensors/use_scroll.md) +# Network + +- [use_websocket](network/use_websocket.md) + # Animation - [use_interval](animation/use_interval.md) diff --git a/docs/book/src/functions.md b/docs/book/src/functions.md index 7d0f314..b1baf3b 100644 --- a/docs/book/src/functions.md +++ b/docs/book/src/functions.md @@ -10,6 +10,8 @@ + + diff --git a/docs/book/src/network/use_websocket.md b/docs/book/src/network/use_websocket.md new file mode 100644 index 0000000..1dac32f --- /dev/null +++ b/docs/book/src/network/use_websocket.md @@ -0,0 +1,3 @@ +# use_websocket + + diff --git a/docs/book/src/websocket/use_websocket.md b/docs/book/src/websocket/use_websocket.md deleted file mode 100644 index 389c51c..0000000 --- a/docs/book/src/websocket/use_websocket.md +++ /dev/null @@ -1,3 +0,0 @@ -# use_websocket - - diff --git a/examples/use_websocket/Cargo.toml b/examples/use_websocket/Cargo.toml index 0b2c27b..0a0a3b7 100644 --- a/examples/use_websocket/Cargo.toml +++ b/examples/use_websocket/Cargo.toml @@ -8,7 +8,7 @@ leptos = { version = "0.4", features = ["nightly", "csr"] } console_error_panic_hook = "0.1" console_log = "1" log = "0.4" -leptos-use = { path = "../..", features = ["docs", "websocket"] } +leptos-use = { path = "../..", features = ["docs"] } web-sys = "0.3" [dev-dependencies] diff --git a/examples/use_websocket/src/main.rs b/examples/use_websocket/src/main.rs index e5a6eb7..3d76f06 100644 --- a/examples/use_websocket/src/main.rs +++ b/examples/use_websocket/src/main.rs @@ -1,6 +1,9 @@ use leptos::*; use leptos_use::docs::demo_or_body; -use leptos_use::websocket::*; +use leptos_use::{ + use_websocket, use_websocket_with_options, UseWebSocketOptions, UseWebSocketReadyState, + UseWebsocketReturn, +}; use web_sys::{CloseEvent, Event}; diff --git a/src/lib.rs b/src/lib.rs index 1ef038c..b0a89db 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -9,8 +9,6 @@ pub mod math; #[cfg(feature = "storage")] pub mod storage; pub mod utils; -#[cfg(feature = "websocket")] -pub mod websocket; #[cfg(web_sys_unstable_apis)] mod use_element_size; @@ -46,6 +44,7 @@ mod use_preferred_dark; mod use_scroll; mod use_supported; mod use_throttle_fn; +mod use_websocket; mod use_window_focus; mod use_window_scroll; mod watch; @@ -78,6 +77,7 @@ pub use use_preferred_dark::*; pub use use_scroll::*; pub use use_supported::*; pub use use_throttle_fn::*; +pub use use_websocket::*; pub use use_window_focus::*; pub use use_window_scroll::*; pub use watch::*; diff --git a/src/use_active_element.rs b/src/use_active_element.rs index 496f8d4..d66d498 100644 --- a/src/use_active_element.rs +++ b/src/use_active_element.rs @@ -4,7 +4,7 @@ use leptos::html::{AnyElement, ToHtmlElement}; use leptos::*; use web_sys::AddEventListenerOptions; -/// +/// Reactive `document.activeElement` /// /// ## Demo /// diff --git a/src/websocket/use_websocket.rs b/src/use_websocket.rs similarity index 100% rename from src/websocket/use_websocket.rs rename to src/use_websocket.rs diff --git a/src/watch.rs b/src/watch.rs index 85166a7..680470c 100644 --- a/src/watch.rs +++ b/src/watch.rs @@ -1,5 +1,5 @@ -use crate::utils::{create_filter_wrapper, FilterOptions}; -use crate::{filter_builder_methods, DebounceOptions, ThrottleOptions}; +use crate::filter_builder_methods; +use crate::utils::{create_filter_wrapper, DebounceOptions, FilterOptions, ThrottleOptions}; use default_struct_builder::DefaultBuilder; use leptos::*; use std::cell::RefCell; diff --git a/src/websocket/mod.rs b/src/websocket/mod.rs deleted file mode 100644 index ef6e33b..0000000 --- a/src/websocket/mod.rs +++ /dev/null @@ -1,3 +0,0 @@ -mod use_websocket; - -pub use use_websocket::*;