diff --git a/.gitignore b/.gitignore index f67d4f2..d7a25fc 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ dist node_modules package*.json .vscode -.DS_Store \ No newline at end of file +.DS_Store +.ffizer \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 0317b03..717b0b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### New Functions 🚀 +- `use_cookie` - `use_mouse_in_element` - `use_device_pixel_ratio` (thanks to @mondeja) - `use_element_bounding` diff --git a/Cargo.toml b/Cargo.toml index 4cf3e17..0f0359b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,18 +1,19 @@ [package] +name = "leptos-use" +version = "0.9.0" +edition = "2021" authors = ["Marc-Stefan Cassola"] categories = ["gui", "web-programming"] description = "Collection of essential Leptos utilities inspired by SolidJS USE / VueUse" -edition = "2021" exclude = ["examples/", "tests/"] homepage = "https://leptos-use.rs" keywords = ["leptos", "utilities"] license = "MIT OR Apache-2.0" -name = "leptos-use" readme = "README.md" repository = "https://github.com/Synphonyte/leptos-use" -version = "0.9.0" [dependencies] +actix-web = { version = "4", optional = true, default-features = false } base64 = { version = "0.21", optional = true } cfg-if = "1" cookie = { version = "0.18", features = ["percent-encode"] } @@ -20,9 +21,11 @@ default-struct-builder = "0.5" futures-util = "0.3" gloo-timers = { version = "0.3.0", features = ["futures"] } gloo-utils = { version = "0.2.0" } +http = { version = "0.2", optional = true } js-sys = "0.3" lazy_static = "1" leptos = "0.5" +leptos_axum = { version = "0.5", optional = true } num = { version = "0.4", optional = true } paste = "1" prost = { version = "0.12", optional = true } @@ -33,6 +36,7 @@ wasm-bindgen = "0.2.88" wasm-bindgen-futures = "0.4" [dependencies.web-sys] +version = "0.3" features = [ "AddEventListenerOptions", "BinaryType", @@ -98,17 +102,14 @@ features = [ "WebSocket", "Window", ] -version = "0.3" [features] -actix = ["actix-web/cookies"] -axum = ["axum-extra/cookie", "leptos_axum"] +axum = ["dep:leptos_axum"] docs = [] math = ["num"] prost = ["base64", "dep:prost"] serde = ["dep:serde", "serde_json"] -ssr = [] -storage = ["serde", "serde_json", "web-sys/StorageEvent"] +ssr = ["dep:http"] [package.metadata.docs.rs] all-features = true diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 87701a3..4f1091c 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -35,6 +35,7 @@ - [use_breakpoints](browser/use_breakpoints.md) - [use_color_mode](browser/use_color_mode.md) +- [use_cookie](browser/use_cookie.md) - [use_css_var](browser/use_css_var.md) - [use_display_media](browser/use_display_media.md) - [use_event_listener](browser/use_event_listener.md) diff --git a/docs/book/src/browser/use_cookie.md b/docs/book/src/browser/use_cookie.md new file mode 100644 index 0000000..b125e32 --- /dev/null +++ b/docs/book/src/browser/use_cookie.md @@ -0,0 +1,3 @@ +# use_cookie + + diff --git a/examples/Cargo.toml b/examples/Cargo.toml index bb1e8a2..e5ae6c9 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -10,6 +10,7 @@ members = [ "use_breakpoints", "use_ceil", "use_color_mode", + "use_cookie", "use_css_var", "use_cycle_list", "use_debounce_fn", diff --git a/examples/use_cookie/Cargo.toml b/examples/use_cookie/Cargo.toml new file mode 100644 index 0000000..93d1216 --- /dev/null +++ b/examples/use_cookie/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_cookie" +version = "0.1.0" +edition = "2021" + +[dependencies] +leptos = { version = "0.5", features = ["nightly", "csr"] } +console_error_panic_hook = "0.1" +console_log = "1" +log = "0.4" +leptos-use = { path = "../..", features = ["docs"] } +web-sys = "0.3" + +[dev-dependencies] +wasm-bindgen = "0.2" +wasm-bindgen-test = "0.3.0" diff --git a/examples/use_cookie/README.md b/examples/use_cookie/README.md new file mode 100644 index 0000000..aef10cd --- /dev/null +++ b/examples/use_cookie/README.md @@ -0,0 +1,23 @@ +A simple example for `use_cookie`. + +If you don't have it installed already, install [Trunk](https://trunkrs.dev/) and [Tailwind](https://tailwindcss.com/docs/installation) +as well as the nightly toolchain for Rust and the wasm32-unknown-unknown target: + +```bash +cargo install trunk +npm install -D tailwindcss @tailwindcss/forms +rustup toolchain install nightly +rustup target add wasm32-unknown-unknown +``` + +Then, open two terminals. In the first one, run: + +``` +npx tailwindcss -i ./input.css -o ./style/output.css --watch +``` + +In the second one, run: + +```bash +trunk serve --open +``` \ No newline at end of file diff --git a/examples/use_cookie/Trunk.toml b/examples/use_cookie/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_cookie/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_cookie/index.html b/examples/use_cookie/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_cookie/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_cookie/input.css b/examples/use_cookie/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_cookie/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_cookie/rust-toolchain.toml b/examples/use_cookie/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_cookie/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_cookie/src/main.rs b/examples/use_cookie/src/main.rs new file mode 100644 index 0000000..7b5acde --- /dev/null +++ b/examples/use_cookie/src/main.rs @@ -0,0 +1,29 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::use_cookie; + +#[component] +fn Demo() -> impl IntoView { + if let Some(cookie) = use_cookie("auth") { + view! { +
+ format!("'auth' cookie set to `{}`", cookie.value()) +
+ }.into_view() + } else { + view! { +
+ "No 'auth' cookie set" +
+ }.into_view() + } +} + +fn main() { + _ = console_log::init_with_level(log::Level::Debug); + console_error_panic_hook::set_once(); + + mount_to(demo_or_body(), || { + view! { } + }) +} diff --git a/examples/use_cookie/style/output.css b/examples/use_cookie/style/output.css new file mode 100644 index 0000000..ab5191f --- /dev/null +++ b/examples/use_cookie/style/output.css @@ -0,0 +1,289 @@ +[type='text'],[type='email'],[type='url'],[type='password'],[type='number'],[type='date'],[type='datetime-local'],[type='month'],[type='search'],[type='tel'],[type='time'],[type='week'],[multiple],textarea,select { + -webkit-appearance: none; + -moz-appearance: none; + appearance: none; + background-color: #fff; + border-color: #6b7280; + border-width: 1px; + border-radius: 0px; + padding-top: 0.5rem; + padding-right: 0.75rem; + padding-bottom: 0.5rem; + padding-left: 0.75rem; + font-size: 1rem; + line-height: 1.5rem; + --tw-shadow: 0 0 #0000; +} + +[type='text']:focus, [type='email']:focus, [type='url']:focus, [type='password']:focus, [type='number']:focus, [type='date']:focus, [type='datetime-local']:focus, [type='month']:focus, [type='search']:focus, [type='tel']:focus, [type='time']:focus, [type='week']:focus, [multiple]:focus, textarea:focus, select:focus { + outline: 2px solid transparent; + outline-offset: 2px; + --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/); + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: #2563eb; + --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color); + --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color); + box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow); + border-color: #2563eb; +} + +input::-moz-placeholder, textarea::-moz-placeholder { + color: #6b7280; + opacity: 1; +} + +input::placeholder,textarea::placeholder { + color: #6b7280; + opacity: 1; +} + +::-webkit-datetime-edit-fields-wrapper { + padding: 0; +} + +::-webkit-date-and-time-value { + min-height: 1.5em; +} + +::-webkit-datetime-edit,::-webkit-datetime-edit-year-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-meridiem-field { + padding-top: 0; + padding-bottom: 0; +} + +select { + background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e"); + background-position: right 0.5rem center; + background-repeat: no-repeat; + background-size: 1.5em 1.5em; + padding-right: 2.5rem; + -webkit-print-color-adjust: exact; + print-color-adjust: exact; +} + +[multiple] { + background-image: initial; + background-position: initial; + background-repeat: unset; + background-size: initial; + padding-right: 0.75rem; + -webkit-print-color-adjust: unset; + print-color-adjust: unset; +} + +[type='checkbox'],[type='radio'] { + -webkit-appearance: none; + -moz-appearance: none; + appearance: none; + padding: 0; + -webkit-print-color-adjust: exact; + print-color-adjust: exact; + display: inline-block; + vertical-align: middle; + background-origin: border-box; + -webkit-user-select: none; + -moz-user-select: none; + user-select: none; + flex-shrink: 0; + height: 1rem; + width: 1rem; + color: #2563eb; + background-color: #fff; + border-color: #6b7280; + border-width: 1px; + --tw-shadow: 0 0 #0000; +} + +[type='checkbox'] { + border-radius: 0px; +} + +[type='radio'] { + border-radius: 100%; +} + +[type='checkbox']:focus,[type='radio']:focus { + outline: 2px solid transparent; + outline-offset: 2px; + --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/); + --tw-ring-offset-width: 2px; + --tw-ring-offset-color: #fff; + --tw-ring-color: #2563eb; + --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color); + --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color); + box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow); +} + +[type='checkbox']:checked,[type='radio']:checked { + border-color: transparent; + background-color: currentColor; + background-size: 100% 100%; + background-position: center; + background-repeat: no-repeat; +} + +[type='checkbox']:checked { + background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e"); +} + +[type='radio']:checked { + background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3ccircle cx='8' cy='8' r='3'/%3e%3c/svg%3e"); +} + +[type='checkbox']:checked:hover,[type='checkbox']:checked:focus,[type='radio']:checked:hover,[type='radio']:checked:focus { + border-color: transparent; + background-color: currentColor; +} + +[type='checkbox']:indeterminate { + background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3e%3cpath stroke='white' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3e%3c/svg%3e"); + border-color: transparent; + background-color: currentColor; + background-size: 100% 100%; + background-position: center; + background-repeat: no-repeat; +} + +[type='checkbox']:indeterminate:hover,[type='checkbox']:indeterminate:focus { + border-color: transparent; + background-color: currentColor; +} + +[type='file'] { + background: unset; + border-color: inherit; + border-width: 0; + border-radius: 0; + padding: 0; + font-size: unset; + line-height: inherit; +} + +[type='file']:focus { + outline: 1px solid ButtonText; + outline: 1px auto -webkit-focus-ring-color; +} + +*, ::before, ::after { + --tw-border-spacing-x: 0; + --tw-border-spacing-y: 0; + --tw-translate-x: 0; + --tw-translate-y: 0; + --tw-rotate: 0; + --tw-skew-x: 0; + --tw-skew-y: 0; + --tw-scale-x: 1; + --tw-scale-y: 1; + --tw-pan-x: ; + --tw-pan-y: ; + --tw-pinch-zoom: ; + --tw-scroll-snap-strictness: proximity; + --tw-gradient-from-position: ; + --tw-gradient-via-position: ; + --tw-gradient-to-position: ; + --tw-ordinal: ; + --tw-slashed-zero: ; + --tw-numeric-figure: ; + --tw-numeric-spacing: ; + --tw-numeric-fraction: ; + --tw-ring-inset: ; + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: rgb(59 130 246 / 0.5); + --tw-ring-offset-shadow: 0 0 #0000; + --tw-ring-shadow: 0 0 #0000; + --tw-shadow: 0 0 #0000; + --tw-shadow-colored: 0 0 #0000; + --tw-blur: ; + --tw-brightness: ; + --tw-contrast: ; + --tw-grayscale: ; + --tw-hue-rotate: ; + --tw-invert: ; + --tw-saturate: ; + --tw-sepia: ; + --tw-drop-shadow: ; + --tw-backdrop-blur: ; + --tw-backdrop-brightness: ; + --tw-backdrop-contrast: ; + --tw-backdrop-grayscale: ; + --tw-backdrop-hue-rotate: ; + --tw-backdrop-invert: ; + --tw-backdrop-opacity: ; + --tw-backdrop-saturate: ; + --tw-backdrop-sepia: ; +} + +::backdrop { + --tw-border-spacing-x: 0; + --tw-border-spacing-y: 0; + --tw-translate-x: 0; + --tw-translate-y: 0; + --tw-rotate: 0; + --tw-skew-x: 0; + --tw-skew-y: 0; + --tw-scale-x: 1; + --tw-scale-y: 1; + --tw-pan-x: ; + --tw-pan-y: ; + --tw-pinch-zoom: ; + --tw-scroll-snap-strictness: proximity; + --tw-gradient-from-position: ; + --tw-gradient-via-position: ; + --tw-gradient-to-position: ; + --tw-ordinal: ; + --tw-slashed-zero: ; + --tw-numeric-figure: ; + --tw-numeric-spacing: ; + --tw-numeric-fraction: ; + --tw-ring-inset: ; + --tw-ring-offset-width: 0px; + --tw-ring-offset-color: #fff; + --tw-ring-color: rgb(59 130 246 / 0.5); + --tw-ring-offset-shadow: 0 0 #0000; + --tw-ring-shadow: 0 0 #0000; + --tw-shadow: 0 0 #0000; + --tw-shadow-colored: 0 0 #0000; + --tw-blur: ; + --tw-brightness: ; + --tw-contrast: ; + --tw-grayscale: ; + --tw-hue-rotate: ; + --tw-invert: ; + --tw-saturate: ; + --tw-sepia: ; + --tw-drop-shadow: ; + --tw-backdrop-blur: ; + --tw-backdrop-brightness: ; + --tw-backdrop-contrast: ; + --tw-backdrop-grayscale: ; + --tw-backdrop-hue-rotate: ; + --tw-backdrop-invert: ; + --tw-backdrop-opacity: ; + --tw-backdrop-saturate: ; + --tw-backdrop-sepia: ; +} + +.block { + display: block; +} + +.text-\[--brand-color\] { + color: var(--brand-color); +} + +.text-green-600 { + --tw-text-opacity: 1; + color: rgb(22 163 74 / var(--tw-text-opacity)); +} + +.opacity-75 { + opacity: 0.75; +} + +@media (prefers-color-scheme: dark) { + .dark\:text-green-500 { + --tw-text-opacity: 1; + color: rgb(34 197 94 / var(--tw-text-opacity)); + } +} \ No newline at end of file diff --git a/examples/use_cookie/tailwind.config.js b/examples/use_cookie/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_cookie/tailwind.config.js @@ -0,0 +1,15 @@ +/** @type {import('tailwindcss').Config} */ +module.exports = { + content: { + files: ["*.html", "./src/**/*.rs", "../../src/docs/**/*.rs"], + }, + theme: { + extend: {}, + }, + corePlugins: { + preflight: false, + }, + plugins: [ + require('@tailwindcss/forms'), + ], +} \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index 443038b..d5f73a9 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,7 +14,6 @@ mod is_none; mod is_ok; mod is_some; mod on_click_outside; -mod use_mouse_in_element; mod signal_debounced; mod signal_throttled; mod use_active_element; @@ -45,6 +44,7 @@ mod use_interval_fn; mod use_intl_number_format; mod use_media_query; mod use_mouse; +mod use_mouse_in_element; mod use_mutation_observer; mod use_preferred_contrast; mod use_preferred_dark; @@ -73,13 +73,13 @@ pub use is_none::*; pub use is_ok::*; pub use is_some::*; pub use on_click_outside::*; -pub use use_mouse_in_element::*; pub use signal_debounced::*; pub use signal_throttled::*; pub use use_active_element::*; pub use use_breakpoints::*; pub use use_color_mode::*; pub use use_cookie::*; +pub use use_cookie::*; pub use use_css_var::*; pub use use_cycle_list::*; pub use use_debounce_fn::*; @@ -104,6 +104,7 @@ pub use use_interval_fn::*; pub use use_intl_number_format::*; pub use use_media_query::*; pub use use_mouse::*; +pub use use_mouse_in_element::*; pub use use_mutation_observer::*; pub use use_preferred_contrast::*; pub use use_preferred_dark::*; diff --git a/src/use_cookie.rs b/src/use_cookie.rs index d1529e0..436205d 100644 --- a/src/use_cookie.rs +++ b/src/use_cookie.rs @@ -1,10 +1,37 @@ use cookie::Cookie; -pub struct UseCookie { - pub cookie: Option>, -} - -pub fn use_cookie(cookie_name: &str) -> UseCookie { +/// +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_cookie) +/// +/// ## Usage +/// +/// This provides you with the cookie that has been set. For more details on how to use the cookie provided, refer: https://docs.rs/cookie/0.18/cookie/struct.Cookie.html +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_cookie; +/// # +/// # #[component] +/// # fn Demo() -> impl IntoView { +/// if let Some(cookie) = use_cookie("auth") { +/// view! { +///
+/// format!("'auth' cookie set to `{}`", cookie.value()) +///
+/// }.into_view() +/// } else { +/// view! { +///
+/// "No 'auth' cookie set" +///
+/// }.into_view() +/// } +/// # } +/// ``` +pub fn use_cookie(cookie_name: &str) -> Option> { let cookies; #[cfg(feature = "ssr")] { @@ -12,7 +39,7 @@ pub fn use_cookie(cookie_name: &str) -> UseCookie { use leptos::expect_context; let headers; - #[cfg(feature = "actix")] + #[cfg(not(feature = "axum"))] { headers = expect_context::().headers().clone(); } @@ -31,17 +58,14 @@ pub fn use_cookie(cookie_name: &str) -> UseCookie { #[cfg(not(feature = "ssr"))] { use wasm_bindgen::JsCast; - - let js_value: wasm_bindgen::JsValue = leptos::window().document().unwrap().into(); + + let js_value: wasm_bindgen::JsValue = leptos::document().into(); let document: web_sys::HtmlDocument = js_value.unchecked_into(); cookies = document.cookie().unwrap_or_default(); } - let cookie = Cookie::split_parse_encoded(cookies) - .into_iter() + Cookie::split_parse_encoded(cookies) .filter_map(|cookie| cookie.ok()) .find(|cookie| cookie.name() == cookie_name) - .map(|cookie| cookie.into_owned()); - - UseCookie { cookie } + .map(|cookie| cookie.into_owned()) }