diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml index b1e6e05..e8f15e6 100644 --- a/.github/workflows/cd.yml +++ b/.github/workflows/cd.yml @@ -23,20 +23,27 @@ jobs: components: rustfmt, clippy, rust-src - name: Cache uses: Swatinem/rust-cache@v2 + - name: Check function count badge run: python3 docs/generate_count_badge.py --check - name: Check version in docs run: python3 docs/add_version_to_docs.py --check + - name: Check formatting run: cargo fmt --check - name: Clippy run: cargo clippy --features docs,math --tests -- -D warnings + - name: Run tests (general) run: cargo test --features math,docs,ssr - - name: Run tests (axum) - run: cargo test --features math,docs,ssr,axum --doc use_cookie::use_cookie - - name: Run tests (actix) - run: cargo test --features math,docs,ssr,actix --doc use_cookie::use_cookie + - name: Run tests (axum) use_cookie + run: cargo test --features math,docs,ssr,axum --doc use_cookie + - name: Run tests (axum) use_locales + run: cargo test --features math,docs,ssr,axum --doc use_locales + - name: Run tests (actix) use_cookie + run: cargo test --features math,docs,ssr,actix --doc use_cookie + - name: Run tests (actix) use_locales + run: cargo test --features math,docs,ssr,actix --doc use_locales #### mdbook - name: Install mdbook I diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 68ee5cf..6de613d 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,5 +1,11 @@ on: pull_request: + branches: + - main + paths: + - "**" + - "!/*.md" + - "!/**.md" workflow_dispatch: name: Tests @@ -20,13 +26,18 @@ jobs: components: rustfmt, clippy, rust-src - name: Cache uses: Swatinem/rust-cache@v2 - - name: Check formatting - run: cargo fmt --check - - name: Clippy - run: cargo clippy --features docs,math --tests -- -D warnings + - name: Run tests (general) run: cargo test --features math,docs,ssr - - name: Run tests (axum) - run: cargo test --features math,docs,ssr,axum --doc use_cookie::use_cookie - - name: Run tests (actix) - run: cargo test --features math,docs,ssr,actix --doc use_cookie::use_cookie + + - name: Run tests (axum) use_cookie + run: cargo test --features math,docs,ssr,axum --doc use_cookie + + - name: Run tests (axum) use_locales + run: cargo test --features math,docs,ssr,axum --doc use_locales + + - name: Run tests (actix) use_cookie + run: cargo test --features math,docs,ssr,actix --doc use_cookie + + - name: Run tests (actix) use_locales + run: cargo test --features math,docs,ssr,actix --doc use_locales diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml index b65a8a2..bc52064 100644 --- a/.idea/leptos-use.iml +++ b/.idea/leptos-use.iml @@ -78,6 +78,7 @@ + diff --git a/CHANGELOG.md b/CHANGELOG.md index 6516447..bfc939a 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_locale` - `header` – Standard implementations for reading a header on the server. ## [0.11.0] - 2024-07-27 diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index c70b480..75aad32 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -114,6 +114,7 @@ # Intl - [use_intl_number_format](intl/use_intl_number_format.md) +- [use_locales](intl/use_locales.md) # @Math diff --git a/docs/book/src/intl/use_locales.md b/docs/book/src/intl/use_locales.md new file mode 100644 index 0000000..084b0fd --- /dev/null +++ b/docs/book/src/intl/use_locales.md @@ -0,0 +1,3 @@ +# use_locales + + diff --git a/examples/Cargo.toml b/examples/Cargo.toml index f428959..12466ce 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -38,6 +38,7 @@ members = [ "use_interval", "use_interval_fn", "use_intl_number_format", + "use_locales", "use_media_query", "use_mouse", "use_mouse_in_element", diff --git a/examples/ssr/src/app.rs b/examples/ssr/src/app.rs index 7db0793..9ffe5d0 100644 --- a/examples/ssr/src/app.rs +++ b/examples/ssr/src/app.rs @@ -1,15 +1,15 @@ use crate::error_template::{AppError, ErrorTemplate}; +use codee::string::FromToStringCodec; use leptos::ev::{keypress, KeyboardEvent}; use leptos::*; use leptos_meta::*; use leptos_router::*; use leptos_use::storage::{use_local_storage, use_local_storage_with_options, UseStorageOptions}; -use codee::string::FromToStringCodec; use leptos_use::{ use_color_mode_with_options, use_cookie_with_options, use_debounce_fn, use_event_listener, - use_interval, use_intl_number_format, use_preferred_dark, use_timestamp, use_window, ColorMode, - UseColorModeOptions, UseColorModeReturn, UseCookieOptions, UseIntervalReturn, - UseIntlNumberFormatOptions, + use_interval, use_intl_number_format, use_locales, use_preferred_dark, use_timestamp, + use_window, ColorMode, UseColorModeOptions, UseColorModeReturn, UseCookieOptions, + UseIntervalReturn, UseIntlNumberFormatOptions, }; #[component] @@ -83,12 +83,13 @@ fn HomePage() -> impl IntoView { .default_value(Some("Bogus string".to_owned())), ); + let locales = use_locales(); + view! {

