@yiiamee/multilinguist 1.3.0 → 1.3.1

package/README.md

@@ -9,6 +9,7 @@ applications.
 - Works perfectly fine on both SSR + CSR
 - No memory leaks and running out of memory errors
 - Autocompletion & validation of keys
+- Autodetection of browser's locale
 
 ## Installation
 
@@ -49,7 +50,7 @@ Also, on both SSR and CSR, you will see the following message:
 
 It indicated that the module has been initialized successfully.
 
-To disable logs, you can set the logging option in your nuxt.config to false (by default, it is true):
+To disable logs, you can set the `logging` option in your nuxt.config to `false` (by default, it is `true`):
 
 ```nuxt.config.ts
 export default defineNuxtConfig({
@@ -63,6 +64,24 @@ export default defineNuxtConfig({
     },
 })
 ```
+Also, Multilinguist offers a functionality to set the default browser's locale as default if it is available in the supported languages array.
+
+To disable this option, you can set the `setBrowserLanguage` option to `false` as it is `true` by default:
+
+```nuxt.config.ts
+export default defineNuxtConfig({
+    modules: [
+        "@yiiamee/multilinguist",
+    ],
+    multilinguist: {
+        defaultLocale: "en",
+        supportedLanguages: ["en", "es"],
+        logging: false,
+        setBrowserLanguage: false, // by default: true
+    },
+})
+```
+
 
 # Usage
 
@@ -168,4 +187,30 @@ And validation:
   <h6>Current Locale: {{ locale }}</h6>
   <button @click="setLocale('es')">{{ t("Switch Locale") }}</button>
 </template>
