🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
⚡ Lazy load translations, only lang needed
Alicia Sykesbd961027b2b2
diff --git a/docs/multi-language-support.md b/docs/multi-language-support.mdindex 3bb4d659..d055d8b3 100644--- a/docs/multi-language-support.md+++ b/docs/multi-language-support.md@@ -64,27 +64,12 @@ Using [`en.json`](https://github.com/Lissy93/dashy/tree/master/src/assets/locale### 3. Add your file to the app-In [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/tree/master/src/utils/languages.js), you need to do 2 small things:--First import your new translation file, do this at the top of the page.-E.g. `import de from '@/assets/locales/de.json';`--Second, add it to the array of languages, e.g:+In [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/tree/master/src/utils/languages.js), add your language's metadata to the `languages` array:```javascriptexport const languages = [- {- name: 'English',- code: 'en',- locale: en,- flag: '🇬🇧',- },- {- name: 'German', // The name of your language- code: 'de', // The ISO code of your language- locale: de, // The name of the file you imported (no quotes)- flag: '🇩🇪', // An optional flag emoji- },+ { name: 'English', code: 'en', flag: '🇬🇧' },+ { name: 'German', code: 'de', flag: '🇩🇪' }, // The name, ISO code, and flag emoji for your language];```diff --git a/src/App.vue b/src/App.vueindex ff517126..148f1188 100644--- a/src/App.vue+++ b/src/App.vue@@ -21,6 +21,7 @@ import { syncPageMeta } from '@/utils/PageMeta';import { viewFromPath } from '@/utils/config/ConfigHelpers';import { applyTheme } from '@/utils/Theming';import Keys from '@/utils/StoreMutations';+import { loadLocale } from '@/utils/languages';import {localStorageKeys,splashScreenTime,@@ -208,8 +209,14 @@ export default {},/* Fetch or detect users language, then apply it */- applyLanguage() {+ async applyLanguage() {const language = this.getLanguage();+ try {+ const msg = await loadLocale(language);+ this.$i18n.setLocaleMessage(language, msg);+ } catch (e) {+ ErrorHandler(`Failed to load locale '${language}'`, e);+ }this.$store.commit(Keys.SET_LANGUAGE, language);this.$i18n.locale = language;document.getElementsByTagName('html')[0].setAttribute('lang', language);diff --git a/src/components/Settings/LanguageSwitcher.vue b/src/components/Settings/LanguageSwitcher.vueindex ee6e0818..40dd73a0 100644--- a/src/components/Settings/LanguageSwitcher.vue+++ b/src/components/Settings/LanguageSwitcher.vue@@ -33,7 +33,7 @@ import Button from '@/components/FormElements/Button';import SaveConfigIcon from '@/assets/interface-icons/save-config.svg';import ErrorHandler from '@/utils/logging/ErrorHandler';import Keys from '@/utils/StoreMutations';-import { languages } from '@/utils/languages';+import { languages, loadLocale } from '@/utils/languages';import { getUsersLanguage } from '@/utils/config/ConfigHelpers';import { localStorageKeys, modalNames } from '@/utils/config/defaults';@@ -93,20 +93,28 @@ export default {}},/* Save language to local storage, show success msg and close modal */- saveLanguage() {+ async saveLanguage() {const selectedLanguage = this.language;- if (this.checkLocale(selectedLanguage)) {- localStorage.setItem(localStorageKeys.LANGUAGE, selectedLanguage.code);- this.applyLanguageLocally();- this.savedLanguage = selectedLanguage;- const successMsg = `${selectedLanguage.flag} `- + `${this.$t('language-switcher.success-msg')} ${selectedLanguage.name}`;- this.$toast.success(successMsg);- if (!this.miniView) this.$modal.hide(this.modalName);- } else {+ if (!this.checkLocale(selectedLanguage)) {this.$toast.error('Unable to update language');ErrorHandler('Unable to apply language');+ return;+ }+ try {+ const msg = await loadLocale(selectedLanguage.code);+ this.$i18n.setLocaleMessage(selectedLanguage.code, msg);+ } catch (e) {+ this.$toast.error('Unable to update language');+ ErrorHandler(`Failed to load locale '${selectedLanguage.code}'`, e);+ return;}+ localStorage.setItem(localStorageKeys.LANGUAGE, selectedLanguage.code);+ this.applyLanguageLocally();+ this.savedLanguage = selectedLanguage;+ const successMsg = `${selectedLanguage.flag} `+ + `${this.$t('language-switcher.success-msg')} ${selectedLanguage.name}`;+ this.$toast.success(successMsg);+ if (!this.miniView) this.$modal.hide(this.modalName);},/* In miniView, commit immediately on selection (no save button) */onOptionSelected() {diff --git a/src/utils/i18n.js b/src/utils/i18n.jsindex 69a3e044..7aad6ef2 100644--- a/src/utils/i18n.js+++ b/src/utils/i18n.js@@ -1,16 +1,19 @@import { createI18n } from 'vue-i18n';-import { messages } from '@/utils/languages';+import { messages, languages } from '@/utils/languages';import { language as defaultLanguage } from '@/utils/config/defaults';-/**- * Single i18n instance used by the Vue app and shared with non-component- * callers (e.g. the router guard) via the `i18n.global.t(...)` API.- */+// Pre-register every code so `$i18n.availableLocales` lists the full set+// before each locale JSON has been fetched; empty locales fall back to English+const registered = { ...messages };+languages.forEach(({ code }) => {+ if (!registered[code]) registered[code] = {};+});+const i18n = createI18n({legacy: true,locale: defaultLanguage,fallbackLocale: defaultLanguage,- messages,+ messages: registered,});export default i18n;diff --git a/src/utils/languages.js b/src/utils/languages.jsindex 10211495..94471aba 100644--- a/src/utils/languages.js+++ b/src/utils/languages.js@@ -1,248 +1,45 @@-// Locales - Import translation files here! (sort alphabetically)import en from '@/assets/locales/en.json';-import enGB from '@/assets/locales/en-GB.json';-import ar from '@/assets/locales/ar.json';-import bg from '@/assets/locales/bg.json';-import bn from '@/assets/locales/bn.json';-import cs from '@/assets/locales/cs.json';-import da from '@/assets/locales/da.json';-import de from '@/assets/locales/de.json';-import el from '@/assets/locales/el.json';-import es from '@/assets/locales/es.json';-import fr from '@/assets/locales/fr.json';-import hi from '@/assets/locales/hi.json';-import hu from '@/assets/locales/hu.json';-import it from '@/assets/locales/it.json';-import ja from '@/assets/locales/ja.json';-import ko from '@/assets/locales/ko.json';-import ky from '@/assets/locales/ky.json';-import nb from '@/assets/locales/nb.json';-import nl from '@/assets/locales/nl.json';-import pl from '@/assets/locales/pl.json';-import pt from '@/assets/locales/pt.json';-import gl from '@/assets/locales/gl.json';-import ru from '@/assets/locales/ru.json';-import ro from '@/assets/locales/ro.json';-import sk from '@/assets/locales/sk.json';-import sl from '@/assets/locales/sl.json';-import sv from '@/assets/locales/sv.json';-import tr from '@/assets/locales/tr.json';-import uk from '@/assets/locales/uk.json';-import zhCN from '@/assets/locales/zh-CN.json';-import zhTW from '@/assets/locales/zh-TW.json';-import pirate from '@/assets/locales/zz-pirate.json';-// Language data - Next register your language by adding it to this list-// Sorted alphabetically by code (except English which is first, and specials at the end)export const languages = [- {- name: 'English',- code: 'en',- locale: en,- flag: '🇬🇧',- },- { // Real English (just the overides from en.json)- name: 'English (British)',- code: 'en-GB',- locale: enGB,- flag: '🇬🇧',- },- { // Arabic- name: 'العربية',- code: 'ar',- locale: ar,- flag: '🇦🇪',- },- { // Bulgarian- name: 'Български',- code: 'bg',- locale: bg,- flag: '🇧🇬',- },- { // Bengali- name: 'বাংলা',- code: 'bn',- locale: bn,- flag: '🇧🇩',- },- { // Czech- name: 'Čeština',- code: 'cs',- locale: cs,- flag: '🇨🇿',- },- { // Danish- name: 'Dansk',- code: 'da',- locale: da,- flag: '🇩🇰',- },- { // German- name: 'Deutsch',- code: 'de',- locale: de,- flag: '🇩🇪',- },- { // Greek- name: 'Ελληνικά',- code: 'el',- locale: el,- flag: '🇬🇷',- },- { // Spanish- name: 'Español',- code: 'es',- locale: es,- flag: '🇪🇸',- },- {- name: 'Français',- code: 'fr',- locale: fr,- flag: '🇲🇫',- },- { // Hindi- name: 'हिन्दी',- code: 'hi',- locale: hi,- flag: '🇮🇳',- },- { // Hungarian- name: 'Magyar',- code: 'hu',- locale: hu,- flag: '🇭🇺',- },- { // Italian- name: 'Italiano',- code: 'it',- locale: it,- flag: '🇮🇹',- },- { // Japanese- name: '日本語',- code: 'ja',- locale: ja,- flag: '🇯🇵',- },- { // Korean- name: '한국어',- code: 'ko',- locale: ko,- flag: '🇰🇷',- },- { // Kyrgyz- name: 'Кыргызча',- code: 'ky',- locale: ky,- flag: '🇰🇬',- },- { // Norwegian- name: 'Norsk',- code: 'nb',- locale: nb,- flag: '🇳🇴',- },- { // Dutch- name: 'Nederlands',- code: 'nl',- locale: nl,- flag: '🇳🇱',- },- {- name: 'polski',- code: 'pl',- locale: pl,- flag: '🇵🇱',- },- { // Portuguese- name: 'Português',- code: 'pt',- locale: pt,- flag: '🇵🇹',- },- { // Galician- name: 'Galego',- code: 'gl',- locale: gl,- flag: '🛰️',- },- { // Russian- name: 'Русский',- code: 'ru',- locale: ru,- flag: '🇷🇺',- },- { // Romanian- name: 'Romana',- code: 'ro',- locale: ro,- flag: '🇷🇴',- },- { // Slovak- name: 'Slovenčina',- code: 'sk',- locale: sk,- flag: '🇸🇰',- },- {- name: 'Slovenščina',- code: 'sl',- locale: sl,- flag: '🇸🇮',- },- { // Swedish- name: 'Svenska',- code: 'sv',- locale: sv,- flag: '🇸🇪',- },- { // Turkish- name: 'Türkçe',- code: 'tr',- locale: tr,- flag: '🇹🇷',- },- { // Ukrainian- name: 'Ukrainian',- code: 'uk',- locale: uk,- flag: '🇺🇦',- },- { // Chinese- name: '简体中文',- code: 'zh-CN',- locale: zhCN,- flag: '🇨🇳',- },- { // Chinese- name: '繁體中文',- code: 'zh-TW',- locale: zhTW,- flag: '🇹🇼',- },- { // Joke Language - Pirate- name: 'Pirate',- code: 'pirate',- locale: pirate,- flag: '🏴☠️',- },+ { name: 'English', code: 'en', flag: '🇬🇧' },+ { name: 'English (British)', code: 'en-GB', flag: '🇬🇧' },+ { name: 'العربية', code: 'ar', flag: '🇦🇪' },+ { name: 'Български', code: 'bg', flag: '🇧🇬' },+ { name: 'বাংলা', code: 'bn', flag: '🇧🇩' },+ { name: 'Čeština', code: 'cs', flag: '🇨🇿' },+ { name: 'Dansk', code: 'da', flag: '🇩🇰' },+ { name: 'Deutsch', code: 'de', flag: '🇩🇪' },+ { name: 'Ελληνικά', code: 'el', flag: '🇬🇷' },+ { name: 'Español', code: 'es', flag: '🇪🇸' },+ { name: 'Français', code: 'fr', flag: '🇲🇫' },+ { name: 'हिन्दी', code: 'hi', flag: '🇮🇳' },+ { name: 'Magyar', code: 'hu', flag: '🇭🇺' },+ { name: 'Italiano', code: 'it', flag: '🇮🇹' },+ { name: '日本語', code: 'ja', flag: '🇯🇵' },+ { name: '한국어', code: 'ko', flag: '🇰🇷' },+ { name: 'Кыргызча', code: 'ky', flag: '🇰🇬' },+ { name: 'Norsk', code: 'nb', flag: '🇳🇴' },+ { name: 'Nederlands', code: 'nl', flag: '🇳🇱' },+ { name: 'polski', code: 'pl', flag: '🇵🇱' },+ { name: 'Português', code: 'pt', flag: '🇵🇹' },+ { name: 'Galego', code: 'gl', flag: '🛰️' },+ { name: 'Русский', code: 'ru', flag: '🇷🇺' },+ { name: 'Romana', code: 'ro', flag: '🇷🇴' },+ { name: 'Slovenčina', code: 'sk', flag: '🇸🇰' },+ { name: 'Slovenščina', code: 'sl', flag: '🇸🇮' },+ { name: 'Svenska', code: 'sv', flag: '🇸🇪' },+ { name: 'Türkçe', code: 'tr', flag: '🇹🇷' },+ { name: 'Ukrainian', code: 'uk', flag: '🇺🇦' },+ { name: '简体中文', code: 'zh-CN', flag: '🇨🇳' },+ { name: '繁體中文', code: 'zh-TW', flag: '🇹🇼' },+ { name: 'Pirate', code: 'zz-pirate', flag: '🏴☠️' },];-/**- * Include the following info:- * name - Human readable name for your language (e.g German)- * code - ISO language code (e.g. de)- * locale - The file that you imported above- * flag - A nice emoji flag (optional, e.g. 🇩🇪)- */+export const messages = { en };-// All done :)-// You can also add your language to /README.md and credit yourself if you like-// Prepare each language for export-const i18nMessages = {};-languages.forEach((lang) => {- i18nMessages[lang.code] = lang.locale;-});-export const messages = i18nMessages;+export const loadLocale = async (code) => {+ if (code === 'en') return en;+ const mod = await import(`../assets/locales/${code}.json`);+ return mod.default;+};