Support language script subtags (#384)

Author: mondeja

CHANGELOG.md

@@ -1,6 +1,76 @@
 # CHANGELOG
 
-## Unreleased
+## 2025-12-25 - [0.3.0]
+
+### Breaking changes
+
+#### Removed functions to simplify API
+
+The next deprecated functions and methods have been removed:
+
+- `i18n` (use `expect_context::<leptos_fluent::I18n>()` instead)
+- `use_i18n` (use `use_context::<leptos_fluent::I18n>()` instead)
+- `expect_i18n` (use `expect_context::<leptos_fluent::I18n>()` instead)
+- `Language.is_active` (use `i18n.language.get() == lang` instead)
+- `Language.activate` (use `i18n.language.set(lang)` instead)
+- `tr_impl` (use `i18n.tr(id)` method instead)
+- `tr_with_args_impl` (use `i18n.tr_with_args(id, args)` method instead)
+
+#### Removed options including `localstorage` and `sessionstorage`
+
+The deprecated options variants including the terms `localstorage` and
+`sessionstorage` in their names have been removed. Use the new variants
+including `local_storage` and `session_storage`.
+
+#### `Language.id` is now a `&'static str`
+
+The type of the `id` field of the `Language` struct has been changed
+from `unic_langid::LanguageIdentifier` to `&'static str`. This simplifies
+the usage of the `Language` struct and avoids unnecessary conversions.
+
+#### `*_translations` options are executed on all targets
+
+The options `check_translations` and `fill_translations` of `leptos_fluent!`
+were executed only on non-SSR targets by default. Now they are executed
+on all targets, so you need to disable them for SSR builds to prevent
+showing the same errors both in server and client builds.
+
+Use the `#[cfg(not(feature = "ssr"))]` attribute to disable them for SSR builds:
+
+```rust
+leptos_fluent! {
+    #[cfg(not(feature = "ssr"))]
+    check_translations: true,
+}
+```
+
+#### Removed features `hydrate` and `disable-unicode-isolating-marks`
+
+The features `hydrate` and `disable-unicode-isolating-marks` have been
+removed and will throw an error if used.
+
+#### Changed type of `Language.id` field
+
+The type of the `id` field of the `Language` struct has been changed
+from `pub id: &'static fluent_templates::LanguageIdentifier`, to
+`pub id: &'static str`.
+
+Use `fluent_templates::LanguageIdentifier::from_str(language.id)`
+to convert it back.
+
+### New features
+
+#### Language entries with script subtags
+
+Add support for language entries with script subtags, automatically detecting
+script, flag and display name when using `sr-Latn`, `sr-Cyrl`, `zh-Hans`,
+`zh-Hant`, and similar BCP 47 tags.
+
+Includes the addition of an `Option<&'static str>` `script` field to `Language`.
+
+### Bug fixes
+
+- The URL does not set the language on hydration when using `initial_language_from_url_param`.
 
 ## 2025-12-12 - [0.2.21]
 
@@ -924,6 +994,7 @@ version to `0.1` during installation.
 
 - Added all ISO-639-1 and ISO-639-2 languages.
 
+[0.3.0]: https://github.com/mondeja/leptos-fluent/compare/v0.2.21...v0.3.0
 [0.2.21]: https://github.com/mondeja/leptos-fluent/compare/v0.2.20...v0.2.21
 [0.2.20]: https://github.com/mondeja/leptos-fluent/compare/v0.2.19...v0.2.20
 [0.2.19]: https://github.com/mondeja/leptos-fluent/compare/v0.2.18...v0.2.19

Cargo.lock

@@ -116,7 +116,7 @@ path = "src/lib.rs"
 
 [dependencies]
 leptos = { version = "0.8", features = ["csr"] }
-leptos-fluent = "0.2"
+leptos-fluent = "0.3"
 console_error_panic_hook = "0.1"
 
 # Using cargo-leptos

README.md

@@ -10,7 +10,7 @@ For client side rendering apps just install **leptos-fluent**:
 
 ```toml
 [dependencies]
-leptos-fluent = "0.2"
+leptos-fluent = "0.3"
 ```
 
 ## SSR
@@ -20,7 +20,7 @@ For server side rendering apps install **leptos-fluent** and enable
 
 ```toml
 [dependencies]
-leptos-fluent = "0.2"
+leptos-fluent = "0.3"
 axum = { version = "0.8", optional = true }
 
 [features]
@@ -43,7 +43,7 @@ applications. You need to install **leptos-fluent**, and enable the
 
 ```toml
 [dependencies]
-leptos-fluent = { version = "0.2", features = ["system"] }
+leptos-fluent = { version = "0.3", features = ["system"] }
 ```
 
 ## Features
@@ -66,7 +66,7 @@ feature:
 
 ```toml
 [dependencies]
-leptos-fluent = { version = "0.2", features = ["nightly"] }
+leptos-fluent = { version = "0.3", features = ["nightly"] }
 ```
 
 ## Language files
@@ -79,7 +79,7 @@ enabled:
 
 ```toml
 [dependencies]
-leptos-fluent = { version = "0.2", features = ["json5"] }
+leptos-fluent = { version = "0.3", features = ["json5"] }
 ```
 
 <!-- markdownlint-enable MD013 -->
@@ -113,7 +113,7 @@ To enable [`tracing`] support, add the `tracing` feature to **leptos-fluent**:
 
 ```toml
 [dependencies]
-leptos-fluent = { version = "0.2", features = ["tracing"] }
+leptos-fluent = { version = "0.3", features = ["tracing"] }
 fluent-templates = "0.13"
 ```
 
@@ -123,6 +123,7 @@ fluent-templates = "0.13"
 ## Compatibility
 
 | **leptos-fluent** | **leptos** |
-| ----------------- | ---------- |
-| 0.2               | 0.7 / 0.8  |
-| 0.1               | 0.6        |
+| :---------------: | :--------: |
+|        0.3        |    0.8     |
+|        0.2        | 0.7 / 0.8  |
+|        0.1        |    0.6     |

book/src/basic-usage.md

@@ -20,14 +20,18 @@ compile time:
 ```rust
 let LANGUAGES = [
   leptos_fluent::Language {
-    id: unic_langid::langid!("en"),
+    id: "en",
     name: "English",
     dir: leptos_fluent::WritingDirection::Ltr,
+    flag: Some("🇬🇧"),
+    script: None,
   },
   leptos_fluent::Language {
-    id: unic_langid::langid!("es-ES"),
+    id: "es-ES",
     name: "Español (España)",
     dir: leptos_fluent::WritingDirection::Ltr,
+    flag: Some("🇪🇸"),
+    script: None,
   },
 ]
 ```
@@ -82,7 +86,7 @@ format you want to use in the _Cargo.toml_ file:
 
 ```toml
 [dependencies]
-leptos-fluent = { version = "0.2", features = ["json5"] }
+leptos-fluent = { version = "0.3", features = ["json5"] }
 ```
 
 Available features for languages file formats are:

book/src/install.md

@@ -50,7 +50,7 @@ pub fn LanguageSelector() -> impl IntoView {
         </fieldset>
         <pre>
             {move_tr!(
-                if {i18n.language.get().id.to_string() == *"en"} {
+                if {i18n.language.get().id == "en"} {
                     "language-is-english"
                 } else {
                     "language-is-spanish"

book/src/languages.md

@@ -2,7 +2,7 @@
 name = "leptos-fluent-macros"
 description = "Macros for leptos-fluent"
 edition.workspace = true
-version = "0.2.21"
+version = "0.3.0"
 rust-version = "1.79.0"
 license = "MIT"
 documentation.workspace = true