+```
+
+### Get locales list
+
+```vue
+
+<script setup lang="ts">
+  const { t, setLocale, locale, locales } = useMultilinguist();
+  // Locales is a computed ref, which value is being set from your nuxt.config
+
+  const pageTitle = computed(() => {
+    return t("Hello, World");
+  });
+</script>
+
+<template>
+  <h3>{{ pageTitle }}</h3>
+  <h6>Current Locale: {{ locale }}</h6>
+  <span
+    v-for="localeItem from locales"
+    :key="localeItem"
+  >
+    | {{ localeItem }} |
+  </span>
+  <button @click="setLocale('es')">{{ t("Switch Locale") }}</button>
+</template>
 ```

package/dist/module.json

@@ -1,14 +1,15 @@
 {
   "name": "@yiiamee/multilinguist",
   "configKey": "multilinguist",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "compatibility": {
     "nuxt": "^3.0.0"
   },
   "defaults": {
     "logging": true,
     "defaultLocale": "",
-    "supportedLanguages": []
+    "supportedLanguages": [],
+    "setBrowserLanguage": true
   },
   "builder": {
     "@nuxt/module-builder": "1.0.1",

package/dist/module.mjs

@@ -82,14 +82,15 @@ const module = defineNuxtModule({
   meta: {
     name: "@yiiamee/multilinguist",
     configKey: "multilinguist",
-    version: "1.3.0",
+    version: "1.3.1",
     compatibility: {
       nuxt: "^3.0.0"
     },
     defaults: {
       logging: true,
       defaultLocale: "",
-      supportedLanguages: []
+      supportedLanguages: [],
+      setBrowserLanguage: true
     }
   },
   setup(moduleOptions, nuxtApp) {
@@ -99,7 +100,8 @@ const module = defineNuxtModule({
     nuxtApp.options.runtimeConfig.public.multilinguist = {
       defaultLocale: moduleOptions.defaultLocale,
       supportedLanguages: moduleOptions.supportedLanguages,
-      logging: typeof moduleOptions.logging === "boolean" ? moduleOptions.logging : true
+      logging: typeof moduleOptions.logging === "boolean" ? moduleOptions.logging : true,
+      setBrowserLanguage: typeof moduleOptions.setBrowserLanguage === "boolean" ? moduleOptions.setBrowserLanguage : true
     };
     nuxtApp.hook("vite:extendConfig", (viteConfig) => {
       viteConfig.plugins = viteConfig.plugins || [];

package/dist/runtime/composables/useLocalization.d.ts

@@ -1,4 +1,4 @@
-import { type Ref } from "vue";
+import { type Ref, type ComputedRef } from "vue";
 import type { LocaleKey } from "../types/generated-locales.js";
 export type TranslationMap = readonly string[];
 export type Locale<T extends TranslationMap> = T[number];
@@ -8,5 +8,6 @@ export type TMultilinguistResponse<T extends TranslationMap> = {
     setLocale: (locale: Locale<T>) => void;
     initLocalization: () => Promise<void>;
     locale: Ref<Locale<T>>;
+    locales: ComputedRef<T>;
 };
-export default function useLocalization<const T extends TranslationMap>(supportedLanguages: T, defaultLocale: Locale<T>): TMultilinguistResponse<T>;
+export default function useLocalization<const T extends TranslationMap>(supportedLanguages: T, defaultLocale: Locale<T>, setBrowserLanguage?: boolean): TMultilinguistResponse<T>;

package/dist/runtime/composables/useLocalization.js

@@ -1,10 +1,10 @@
 import useLocale from "../composables/useLocale.js";
 import { useCookie, useState } from "nuxt/app";
 import { computed, watch } from "vue";
-export default function useLocalization(supportedLanguages, defaultLocale) {
+export default function useLocalization(supportedLanguages, defaultLocale, setBrowserLanguage = true) {
   const { locale: userBrowserLocale } = useLocale(supportedLanguages, defaultLocale);
   const userSelectedLocale = useCookie("multilinguist-locale", {
-    default: () => supportedLanguages.includes(userBrowserLocale.value) ? userBrowserLocale.value : defaultLocale
+    default: () => supportedLanguages.includes(userBrowserLocale.value) && setBrowserLanguage ? userBrowserLocale.value : defaultLocale
   });
   const localeFiles = import.meta.glob("@/public/locales/*.json", { eager: true });
   const loadedLanguages = useState("loaded-languages", () => ({}));
@@ -50,6 +50,9 @@ export default function useLocalization(supportedLanguages, defaultLocale) {
     await loadLocaleMessages(defaultLocale);
     await setLocale(userPrefferableLocale.value);
   };
+  const locales = computed(() => {
+    return supportedLanguages;
+  });
   watch(
     () => locale.value,
     async (val) => {
@@ -62,6 +65,7 @@ export default function useLocalization(supportedLanguages, defaultLocale) {
     t,
     setLocale,
     initLocalization,
-    locale
+    locale,
+    locales
   };
 }

package/dist/runtime/composables/useMultilinguist.d.ts

@@ -1,6 +1,8 @@
+import type { TranslationMap } from "./useLocalization.js";
 export default function useMultilinguist(): {
     t<K extends import("../types/generated-locales.js").LocaleKey>(key: K, variables?: Record<string, string>): string;
     setLocale: (locale: string) => void;
     initLocalization: () => Promise<void>;
     locale: import("vue").Ref<string, string>;
+    locales: import("vue").ComputedRef<TranslationMap>;
 };

package/dist/runtime/plugin.js

@@ -4,11 +4,17 @@ export default defineNuxtPlugin(async (nuxtApp) => {
   const config = nuxtApp.$config.public.multilinguist || {
     defaultLocale: "en",
     supportedLanguages: ["en"],
-    logging: true
+    logging: true,
+    setBrowserLanguage: true
   };
   const supportedLanguages = config.supportedLanguages;
   const defaultLocale = config.defaultLocale;
-  const { initLocalization, ...localizationProperties } = useLocalization(supportedLanguages, defaultLocale);
+  const shouldSetBrowserLanguage = config.setBrowserLanguage;
+  const { initLocalization, ...localizationProperties } = useLocalization(
+    supportedLanguages,
+    defaultLocale,
+    shouldSetBrowserLanguage
+  );
   await initLocalization();
   if (nuxtApp.$config.public.multilinguist.logging) {
     console.log("[multilinguist] is initialised");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yiiamee/multilinguist",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Nuxt Multilinguist module for localizations",
   "repository": "yiiameeMich/multilinguist",
   "license": "MIT",