Leptos-Use SSR Example

-

Locale zh-Hans-CN-u-nu-hanidec: {zh_count}

Press any key: {key}

Debounced called: {debounce_value}

Color mode: {move || format!("{:?}", mode.get())}

@@ -99,7 +100,10 @@ fn HomePage() -> impl IntoView {

Dark preferred: {is_dark_preferred}

Test cookie: {move || test_cookie().unwrap_or("".to_string())}

+ 
{move || format!("Locales:\n    {}", locales().join("\n    "))}
+

Locale zh-Hans-CN-u-nu-hanidec: {zh_count}

+ 0 }>
Greater than 0
diff --git a/examples/use_locales/Cargo.toml b/examples/use_locales/Cargo.toml new file mode 100644 index 0000000..05b5bc9 --- /dev/null +++ b/examples/use_locales/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_locales" +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 = ["docs"] } +web-sys = "0.3" + +[dev-dependencies] +wasm-bindgen = "0.2" +wasm-bindgen-test = "0.3.0" diff --git a/examples/use_locales/README.md b/examples/use_locales/README.md new file mode 100644 index 0000000..f1827be --- /dev/null +++ b/examples/use_locales/README.md @@ -0,0 +1,23 @@ +A simple example for `use_locales`. + +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_locales/Trunk.toml b/examples/use_locales/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_locales/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_locales/index.html b/examples/use_locales/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_locales/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_locales/input.css b/examples/use_locales/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_locales/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_locales/rust-toolchain.toml b/examples/use_locales/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_locales/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_locales/src/main.rs b/examples/use_locales/src/main.rs new file mode 100644 index 0000000..dfa206b --- /dev/null +++ b/examples/use_locales/src/main.rs @@ -0,0 +1,21 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::use_locales; + +#[component] +fn Demo() -> impl IntoView { + let locales = use_locales(); + + view! { + 
{move || format!("Locales:\n    {}", locales().join("\n    "))}
+ } +} + +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_locales/style/output.css b/examples/use_locales/style/output.css new file mode 100644 index 0000000..ab5191f --- /dev/null +++ b/examples/use_locales/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_locales/tailwind.config.js b/examples/use_locales/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_locales/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 efcf708..45a0e14 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -57,6 +57,7 @@ mod use_intersection_observer; mod use_interval; mod use_interval_fn; mod use_intl_number_format; +mod use_locales; mod use_media_query; mod use_mouse; mod use_mouse_in_element; @@ -123,6 +124,7 @@ pub use use_intersection_observer::*; pub use use_interval::*; pub use use_interval_fn::*; pub use use_intl_number_format::*; +pub use use_locales::*; pub use use_media_query::*; pub use use_mouse::*; pub use use_mouse_in_element::*; diff --git a/src/use_cookie.rs b/src/use_cookie.rs index 2e6c894..13f36fe 100644 --- a/src/use_cookie.rs +++ b/src/use_cookie.rs @@ -100,7 +100,7 @@ use std::rc::Rc; /// /// ### Bring your own header /// -/// In case you're neither using Axum nor Actix, or the default implementation is not to your liking, +/// In case you're neither using Axum, Actix nor Spin, or the default implementation is not to your liking, /// you can provide your own way of reading and writing the cookie header value. /// /// ``` diff --git a/src/use_locales.rs b/src/use_locales.rs new file mode 100644 index 0000000..e6d6cc4 --- /dev/null +++ b/src/use_locales.rs @@ -0,0 +1,114 @@ +use crate::utils::get_header; +use default_struct_builder::DefaultBuilder; +use leptos::*; +use std::rc::Rc; + +/// Reactive accepted locales. +/// +/// If called on the client-side this function returns the value of +/// [`navigator.languages`](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/languages) +/// and listens for changes to that property. +/// +/// See "Server-Side Rendering" below. +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_locales) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::use_locales; +/// # +/// # #[component] +/// # fn Demo() -> impl IntoView { +/// let locales = use_locales(); +/// # +/// # view! { } +/// # } +/// ``` +/// +/// ## Server-Side Rendering +/// +/// On the server this returns the parsed value of the `accept-language` header. +/// +/// > If you're using `axum` you have to enable the `"axum"` feature in your Cargo.toml. +/// > In case it's `actix-web` enable the feature `"actix"`, for `spin` enable `"spin"`. +/// +/// ### Bring your own header +/// +/// In case you're neither using Axum, Actix nor Spin, or the default implementation is not to your liking, +/// you can provide your own way of reading and writing the cookie header value using the option +/// [`crate::UseLocalesOptions::ssr_lang_header_getter`]. +pub fn use_locales() -> Signal> { + use_locales_with_options(UseLocalesOptions::default()) +} + +/// Version of [`fn@crate::use_locales`] that takes a `UseLocalesOptions`. See [`fn@crate::use_locales`] for how to use. +pub fn use_locales_with_options(options: UseLocalesOptions) -> Signal> { + #[cfg(not(feature = "ssr"))] + { + let _ = options; + + let read_navigator_languages = || { + let window = crate::use_window(); + let navigator = window.navigator(); + navigator + .map(|navigator| navigator.languages().to_vec()) + .unwrap_or_default() + .into_iter() + .filter_map(|x| x.as_string()) + .collect::>() + }; + + let (locales, set_locales) = create_signal(read_navigator_languages()); + + let _ = crate::use_event_listener(crate::use_window(), ev::languagechange, move |_| { + set_locales.update(|locales| *locales = read_navigator_languages()); + }); + + locales.into() + } + + #[cfg(feature = "ssr")] + { + let UseLocalesOptions { + ssr_lang_header_getter, + } = options; + + let accept_language = ssr_lang_header_getter().unwrap_or_default(); + + let locales = accept_language + .split(',') + .map(|locale| { + locale + .split_once(';') + .map(|x| x.0) + .unwrap_or(locale) + .to_owned() + }) + .collect::>(); + + Signal::derive(move || locales.clone()) + } +} + +/// Options for [`fn@crate::use_locales_with_options`]. +#[derive(DefaultBuilder)] +pub struct UseLocalesOptions { + /// Getter function to return the string value of the accept languange header. + /// When you use one of the features `"axum"`, `"actix"` or `"spin"` there's a valid default implementation provided. + #[allow(dead_code)] + ssr_lang_header_getter: Rc Option>, +} + +impl Default for UseLocalesOptions { + fn default() -> Self { + Self { + ssr_lang_header_getter: Rc::new(move || { + get_header!(ACCEPT_LANGUAGE, use_locale, ssr_lang_header_getter) + }), + } + } +} diff --git a/template/src/{{ module }}/{{ function_name }}.ffizer.hbs.rs b/template/src/{{ module }}/{{ function_name }}.ffizer.hbs.rs index 0edb6ba..ef81b03 100644 --- a/template/src/{{ module }}/{{ function_name }}.ffizer.hbs.rs +++ b/template/src/{{ module }}/{{ function_name }}.ffizer.hbs.rs @@ -22,19 +22,23 @@ use leptos::*; /// # /// # view! { } /// # } -/// ```{{#if feature}} +/// ``` +/// +/// ## Server-Side Rendering +/// {{#if feature}} // #[doc(cfg(feature = "{{feature}}"))]{{/if}} + pub fn {{ function_name }}() -> {{ to_pascal_case function_name }}Return { {{ function_name }}_with_options({{ to_pascal_case function_name }}Options::default()) } -/// Version of [`{{ function_name }}`] that takes a `{{ to_pascal_case function_name }}Options`. See [`{{ function_name }}`] for how to use.{{#if feature}} +/// Version of [`fn@crate::{{ function_name }}`] that takes a `{{ to_pascal_case function_name }}Options`. See [`fn@crate::{{ function_name }}`] for how to use.{{#if feature}} // #[doc(cfg(feature = "{{feature}}"))]{{/if}} pub fn {{ function_name }}_with_options(options: {{ to_pascal_case function_name }}Options) -> {{ to_pascal_case function_name }}Return { {{ to_pascal_case function_name }}Return {} } -/// Options for [`{{ function_name }}_with_options`].{{#if feature}} +/// Options for [`fn@crate::{{ function_name }}_with_options`].{{#if feature}} // #[doc(cfg(feature = "{{feature}}"))]{{/if}} #[derive(DefaultBuilder)] pub struct {{ to_pascal_case function_name }}Options {} @@ -45,6 +49,6 @@ impl Default for {{ to_pascal_case function_name }}Options { } } -/// Return type of [`{{ function_name }}`].{{#if feature}} +/// Return type of [`fn@crate::{{ function_name }}`].{{#if feature}} // #[doc(cfg(feature = "{{feature}}"))]{{/if}} pub struct {{ to_pascal_case function_name }}Return {} \ No newline at end of file