@rxap/ngx-localize 19.1.0-dev.5 → 19.1.0-dev.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/compodoc/changelog.html +12 -0
- package/compodoc/injectables/LanguageSelectorService.html +46 -7
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/miscellaneous/functions.html +111 -4
- package/compodoc/properties.html +1 -1
- package/docs/documentation.json +260 -45
- package/docs/html/classes/I18nService.html +3 -3
- package/docs/html/classes/LanguageSelectorService.html +10 -2
- package/docs/html/functions/LanguageInterceptor.html +5 -1
- package/docs/html/functions/loadI18nBootstrapHook.html +4 -1
- package/docs/html/functions/loadLanguages.html +9 -1
- package/docs/html/functions/xliffToJson.html +4 -1
- package/docs/html/index.html +2 -2
- package/docs/html/modules.html +1 -1
- package/docs/markdown/README.md +1 -1
- package/docs/markdown/classes/I18nService.md +5 -5
- package/docs/markdown/classes/LanguageSelectorService.md +22 -9
- package/docs/markdown/functions/LanguageInterceptor.md +10 -2
- package/docs/markdown/functions/loadI18nBootstrapHook.md +8 -2
- package/docs/markdown/functions/loadLanguages.md +20 -6
- package/docs/markdown/functions/xliffToJson.md +8 -2
- package/docs/markdown/globals.md +2 -2
- package/docs/wiki/Class.I18nService.md +4 -4
- package/docs/wiki/Class.LanguageSelectorService.md +21 -8
- package/docs/wiki/Function.LanguageInterceptor.md +9 -1
- package/docs/wiki/Function.loadI18nBootstrapHook.md +7 -1
- package/docs/wiki/Function.loadLanguages.md +19 -5
- package/docs/wiki/Function.xliffToJson.md +7 -1
- package/docs/wiki/globals.md +1 -1
- package/fesm2022/rxap-ngx-localize.mjs +77 -12
- package/fesm2022/rxap-ngx-localize.mjs.map +1 -1
- package/lib/language-interceptor.d.ts +7 -0
- package/lib/language-selector.service.d.ts +13 -0
- package/lib/load-i18n-bootstrap-hook.d.ts +6 -0
- package/lib/load-languages.d.ts +11 -0
- package/lib/xliff-to-json.d.ts +6 -0
- package/package.json +2 -2
package/docs/html/index.html
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@rxap/ngx-localize - v19.1.0-dev.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@rxap/ngx-localize - v19.1.0-dev.8</title><meta name="description" content="Documentation for @rxap/ngx-localize"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@rxap/ngx-localize - v19.1.0-dev.8</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@rxap/ngx-localize - v19.1.0-dev.8</h1></div><div class="tsd-panel tsd-typography"><p>This package provides internationalization (i18n) support for Angular applications, including services for language management, an HTTP interceptor for setting the `Accept-Language` header, and a language selector component. It allows you to set and manage the current language of your application, redirect users based on their language preference, and configure available languages. The package also includes an init generator to handle peer dependencies.</p>
|
|
2
2
|
<p><a href="https://www.npmjs.com/package/@rxap/ngx-localize"><img src="https://img.shields.io/npm/v/@rxap/ngx-localize?style=flat-square" alt="npm version"></a>
|
|
3
3
|
<a href="https://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" alt="commitizen friendly"></a>
|
|
4
4
|
<a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square" alt="styled with prettier"></a>
|
|
@@ -31,4 +31,4 @@
|
|
|
31
31
|
<pre><code class="bash"><span class="hl-0">nx</span><span class="hl-1"> </span><span class="hl-2">g</span><span class="hl-1"> </span><span class="hl-2">@rxap/ngx-localize:init</span>
|
|
32
32
|
</code><button type="button">Copy</button></pre>
|
|
33
33
|
|
|
34
|
-
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#installation"><span>Installation</span></a><a href="#generators"><span>Generators</span></a><ul><li><a href="#init"><span>init</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@rxap/ngx-localize - v19.1.0-dev.
|
|
34
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#installation"><span>Installation</span></a><a href="#generators"><span>Generators</span></a><ul><li><a href="#init"><span>init</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@rxap/ngx-localize - v19.1.0-dev.8</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/docs/html/modules.html
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@rxap/ngx-localize - v19.1.0-dev.5</title><meta name="description" content="Documentation for @rxap/ngx-localize"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@rxap/ngx-localize - v19.1.0-dev.5</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="modules.html">@rxap/ngx-localize</a></li></ul><h1>@rxap/ngx-localize - v19.1.0-dev.5</h1></div><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg> Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="i18nservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><a class="deprecated" href="classes/I18nService.html">I18nService</a><a href="#i18nservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="languageselectorservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><a href="classes/LanguageSelectorService.html">LanguageSelectorService</a><a href="#languageselectorservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg> Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="languageinterceptor" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/LanguageInterceptor.html">LanguageInterceptor</a><a href="#languageinterceptor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="loadi18nbootstraphook" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/loadI18nBootstrapHook.html">loadI18nBootstrapHook</a><a href="#loadi18nbootstraphook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="loadlanguages" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/loadLanguages.html">loadLanguages</a><a href="#loadlanguages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="xlifftojson" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/xliffToJson.html">xliffToJson</a><a href="#xlifftojson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#i18nservice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><span>I18n<wbr/>Service</span></a><a href="#languageselectorservice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><span>Language<wbr/>Selector<wbr/>Service</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#languageinterceptor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>Language<wbr/>Interceptor</span></a><a href="#loadi18nbootstraphook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>load<wbr/>I18n<wbr/>Bootstrap<wbr/>Hook</span></a><a href="#loadlanguages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>load<wbr/>Languages</span></a><a href="#xlifftojson" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>xliff<wbr/>To<wbr/>Json</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current">@rxap/ngx-localize - v19.1.0-dev.5</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@rxap/ngx-localize - v19.1.0-dev.8</title><meta name="description" content="Documentation for @rxap/ngx-localize"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@rxap/ngx-localize - v19.1.0-dev.8</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="modules.html">@rxap/ngx-localize</a></li></ul><h1>@rxap/ngx-localize - v19.1.0-dev.8</h1></div><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg> Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="i18nservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><a class="deprecated" href="classes/I18nService.html">I18nService</a><a href="#i18nservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="languageselectorservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><a href="classes/LanguageSelectorService.html">LanguageSelectorService</a><a href="#languageselectorservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg> Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="languageinterceptor" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/LanguageInterceptor.html">LanguageInterceptor</a><a href="#languageinterceptor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="loadi18nbootstraphook" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/loadI18nBootstrapHook.html">loadI18nBootstrapHook</a><a href="#loadi18nbootstraphook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="loadlanguages" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/loadLanguages.html">loadLanguages</a><a href="#loadlanguages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="xlifftojson" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/xliffToJson.html">xliffToJson</a><a href="#xlifftojson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#i18nservice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><span>I18n<wbr/>Service</span></a><a href="#languageselectorservice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg><span>Language<wbr/>Selector<wbr/>Service</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#languageinterceptor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>Language<wbr/>Interceptor</span></a><a href="#loadi18nbootstraphook" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>load<wbr/>I18n<wbr/>Bootstrap<wbr/>Hook</span></a><a href="#loadlanguages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>load<wbr/>Languages</span></a><a href="#xlifftojson" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>xliff<wbr/>To<wbr/>Json</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current">@rxap/ngx-localize - v19.1.0-dev.8</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/docs/markdown/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-localize v19.1.0-dev.
|
|
1
|
+
[**@rxap/ngx-localize v19.1.0-dev.8**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ~~I18nService~~
|
|
8
8
|
|
|
9
|
-
Defined in: [i18n.service.ts:15](https://gitlab.com/rxap/packages/-/blob/
|
|
9
|
+
Defined in: [i18n.service.ts:15](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L15)
|
|
10
10
|
|
|
11
11
|
## Deprecated
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ removed
|
|
|
28
28
|
|
|
29
29
|
> `readonly` **currentLanguage**: `Signal`\<`string`\>
|
|
30
30
|
|
|
31
|
-
Defined in: [i18n.service.ts:20](https://gitlab.com/rxap/packages/-/blob/
|
|
31
|
+
Defined in: [i18n.service.ts:20](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L20)
|
|
32
32
|
|
|
33
33
|
## Methods
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [i18n.service.ts:20](https://gitlab.com/rxap/packages/-/blob/e87f625
|
|
|
36
36
|
|
|
37
37
|
> **redirect**(`next`, `current`): `void`
|
|
38
38
|
|
|
39
|
-
Defined in: [i18n.service.ts:32](https://gitlab.com/rxap/packages/-/blob/
|
|
39
|
+
Defined in: [i18n.service.ts:32](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L32)
|
|
40
40
|
|
|
41
41
|
#### Parameters
|
|
42
42
|
|
|
@@ -58,7 +58,7 @@ Defined in: [i18n.service.ts:32](https://gitlab.com/rxap/packages/-/blob/e87f625
|
|
|
58
58
|
|
|
59
59
|
> **setLanguage**(`language`): `Promise`\<`void`\>
|
|
60
60
|
|
|
61
|
-
Defined in: [i18n.service.ts:22](https://gitlab.com/rxap/packages/-/blob/
|
|
61
|
+
Defined in: [i18n.service.ts:22](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L22)
|
|
62
62
|
|
|
63
63
|
#### Parameters
|
|
64
64
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-localize v19.1.0-dev.
|
|
1
|
+
[**@rxap/ngx-localize v19.1.0-dev.8**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: LanguageSelectorService
|
|
8
8
|
|
|
9
|
-
Defined in: [language-selector.service.ts:
|
|
9
|
+
Defined in: [language-selector.service.ts:19](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L19)
|
|
10
|
+
|
|
11
|
+
A service that manages language selection and configuration for the application.
|
|
12
|
+
Provides functionality to retrieve available languages, default language,
|
|
13
|
+
selected language, and dynamically change the application's language settings.
|
|
10
14
|
|
|
11
15
|
## Constructors
|
|
12
16
|
|
|
@@ -24,7 +28,7 @@ Defined in: [language-selector.service.ts:14](https://gitlab.com/rxap/packages/-
|
|
|
24
28
|
|
|
25
29
|
> `readonly` **defaultLanguage**: `Signal`\<`string`\>
|
|
26
30
|
|
|
27
|
-
Defined in: [language-selector.service.ts:
|
|
31
|
+
Defined in: [language-selector.service.ts:23](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L23)
|
|
28
32
|
|
|
29
33
|
***
|
|
30
34
|
|
|
@@ -32,7 +36,7 @@ Defined in: [language-selector.service.ts:18](https://gitlab.com/rxap/packages/-
|
|
|
32
36
|
|
|
33
37
|
> `readonly` **hasLanguages**: `Signal`\<`boolean`\>
|
|
34
38
|
|
|
35
|
-
Defined in: [language-selector.service.ts:
|
|
39
|
+
Defined in: [language-selector.service.ts:26](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L26)
|
|
36
40
|
|
|
37
41
|
***
|
|
38
42
|
|
|
@@ -40,7 +44,7 @@ Defined in: [language-selector.service.ts:21](https://gitlab.com/rxap/packages/-
|
|
|
40
44
|
|
|
41
45
|
> `readonly` **languages**: `Signal`\<`LanguagesConfig`\>
|
|
42
46
|
|
|
43
|
-
Defined in: [language-selector.service.ts:
|
|
47
|
+
Defined in: [language-selector.service.ts:22](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L22)
|
|
44
48
|
|
|
45
49
|
***
|
|
46
50
|
|
|
@@ -48,15 +52,18 @@ Defined in: [language-selector.service.ts:17](https://gitlab.com/rxap/packages/-
|
|
|
48
52
|
|
|
49
53
|
> `readonly` **selectedLanguage**: `WritableSignal`\<`string`\>
|
|
50
54
|
|
|
51
|
-
Defined in: [language-selector.service.ts:
|
|
55
|
+
Defined in: [language-selector.service.ts:24](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L24)
|
|
52
56
|
|
|
53
57
|
## Methods
|
|
54
58
|
|
|
55
59
|
### setLanguage()
|
|
56
60
|
|
|
57
|
-
> **setLanguage**(`language`, `reload
|
|
61
|
+
> **setLanguage**(`language`, `reload`?): `Promise`\<`void`\>
|
|
62
|
+
|
|
63
|
+
Defined in: [language-selector.service.ts:36](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L36)
|
|
58
64
|
|
|
59
|
-
|
|
65
|
+
Sets the application language to the specified value if it exists in the list of supported languages.
|
|
66
|
+
Optionally reloads the page if the `reload` parameter is set to `true`.
|
|
60
67
|
|
|
61
68
|
#### Parameters
|
|
62
69
|
|
|
@@ -64,10 +71,16 @@ Defined in: [language-selector.service.ts:23](https://gitlab.com/rxap/packages/-
|
|
|
64
71
|
|
|
65
72
|
`string`
|
|
66
73
|
|
|
67
|
-
|
|
74
|
+
The language code to set as the active language.
|
|
75
|
+
|
|
76
|
+
##### reload?
|
|
68
77
|
|
|
69
78
|
`boolean` = `false`
|
|
70
79
|
|
|
80
|
+
A flag indicating whether to reload the page after updating the language.
|
|
81
|
+
|
|
71
82
|
#### Returns
|
|
72
83
|
|
|
73
84
|
`Promise`\<`void`\>
|
|
85
|
+
|
|
86
|
+
A promise that resolves once the language has been set and optional reload is completed.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-localize v19.1.0-dev.
|
|
1
|
+
[**@rxap/ngx-localize v19.1.0-dev.8**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -8,7 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
> **LanguageInterceptor**(`request`, `next`): `Observable`\<`HttpEvent`\<`unknown`\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [language-interceptor.ts:
|
|
11
|
+
Defined in: [language-interceptor.ts:15](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-interceptor.ts#L15)
|
|
12
|
+
|
|
13
|
+
Intercepts an HTTP request to include a localized 'Accept-Language' header, if available.
|
|
12
14
|
|
|
13
15
|
## Parameters
|
|
14
16
|
|
|
@@ -16,10 +18,16 @@ Defined in: [language-interceptor.ts:8](https://gitlab.com/rxap/packages/-/blob/
|
|
|
16
18
|
|
|
17
19
|
`HttpRequest`\<`unknown`\>
|
|
18
20
|
|
|
21
|
+
The HTTP request to be intercepted and optionally modified.
|
|
22
|
+
|
|
19
23
|
### next
|
|
20
24
|
|
|
21
25
|
`HttpHandlerFn`
|
|
22
26
|
|
|
27
|
+
The next handler in the HTTP request pipeline.
|
|
28
|
+
|
|
23
29
|
## Returns
|
|
24
30
|
|
|
25
31
|
`Observable`\<`HttpEvent`\<`unknown`\>\>
|
|
32
|
+
|
|
33
|
+
An observable of the HTTP response event.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-localize v19.1.0-dev.
|
|
1
|
+
[**@rxap/ngx-localize v19.1.0-dev.8**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -8,7 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
> **loadI18nBootstrapHook**(`options`): `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [load-i18n-bootstrap-hook.ts:
|
|
11
|
+
Defined in: [load-i18n-bootstrap-hook.ts:13](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/load-i18n-bootstrap-hook.ts#L13)
|
|
12
|
+
|
|
13
|
+
Loads internationalization (i18n) bootstrap settings for the application.
|
|
12
14
|
|
|
13
15
|
## Parameters
|
|
14
16
|
|
|
@@ -16,6 +18,10 @@ Defined in: [load-i18n-bootstrap-hook.ts:7](https://gitlab.com/rxap/packages/-/b
|
|
|
16
18
|
|
|
17
19
|
`Partial`\<`ApplicationConfig`\>
|
|
18
20
|
|
|
21
|
+
The application configuration options.
|
|
22
|
+
|
|
19
23
|
## Returns
|
|
20
24
|
|
|
21
25
|
`Promise`\<`void`\>
|
|
26
|
+
|
|
27
|
+
A promise that resolves when the i18n bootstrap process completes.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-localize v19.1.0-dev.
|
|
1
|
+
[**@rxap/ngx-localize v19.1.0-dev.8**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -6,9 +6,13 @@
|
|
|
6
6
|
|
|
7
7
|
# Function: loadLanguages()
|
|
8
8
|
|
|
9
|
-
> **loadLanguages**(`loadModule`, `locale
|
|
9
|
+
> **loadLanguages**(`loadModule`, `locale`?, `preferredLanguages`?, `fallback`?): `Promise`\<`string`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [load-languages.ts:
|
|
11
|
+
Defined in: [load-languages.ts:129](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/load-languages.ts#L129)
|
|
12
|
+
|
|
13
|
+
Loads language translations and sets the locale for the application.
|
|
14
|
+
This function fetches the translations based on the specified locale, preferred languages,
|
|
15
|
+
and a fallback, then initializes the translations and optionally loads additional modules.
|
|
12
16
|
|
|
13
17
|
## Parameters
|
|
14
18
|
|
|
@@ -16,18 +20,28 @@ Defined in: [load-languages.ts:97](https://gitlab.com/rxap/packages/-/blob/e87f6
|
|
|
16
20
|
|
|
17
21
|
(`locale`) => `Promise`\<`void`\>
|
|
18
22
|
|
|
19
|
-
|
|
23
|
+
A function to load additional modules for the specified locale. Defaults to `defaultLoadModule`.
|
|
24
|
+
|
|
25
|
+
### locale?
|
|
20
26
|
|
|
21
27
|
`string` = `...`
|
|
22
28
|
|
|
23
|
-
|
|
29
|
+
The primary locale to be used. Defaults to the stored locale, browser language, or 'en'.
|
|
30
|
+
|
|
31
|
+
### preferredLanguages?
|
|
24
32
|
|
|
25
33
|
`string`[] = `...`
|
|
26
34
|
|
|
27
|
-
|
|
35
|
+
A list of preferred languages to use, derived from the browser or input. Defaults to the browser's preferred languages.
|
|
36
|
+
|
|
37
|
+
### fallback?
|
|
28
38
|
|
|
29
39
|
`string` = `'messages'`
|
|
30
40
|
|
|
41
|
+
The fallback key for translation files. Defaults to 'messages'.
|
|
42
|
+
|
|
31
43
|
## Returns
|
|
32
44
|
|
|
33
45
|
`Promise`\<`string`\>
|
|
46
|
+
|
|
47
|
+
The resolved locale, as a string.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**@rxap/ngx-localize v19.1.0-dev.
|
|
1
|
+
[**@rxap/ngx-localize v19.1.0-dev.8**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -8,7 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
> **xliffToJson**(`translations`): `Promise`\<`any`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [xliff-to-json.ts:
|
|
11
|
+
Defined in: [xliff-to-json.ts:10](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/xliff-to-json.ts#L10)
|
|
12
|
+
|
|
13
|
+
Converts an XLIFF translation string into a JSON object with translation keys and their corresponding values.
|
|
12
14
|
|
|
13
15
|
## Parameters
|
|
14
16
|
|
|
@@ -16,6 +18,10 @@ Defined in: [xliff-to-json.ts:4](https://gitlab.com/rxap/packages/-/blob/e87f625
|
|
|
16
18
|
|
|
17
19
|
`string`
|
|
18
20
|
|
|
21
|
+
A string in XLIFF format containing translations to be parsed and transformed.
|
|
22
|
+
|
|
19
23
|
## Returns
|
|
20
24
|
|
|
21
25
|
`Promise`\<`any`\>
|
|
26
|
+
|
|
27
|
+
A promise that resolves to an object where keys are translation identifiers and values are the corresponding translations in plain text or templated string format.
|
package/docs/markdown/globals.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: ~~I18nService~~
|
|
4
4
|
|
|
5
|
-
Defined in: [i18n.service.ts:15](https://gitlab.com/rxap/packages/-/blob/
|
|
5
|
+
Defined in: [i18n.service.ts:15](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L15)
|
|
6
6
|
|
|
7
7
|
## Deprecated
|
|
8
8
|
|
|
@@ -24,7 +24,7 @@ removed
|
|
|
24
24
|
|
|
25
25
|
> `readonly` **currentLanguage**: `Signal`\<`string`\>
|
|
26
26
|
|
|
27
|
-
Defined in: [i18n.service.ts:20](https://gitlab.com/rxap/packages/-/blob/
|
|
27
|
+
Defined in: [i18n.service.ts:20](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L20)
|
|
28
28
|
|
|
29
29
|
## Methods
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ Defined in: [i18n.service.ts:20](https://gitlab.com/rxap/packages/-/blob/e87f625
|
|
|
32
32
|
|
|
33
33
|
> **redirect**(`next`, `current`): `void`
|
|
34
34
|
|
|
35
|
-
Defined in: [i18n.service.ts:32](https://gitlab.com/rxap/packages/-/blob/
|
|
35
|
+
Defined in: [i18n.service.ts:32](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L32)
|
|
36
36
|
|
|
37
37
|
#### Parameters
|
|
38
38
|
|
|
@@ -54,7 +54,7 @@ Defined in: [i18n.service.ts:32](https://gitlab.com/rxap/packages/-/blob/e87f625
|
|
|
54
54
|
|
|
55
55
|
> **setLanguage**(`language`): `Promise`\<`void`\>
|
|
56
56
|
|
|
57
|
-
Defined in: [i18n.service.ts:22](https://gitlab.com/rxap/packages/-/blob/
|
|
57
|
+
Defined in: [i18n.service.ts:22](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/i18n.service.ts#L22)
|
|
58
58
|
|
|
59
59
|
#### Parameters
|
|
60
60
|
|
|
@@ -2,7 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
# Class: LanguageSelectorService
|
|
4
4
|
|
|
5
|
-
Defined in: [language-selector.service.ts:
|
|
5
|
+
Defined in: [language-selector.service.ts:19](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L19)
|
|
6
|
+
|
|
7
|
+
A service that manages language selection and configuration for the application.
|
|
8
|
+
Provides functionality to retrieve available languages, default language,
|
|
9
|
+
selected language, and dynamically change the application's language settings.
|
|
6
10
|
|
|
7
11
|
## Constructors
|
|
8
12
|
|
|
@@ -20,7 +24,7 @@ Defined in: [language-selector.service.ts:14](https://gitlab.com/rxap/packages/-
|
|
|
20
24
|
|
|
21
25
|
> `readonly` **defaultLanguage**: `Signal`\<`string`\>
|
|
22
26
|
|
|
23
|
-
Defined in: [language-selector.service.ts:
|
|
27
|
+
Defined in: [language-selector.service.ts:23](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L23)
|
|
24
28
|
|
|
25
29
|
***
|
|
26
30
|
|
|
@@ -28,7 +32,7 @@ Defined in: [language-selector.service.ts:18](https://gitlab.com/rxap/packages/-
|
|
|
28
32
|
|
|
29
33
|
> `readonly` **hasLanguages**: `Signal`\<`boolean`\>
|
|
30
34
|
|
|
31
|
-
Defined in: [language-selector.service.ts:
|
|
35
|
+
Defined in: [language-selector.service.ts:26](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L26)
|
|
32
36
|
|
|
33
37
|
***
|
|
34
38
|
|
|
@@ -36,7 +40,7 @@ Defined in: [language-selector.service.ts:21](https://gitlab.com/rxap/packages/-
|
|
|
36
40
|
|
|
37
41
|
> `readonly` **languages**: `Signal`\<`LanguagesConfig`\>
|
|
38
42
|
|
|
39
|
-
Defined in: [language-selector.service.ts:
|
|
43
|
+
Defined in: [language-selector.service.ts:22](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L22)
|
|
40
44
|
|
|
41
45
|
***
|
|
42
46
|
|
|
@@ -44,15 +48,18 @@ Defined in: [language-selector.service.ts:17](https://gitlab.com/rxap/packages/-
|
|
|
44
48
|
|
|
45
49
|
> `readonly` **selectedLanguage**: `WritableSignal`\<`string`\>
|
|
46
50
|
|
|
47
|
-
Defined in: [language-selector.service.ts:
|
|
51
|
+
Defined in: [language-selector.service.ts:24](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L24)
|
|
48
52
|
|
|
49
53
|
## Methods
|
|
50
54
|
|
|
51
55
|
### setLanguage()
|
|
52
56
|
|
|
53
|
-
> **setLanguage**(`language`, `reload
|
|
57
|
+
> **setLanguage**(`language`, `reload`?): `Promise`\<`void`\>
|
|
58
|
+
|
|
59
|
+
Defined in: [language-selector.service.ts:36](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-selector.service.ts#L36)
|
|
54
60
|
|
|
55
|
-
|
|
61
|
+
Sets the application language to the specified value if it exists in the list of supported languages.
|
|
62
|
+
Optionally reloads the page if the `reload` parameter is set to `true`.
|
|
56
63
|
|
|
57
64
|
#### Parameters
|
|
58
65
|
|
|
@@ -60,10 +67,16 @@ Defined in: [language-selector.service.ts:23](https://gitlab.com/rxap/packages/-
|
|
|
60
67
|
|
|
61
68
|
`string`
|
|
62
69
|
|
|
63
|
-
|
|
70
|
+
The language code to set as the active language.
|
|
71
|
+
|
|
72
|
+
##### reload?
|
|
64
73
|
|
|
65
74
|
`boolean` = `false`
|
|
66
75
|
|
|
76
|
+
A flag indicating whether to reload the page after updating the language.
|
|
77
|
+
|
|
67
78
|
#### Returns
|
|
68
79
|
|
|
69
80
|
`Promise`\<`void`\>
|
|
81
|
+
|
|
82
|
+
A promise that resolves once the language has been set and optional reload is completed.
|
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
> **LanguageInterceptor**(`request`, `next`): `Observable`\<`HttpEvent`\<`unknown`\>\>
|
|
6
6
|
|
|
7
|
-
Defined in: [language-interceptor.ts:
|
|
7
|
+
Defined in: [language-interceptor.ts:15](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/language-interceptor.ts#L15)
|
|
8
|
+
|
|
9
|
+
Intercepts an HTTP request to include a localized 'Accept-Language' header, if available.
|
|
8
10
|
|
|
9
11
|
## Parameters
|
|
10
12
|
|
|
@@ -12,10 +14,16 @@ Defined in: [language-interceptor.ts:8](https://gitlab.com/rxap/packages/-/blob/
|
|
|
12
14
|
|
|
13
15
|
`HttpRequest`\<`unknown`\>
|
|
14
16
|
|
|
17
|
+
The HTTP request to be intercepted and optionally modified.
|
|
18
|
+
|
|
15
19
|
### next
|
|
16
20
|
|
|
17
21
|
`HttpHandlerFn`
|
|
18
22
|
|
|
23
|
+
The next handler in the HTTP request pipeline.
|
|
24
|
+
|
|
19
25
|
## Returns
|
|
20
26
|
|
|
21
27
|
`Observable`\<`HttpEvent`\<`unknown`\>\>
|
|
28
|
+
|
|
29
|
+
An observable of the HTTP response event.
|
|
@@ -4,7 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
> **loadI18nBootstrapHook**(`options`): `Promise`\<`void`\>
|
|
6
6
|
|
|
7
|
-
Defined in: [load-i18n-bootstrap-hook.ts:
|
|
7
|
+
Defined in: [load-i18n-bootstrap-hook.ts:13](https://gitlab.com/rxap/packages/-/blob/8c64f6f26a2c8d3b4b24af1e31b0f4274abc83fb/packages/angular/localize/src/lib/load-i18n-bootstrap-hook.ts#L13)
|
|
8
|
+
|
|
9
|
+
Loads internationalization (i18n) bootstrap settings for the application.
|
|
8
10
|
|
|
9
11
|
## Parameters
|
|
10
12
|
|
|
@@ -12,6 +14,10 @@ Defined in: [load-i18n-bootstrap-hook.ts:7](https://gitlab.com/rxap/packages/-/b
|
|
|
12
14
|
|
|
13
15
|
`Partial`\<`ApplicationConfig`\>
|
|
14
16
|
|
|
17
|
+
The application configuration options.
|
|
18
|
+
|
|
15
19
|
## Returns
|
|
16
20
|
|
|
17
21
|
`Promise`\<`void`\>
|
|
22
|
+
|
|
23
|
+
A promise that resolves when the i18n bootstrap process completes.
|