diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml index 91f8ed7..0880dd5 100644 --- a/.idea/leptos-use.iml +++ b/.idea/leptos-use.iml @@ -20,6 +20,7 @@ + @@ -38,6 +39,7 @@ + diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b3bcd2..cb05321 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ #### Braking Changes - `watch` doesn't accept `immediate` as a direct argument anymore. This is only provided by the option variant. +- `watch` has now variant `watch_with_options` which allows for debouncing and throttling. #### New Functions - `use_storage` @@ -17,10 +18,11 @@ - `use_media_query` - `use_preferred_dark` - `use_preferred_contrast` +- `use_favicon` #### Other Changes -- `watch` has now variant `watch_with_options` which allows for debouncing and throttling. +- Function count badge in readme ## 0.1.8/9 diff --git a/Cargo.toml b/Cargo.toml index 48e7573..9f15e93 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -31,9 +31,11 @@ features = [ "CustomEventInit", "DomRectReadOnly", "Element", + "HtmlLinkElement", "MediaQueryList", "MouseEvent", "Navigator", + "NodeList", "ResizeObserver", "ResizeObserverBoxOptions", "ResizeObserverEntry", diff --git a/README.md b/README.md index 4d20418..ebf43ea 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@

Crates.io Docs & Demos - 23 Functions + 23 Functions


diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 28290be..e0c601e 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -19,6 +19,7 @@ # Browser - [use_event_listener](browser/use_event_listener.md) +- [use_favicon](browser/use_favicon.md) - [use_media_query](browser/use_media_query.md) - [use_preferred_contrast](browser/use_preferred_contrast.md) - [use_preferred_dark](browser/use_preferred_dark.md) diff --git a/docs/book/src/browser/use_favicon.md b/docs/book/src/browser/use_favicon.md new file mode 100644 index 0000000..079edc3 --- /dev/null +++ b/docs/book/src/browser/use_favicon.md @@ -0,0 +1,3 @@ +# use_favicon + + diff --git a/docs/generate_count_badge.py b/docs/generate_count_badge.py index bbe1e25..77310f4 100644 --- a/docs/generate_count_badge.py +++ b/docs/generate_count_badge.py @@ -21,7 +21,7 @@ def main(): original_text ) - if sys.argv[1] == "--check": + if len(sys.argv) > 1 and sys.argv[1] == "--check": if original_text != text: print("[Failed] README.md doesn't have the correct function count badge", file=sys.stderr) print(" * Run `python3 docs/generate_count_badge.py` to fix", file=sys.stderr) diff --git a/examples/use_favicon/Cargo.toml b/examples/use_favicon/Cargo.toml new file mode 100644 index 0000000..200f958 --- /dev/null +++ b/examples/use_favicon/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_favicon" +version = "0.1.0" +edition = "2021" + +[dependencies] +leptos = "0.3" +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_favicon/README.md b/examples/use_favicon/README.md new file mode 100644 index 0000000..25309a4 --- /dev/null +++ b/examples/use_favicon/README.md @@ -0,0 +1,23 @@ +A simple example for `use_favicon`. + +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_favicon/Trunk.toml b/examples/use_favicon/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_favicon/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_favicon/img/favicon-blue.svg b/examples/use_favicon/img/favicon-blue.svg new file mode 100644 index 0000000..4eb0b17 --- /dev/null +++ b/examples/use_favicon/img/favicon-blue.svg @@ -0,0 +1,27 @@ + + + + + + + + + \ No newline at end of file diff --git a/examples/use_favicon/img/favicon-green.svg b/examples/use_favicon/img/favicon-green.svg new file mode 100644 index 0000000..e7ac47c --- /dev/null +++ b/examples/use_favicon/img/favicon-green.svg @@ -0,0 +1,27 @@ + + + + + + + + + \ No newline at end of file diff --git a/examples/use_favicon/img/favicon-leptos.ico b/examples/use_favicon/img/favicon-leptos.ico new file mode 100644 index 0000000..2ba8527 Binary files /dev/null and b/examples/use_favicon/img/favicon-leptos.ico differ diff --git a/examples/use_favicon/img/favicon-orange.svg b/examples/use_favicon/img/favicon-orange.svg new file mode 100644 index 0000000..f725f04 --- /dev/null +++ b/examples/use_favicon/img/favicon-orange.svg @@ -0,0 +1,27 @@ + + + + + + + + + \ No newline at end of file diff --git a/examples/use_favicon/img/favicon-red.svg b/examples/use_favicon/img/favicon-red.svg new file mode 100644 index 0000000..09f8e86 --- /dev/null +++ b/examples/use_favicon/img/favicon-red.svg @@ -0,0 +1,27 @@ + + + + + + + + + \ No newline at end of file diff --git a/examples/use_favicon/index.html b/examples/use_favicon/index.html new file mode 100644 index 0000000..5b7a5e0 --- /dev/null +++ b/examples/use_favicon/index.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/examples/use_favicon/input.css b/examples/use_favicon/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_favicon/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_favicon/rust-toolchain.toml b/examples/use_favicon/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_favicon/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_favicon/src/main.rs b/examples/use_favicon/src/main.rs new file mode 100644 index 0000000..9f0cc3c --- /dev/null +++ b/examples/use_favicon/src/main.rs @@ -0,0 +1,63 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::{use_favicon_with_options, UseFaviconOptions}; + +#[component] +fn Demo(cx: Scope) -> impl IntoView { + let (_, set_icon) = use_favicon_with_options( + cx, + UseFaviconOptions::default().base_url("use_favicon/demo/img/"), + ); + + let classes = "border border-solid border-b-4 rounded p-2 block border-gray-500/50 bg-[--bg] active:translate-y-1 active:border-b".to_string(); + let img_classes = "block".to_string(); + + view! { cx, +

