mirror of
https://github.com/adoyle0/leptos-use.git
synced 2025-01-22 16:49:22 -05:00
Maccesch
parent
38b988d453
commit
60e1f140cb
16 changed files with 589 additions and 0 deletions
|
|
@ -3,6 +3,12 @@
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [Unreleased] -
|
||||||
|
|
||||||
|
### New Functions 🚀
|
||||||
|
|
||||||
|
- `use_window_size`
|
||||||
|
|
||||||
## [0.13.0] - 2024-08-28
|
## [0.13.0] - 2024-08-28
|
||||||
|
|
||||||
### New Functions 🚀
|
### New Functions 🚀
|
||||||
|
|
|
||||||
|
|
@ -48,6 +48,7 @@ unic-langid = { version = "0.9", features = ["macros"] }
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
default = [
|
default = [
|
||||||
|
"use_window_size",
|
||||||
"is_err",
|
"is_err",
|
||||||
"is_none",
|
"is_none",
|
||||||
"is_ok",
|
"is_ok",
|
||||||
|
|
@ -120,6 +121,7 @@ default = [
|
||||||
"watch_with_options",
|
"watch_with_options",
|
||||||
"whenever"
|
"whenever"
|
||||||
]
|
]
|
||||||
|
use_window_size = ["use_media_query"]
|
||||||
actix = ["dep:actix-web", "dep:leptos_actix", "dep:http0_2"]
|
actix = ["dep:actix-web", "dep:leptos_actix", "dep:http0_2"]
|
||||||
axum = ["dep:leptos_axum", "dep:http1"]
|
axum = ["dep:leptos_axum", "dep:http1"]
|
||||||
docs = ["dep:web-sys"]
|
docs = ["dep:web-sys"]
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,7 @@
|
||||||
- [use_window](elements/use_window.md)
|
- [use_window](elements/use_window.md)
|
||||||
- [use_window_focus](elements/use_window_focus.md)
|
- [use_window_focus](elements/use_window_focus.md)
|
||||||
- [use_window_scroll](elements/use_window_scroll.md)
|
- [use_window_scroll](elements/use_window_scroll.md)
|
||||||
|
- [use_window_size](elements/use_window_size.md)
|
||||||
|
|
||||||
# Browser
|
# Browser
|
||||||
|
|
||||||
|
|
|
||||||
3
docs/book/src/elements/use_window_size.md
Normal file
3
docs/book/src/elements/use_window_size.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# use_window_size
|
||||||
|
|
||||||
|
<!-- cmdrun python3 ../extract_doc_comment.py use_window_size use_window_size -->
|
||||||
|
|
@ -65,6 +65,7 @@ members = [
|
||||||
"use_webtransport",
|
"use_webtransport",
|
||||||
"use_window_focus",
|
"use_window_focus",
|
||||||
"use_window_scroll",
|
"use_window_scroll",
|
||||||
|
"use_window_size",
|
||||||
"watch_debounced",
|
"watch_debounced",
|
||||||
"watch_pausable",
|
"watch_pausable",
|
||||||
"watch_throttled",
|
"watch_throttled",
|
||||||
|
|
|
||||||
16
examples/use_window_size/Cargo.toml
Normal file
16
examples/use_window_size/Cargo.toml
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
[package]
|
||||||
|
name = "use_window_size"
|
||||||
|
version = "0.1.0"
|
||||||
|
edition = "2021"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
leptos = { version = "0.6", features = ["nightly", "csr"] }
|
||||||
|
console_error_panic_hook = "0.1"
|
||||||
|
console_log = "1"
|
||||||
|
log = "0.4"
|
||||||
|
leptos-use = { path = "../..", features = ["use_window_size", "docs"] }
|
||||||
|
web-sys = "0.3"
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
wasm-bindgen = "0.2"
|
||||||
|
wasm-bindgen-test = "0.3.0"
|
||||||
23
examples/use_window_size/README.md
Normal file
23
examples/use_window_size/README.md
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
A simple example for `use_window_size`.
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
2
examples/use_window_size/Trunk.toml
Normal file
2
examples/use_window_size/Trunk.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
[build]
|
||||||
|
public_url = "/demo/"
|
||||||
7
examples/use_window_size/index.html
Normal file
7
examples/use_window_size/index.html
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link data-trunk rel="css" href="style/output.css">
|
||||||
|
</head>
|
||||||
|
<body></body>
|
||||||
|
</html>
|
||||||
3
examples/use_window_size/input.css
Normal file
3
examples/use_window_size/input.css
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
@tailwind base;
|
||||||
|
@tailwind components;
|
||||||
|
@tailwind utilities;
|
||||||
2
examples/use_window_size/rust-toolchain.toml
Normal file
2
examples/use_window_size/rust-toolchain.toml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
[toolchain]
|
||||||
|
channel = "nightly"
|
||||||
21
examples/use_window_size/src/main.rs
Normal file
21
examples/use_window_size/src/main.rs
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
use leptos::*;
|
||||||
|
use leptos_use::docs::demo_or_body;
|
||||||
|
use leptos_use::{use_window_size, UseWindowSizeReturn};
|
||||||
|
|
||||||
|
#[component]
|
||||||
|
fn Demo() -> impl IntoView {
|
||||||
|
let UseWindowSizeReturn { width, height } = use_window_size();
|
||||||
|
|
||||||
|
view! {
|
||||||
|
<p>{{ width }} x {{ height }}</p>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
_ = console_log::init_with_level(log::Level::Debug);
|
||||||
|
console_error_panic_hook::set_once();
|
||||||
|
|
||||||
|
mount_to(demo_or_body(), || {
|
||||||
|
view! { <Demo/> }
|
||||||
|
})
|
||||||
|
}
|
||||||
289
examples/use_window_size/style/output.css
Normal file
289
examples/use_window_size/style/output.css
Normal file
|
|
@ -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));
|
||||||
|
}
|
||||||
|
}
|
||||||
15
examples/use_window_size/tailwind.config.js
Normal file
15
examples/use_window_size/tailwind.config.js
Normal file
|
|
@ -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'),
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
@ -28,6 +28,8 @@ mod is_ok;
|
||||||
mod is_some;
|
mod is_some;
|
||||||
#[cfg(feature = "on_click_outside")]
|
#[cfg(feature = "on_click_outside")]
|
||||||
mod on_click_outside;
|
mod on_click_outside;
|
||||||
|
#[cfg(feature = "use_window_size")]
|
||||||
|
mod use_window_size;
|
||||||
#[cfg(feature = "signal_debounced")]
|
#[cfg(feature = "signal_debounced")]
|
||||||
mod signal_debounced;
|
mod signal_debounced;
|
||||||
#[cfg(feature = "signal_throttled")]
|
#[cfg(feature = "signal_throttled")]
|
||||||
|
|
@ -169,6 +171,8 @@ pub use is_ok::*;
|
||||||
pub use is_some::*;
|
pub use is_some::*;
|
||||||
#[cfg(feature = "on_click_outside")]
|
#[cfg(feature = "on_click_outside")]
|
||||||
pub use on_click_outside::*;
|
pub use on_click_outside::*;
|
||||||
|
#[cfg(feature = "use_window_size")]
|
||||||
|
pub use use_window_size::*;
|
||||||
#[cfg(feature = "signal_debounced")]
|
#[cfg(feature = "signal_debounced")]
|
||||||
pub use signal_debounced::*;
|
pub use signal_debounced::*;
|
||||||
#[cfg(feature = "signal_throttled")]
|
#[cfg(feature = "signal_throttled")]
|
||||||
|
|
|
||||||
194
src/use_window_size.rs
Normal file
194
src/use_window_size.rs
Normal file
|
|
@ -0,0 +1,194 @@
|
||||||
|
use crate::core::Size;
|
||||||
|
use crate::{
|
||||||
|
use_event_listener_with_options, use_media_query, use_window, UseEventListenerOptions,
|
||||||
|
};
|
||||||
|
use default_struct_builder::DefaultBuilder;
|
||||||
|
use leptos::ev::resize;
|
||||||
|
use leptos::*;
|
||||||
|
|
||||||
|
/// Reactive window size.
|
||||||
|
///
|
||||||
|
/// ## Demo
|
||||||
|
///
|
||||||
|
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_window_size)
|
||||||
|
///
|
||||||
|
/// ## Usage
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # use leptos::*;
|
||||||
|
/// # use leptos_use::{use_window_size, UseWindowSizeReturn};
|
||||||
|
/// #
|
||||||
|
/// # #[component]
|
||||||
|
/// # fn Demo() -> impl IntoView {
|
||||||
|
/// let UseWindowSizeReturn { width, height } = use_window_size();
|
||||||
|
/// #
|
||||||
|
/// # view! { }
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// ## Server-Side Rendering
|
||||||
|
///
|
||||||
|
/// On the server the width and height are always `initial_size` which defaults to
|
||||||
|
/// `Size { width: INFINITY, height: INFINITY }`.
|
||||||
|
// #[doc(cfg(feature = "use_window_size"))]
|
||||||
|
pub fn use_window_size() -> UseWindowSizeReturn {
|
||||||
|
use_window_size_with_options(UseWindowSizeOptions::default())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Version of [`fn@crate::use_window_size`] that takes a `UseWindowSizeOptions`. See [`fn@crate::use_window_size`] for how to use.
|
||||||
|
// #[doc(cfg(feature = "use_window_size"))]
|
||||||
|
pub fn use_window_size_with_options(options: UseWindowSizeOptions) -> UseWindowSizeReturn {
|
||||||
|
let UseWindowSizeOptions {
|
||||||
|
initial_size,
|
||||||
|
listen_orientation,
|
||||||
|
include_scrollbar,
|
||||||
|
measure_type,
|
||||||
|
} = options;
|
||||||
|
|
||||||
|
let (width, set_width) = create_signal(initial_size.width);
|
||||||
|
let (height, set_height) = create_signal(initial_size.height);
|
||||||
|
|
||||||
|
let update;
|
||||||
|
|
||||||
|
#[cfg(not(feature = "ssr"))]
|
||||||
|
{
|
||||||
|
update = move || match measure_type {
|
||||||
|
MeasureType::Outer => {
|
||||||
|
set_width.set(
|
||||||
|
window()
|
||||||
|
.outer_width()
|
||||||
|
.expect("failed to get window width")
|
||||||
|
.as_f64()
|
||||||
|
.expect("width is not a f64"),
|
||||||
|
);
|
||||||
|
set_height.set(
|
||||||
|
window()
|
||||||
|
.outer_height()
|
||||||
|
.expect("failed to get window height")
|
||||||
|
.as_f64()
|
||||||
|
.expect("height is not a f64"),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
MeasureType::Inner => {
|
||||||
|
if include_scrollbar {
|
||||||
|
set_width.set(
|
||||||
|
window()
|
||||||
|
.inner_width()
|
||||||
|
.expect("failed to get window width")
|
||||||
|
.as_f64()
|
||||||
|
.expect("width is not a f64"),
|
||||||
|
);
|
||||||
|
set_height.set(
|
||||||
|
window()
|
||||||
|
.inner_height()
|
||||||
|
.expect("failed to get window height")
|
||||||
|
.as_f64()
|
||||||
|
.expect("height is not a f64"),
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
set_width.set(
|
||||||
|
document()
|
||||||
|
.document_element()
|
||||||
|
.expect("no document element")
|
||||||
|
.client_width() as f64,
|
||||||
|
);
|
||||||
|
set_height.set(
|
||||||
|
document()
|
||||||
|
.document_element()
|
||||||
|
.expect("no document element")
|
||||||
|
.client_height() as f64,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "ssr")]
|
||||||
|
{
|
||||||
|
update = || {};
|
||||||
|
|
||||||
|
let _ = initial_size;
|
||||||
|
let _ = include_scrollbar;
|
||||||
|
let _ = measure_type;
|
||||||
|
|
||||||
|
let _ = set_width;
|
||||||
|
let _ = set_height;
|
||||||
|
}
|
||||||
|
|
||||||
|
update();
|
||||||
|
let _ = use_event_listener_with_options(
|
||||||
|
use_window(),
|
||||||
|
resize,
|
||||||
|
move |_| update(),
|
||||||
|
UseEventListenerOptions::default().passive(true),
|
||||||
|
);
|
||||||
|
|
||||||
|
if listen_orientation {
|
||||||
|
let matches = use_media_query("(orientation: portrait)");
|
||||||
|
|
||||||
|
create_effect(move |_| {
|
||||||
|
matches.track();
|
||||||
|
|
||||||
|
update();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
UseWindowSizeReturn {
|
||||||
|
width: width.into(),
|
||||||
|
height: height.into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Options for [`fn@crate::use_window_size_with_options`].
|
||||||
|
// #[doc(cfg(feature = "use_window_size"))]
|
||||||
|
#[derive(DefaultBuilder)]
|
||||||
|
pub struct UseWindowSizeOptions {
|
||||||
|
/// The initial size before anything is measured (like on the server side).
|
||||||
|
/// Defaults to `Size { width: INFINITY, height: INFINITY }`.
|
||||||
|
initial_size: Size,
|
||||||
|
|
||||||
|
/// Listen to the window ` orientationchange ` event. Defaults to `true`.
|
||||||
|
listen_orientation: bool,
|
||||||
|
|
||||||
|
/// Whether the scrollbar should be included in the width and height
|
||||||
|
/// Only effective when `measure_type` is `MeasureType::Inner`.
|
||||||
|
/// Defaults to `true`.
|
||||||
|
include_scrollbar: bool,
|
||||||
|
|
||||||
|
/// Use `window.innerWidth` or `window.outerWidth`.
|
||||||
|
/// Defaults to `MeasureType::Inner`.
|
||||||
|
measure_type: MeasureType,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Type of the `measure_type` option.
|
||||||
|
#[derive(Default, Clone, Copy, PartialEq, Eq, Debug)]
|
||||||
|
pub enum MeasureType {
|
||||||
|
/// Use `window.innerWidth`
|
||||||
|
#[default]
|
||||||
|
Inner,
|
||||||
|
/// Use `window.outerWidth`
|
||||||
|
Outer,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for UseWindowSizeOptions {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self {
|
||||||
|
initial_size: Size {
|
||||||
|
width: f64::INFINITY,
|
||||||
|
height: f64::INFINITY,
|
||||||
|
},
|
||||||
|
listen_orientation: true,
|
||||||
|
include_scrollbar: true,
|
||||||
|
measure_type: MeasureType::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return type of [`fn@crate::use_window_size`].
|
||||||
|
// #[doc(cfg(feature = "use_window_size"))]
|
||||||
|
pub struct UseWindowSizeReturn {
|
||||||
|
/// The width of the window.
|
||||||
|
pub width: Signal<f64>,
|
||||||
|
/// The height of the window.
|
||||||
|
pub height: Signal<f64>,
|
||||||
|
}
|
||||||
Loading…
Add table
Reference in a new issue