"Click on an icon to change the favicon"

+

+ + favicon-red + + + + favicon-red + + + + favicon-green + + + + favicon-blue + + + + favicon-orange + +

+ } +} + +fn main() { + _ = console_log::init_with_level(log::Level::Debug); + console_error_panic_hook::set_once(); + + mount_to(demo_or_body(), |cx| { + view! { cx, } + }) +} diff --git a/examples/use_favicon/style/output.css b/examples/use_favicon/style/output.css new file mode 100644 index 0000000..1a42192 --- /dev/null +++ b/examples/use_favicon/style/output.css @@ -0,0 +1,403 @@ +[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: ; +} + +.m-2 { + margin: 0.5rem; +} + +.block { + display: block; +} + +.inline-block { + display: inline-block; +} + +.flex { + display: flex; +} + +.gap-2 { + gap: 0.5rem; +} + +.rounded { + border-radius: 0.25rem; +} + +.border { + border-width: 1px; +} + +.border-b { + border-bottom-width: 1px; +} + +.border-b-2 { + border-bottom-width: 2px; +} + +.border-b-4 { + border-bottom-width: 4px; +} + +.border-solid { + border-style: solid; +} + +.border-black { + --tw-border-opacity: 1; + border-color: rgb(0 0 0 / var(--tw-border-opacity)); +} + +.border-\[\] { + border-color: ; +} + +.border-\[--\] { + border-color: var(--); +} + +.border-\[--theme-popup-border\] { + border-color: var(--theme-popup-border); +} + +.border-gray-500 { + --tw-border-opacity: 1; + border-color: rgb(107 114 128 / var(--tw-border-opacity)); +} + +.border-gray-600 { + --tw-border-opacity: 1; + border-color: rgb(75 85 99 / var(--tw-border-opacity)); +} + +.border-red-600 { + --tw-border-opacity: 1; + border-color: rgb(220 38 38 / var(--tw-border-opacity)); +} + +.border-gray-500\/50 { + border-color: rgb(107 114 128 / 0.5); +} + +.bg-\[--theme-popup-border\] { + background-color: var(--theme-popup-border); +} + +.bg-\[--bg\] { + background-color: var(--bg); +} + +.bg-white { + --tw-bg-opacity: 1; + background-color: rgb(255 255 255 / var(--tw-bg-opacity)); +} + +.p-2 { + padding: 0.5rem; +} + +.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; +} + +.hover\:bg-\[\]:hover { + background-color: ; +} + +.hover\:bg-\[--bg\]:hover { + background-color: var(--bg); +} + +.hover\:bg-\[--bg\&\]:hover { + background-color: var(--bg&); +} + +.active\:translate-y-1:active { + --tw-translate-y: 0.25rem; + transform: translate(var(--tw-translate-x), var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y)); +} + +.active\:border-b:active { + border-bottom-width: 1px; +} + +@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_favicon/tailwind.config.js b/examples/use_favicon/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_favicon/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 1326887..9418194 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -12,6 +12,7 @@ mod use_debounce_fn; #[cfg(web_sys_unstable_apis)] mod use_element_size; mod use_event_listener; +mod use_favicon; mod use_media_query; mod use_mouse; mod use_preferred_contrast; @@ -31,6 +32,7 @@ pub use use_debounce_fn::*; #[cfg(web_sys_unstable_apis)] pub use use_element_size::*; pub use use_event_listener::*; +pub use use_favicon::*; pub use use_media_query::*; pub use use_mouse::*; pub use use_preferred_contrast::*; diff --git a/src/use_favicon.rs b/src/use_favicon.rs new file mode 100644 index 0000000..70a50ef --- /dev/null +++ b/src/use_favicon.rs @@ -0,0 +1,127 @@ +use crate::watch; +use default_struct_builder::DefaultBuilder; +use leptos::*; +use wasm_bindgen::JsCast; + +/// Reactive favicon. +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_favicon) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_favicon; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// # +/// let (icon, set_icon) = use_favicon(cx); +/// +/// set_icon(Some("dark.png".to_string())); // change current icon +/// # +/// # view! { cx, } +/// # } +/// ``` +/// +/// ## Passing a Source Signal +/// +/// You can pass a `Signal` to [`use_favicon_with_options`]. Change from the source signal will be +/// reflected in your favicon automatically. +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::{use_favicon_with_options, UseFaviconOptions, use_preferred_dark}; +/// # +/// # #[component] +/// # fn Demo(cx: Scope) -> impl IntoView { +/// # +/// let is_dark = use_preferred_dark(cx); +/// +/// let (icon, _) = use_favicon_with_options( +/// cx, +/// UseFaviconOptions::default().new_icon( +/// Signal::derive(cx, move || { +/// Some((if is_dark() { "dark.png" } else { "light.png" }).to_string()) +/// }), +/// ) +/// ); +/// # +/// # view! { cx, } +/// # } +/// ``` +/// +pub fn use_favicon(cx: Scope) -> (ReadSignal>, WriteSignal>) { + use_favicon_with_options(cx, UseFaviconOptions::default()) +} + +/// Version of [`use_favicon`] that accepts a `UseFaviconOptions`. See [`use_favicon`] for more details. +pub fn use_favicon_with_options( + cx: Scope, + options: UseFaviconOptions, +) -> (ReadSignal>, WriteSignal>) { + let UseFaviconOptions { + new_icon, + base_url, + rel, + } = options; + + let link_selector = format!("link[rel*=\"{rel}\"]"); + + let (favicon, set_favicon) = create_signal(cx, new_icon.get_untracked()); + + if matches!(&new_icon, MaybeSignal::Dynamic(_)) { + create_effect(cx, move |_| set_favicon(new_icon.get())); + } + + let apply_icon = move |icon: &String| { + if let Some(head) = document().head() { + if let Ok(links) = head.query_selector_all(&link_selector) { + let href = format!("{base_url}{icon}"); + + for i in 0..links.length() { + let node = links.get(i).expect("checked length"); + let link: web_sys::HtmlLinkElement = node.unchecked_into(); + link.set_href(&href); + } + } + } + }; + + let _ = watch(cx, favicon, move |new_icon, prev_icon, _| { + if Some(new_icon) != prev_icon { + if let Some(new_icon) = new_icon { + apply_icon(new_icon); + } + } + }); + + (favicon, set_favicon) +} + +/// Options for [`use_favicon_with_options`]. +#[derive(DefaultBuilder)] +pub struct UseFaviconOptions { + /// New input favicon. Can be a `Signal` in which case updates will change the favicon. Defaults to None. + #[builder(into)] + new_icon: MaybeSignal>, + + /// Base URL of the favicon. Defaults to "". + #[builder(into)] + base_url: String, + /// Rel attribute of the tag. Defaults to "icon". + #[builder(into)] + rel: String, +} + +impl Default for UseFaviconOptions { + fn default() -> Self { + Self { + new_icon: Default::default(), + base_url: "".to_string(), + rel: "icon".to_string(), + } + } +}