Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

8.6 KB
Raw Blame
<template>
  <div id="dashy" :style="topLevelStyleModifications" :class="[subPageClassName, `view-${currentView}`]">
    <EditModeTopBanner v-if="isEditMode" />
    <LoadingScreen :isLoading="isLoading" v-if="shouldShowSplash" />
    <Header :pageInfo="pageInfo" />
    <router-view v-if="!isFetching" />
    <CriticalError v-if="hasCriticalError" />
    <Footer :text="footerText" v-if="footerVisible && !isFetching" />
    <RemoteConfigLoader v-if="!isFetching" />
  </div>
</template>
<script>

import Header from '@/components/PageStrcture/Header.vue';
import Footer from '@/components/PageStrcture/Footer.vue';
import EditModeTopBanner from '@/components/InteractiveEditor/EditModeTopBanner.vue';
import CriticalError from '@/components/PageStrcture/CriticalError.vue';
import LoadingScreen from '@/components/PageStrcture/LoadingScreen.vue';
import RemoteConfigLoader from '@/components/Configuration/RemoteConfigLoader.vue';
import { welcomeMsg } from '@/utils/logging/CoolConsole';
import ErrorHandler from '@/utils/logging/ErrorHandler';
import { syncPageMeta } from '@/utils/PageMeta';
import { viewFromPath } from '@/utils/config/ConfigHelpers';
import { applyTheme, applyPageStyles } from '@/utils/Theming';
import Keys from '@/utils/StoreMutations';
import { loadLocale } from '@/utils/languages';
import i18n from '@/utils/i18n';
import {
  localStorageKeys,
  splashScreenTime,
  language as defaultLanguage,
} from '@/utils/config/defaults';

export default {
  name: 'app',
  components: {
    Header,
    Footer,
    LoadingScreen,
    EditModeTopBanner,
    CriticalError,
    RemoteConfigLoader,
  },
  data() {
    return {
      isLoading: true, // Set to false after mount complete
    };
  },
  watch: {
    isEditMode(isEditMode) {
      // When in edit mode, show confirmation dialog on page exit
      window.onbeforeunload = isEditMode ? this.confirmExit : null;
    },
    /* Sync document title + description whenever route or loaded config changes */
    metaDeps: {
      handler() { syncPageMeta(this.$route, this.$store); },
      immediate: true,
    },
    /* Apply the effective theme whenever it changes */
    effectiveTheme: {
      immediate: true,
      handler(t) { applyTheme(t, this.appConfig); },
    },
    /* Apply custom CSS, stylesheets and theme, and re-apply on page change for sub-pages */
    '$store.state.currentConfigInfo.confId': {
      immediate: true,
      handler() {
        applyPageStyles(this.appConfig);
        applyTheme(this.effectiveTheme, this.appConfig);
      },
    },
    /* Keep i18n in sync with the active page's language (incl. sub-page overrides) */
    'appConfig.language': {
      immediate: true,
      handler(lang) {
        if (!lang) return;
        this.$i18n.locale = lang;
        document.documentElement.setAttribute('lang', lang);
      },
    },
  },
  computed: {
    /* If the user has specified custom text for footer - get it */
    footerText() {
      return this.pageInfo && this.pageInfo.footer ? this.pageInfo.footer : '';
    },
    currentView() {
      return viewFromPath(this.$route.path);
    },
    /* Footer renders only when there's text AND we're not on workspace */
    footerVisible() {
      if (this.currentView === 'workspace') return false;
      return !!this.footerText;
    },
    /* Determine if splash screen should be shown */
    shouldShowSplash() {
      return (this.appConfig.showSplashScreen);
    },
    /* True until the root config has finished its initial load (or critically failed) */
    isFetching() {
      return !this.$store.state.rootConfig && !this.$store.state.criticalError;
    },
    /* Route-declared themes (e.g. 404) win over the user's saved theme */
    effectiveTheme() {
      return this.$route?.meta?.theme || this.$store.getters.theme;
    },
    appConfig() {
      return this.$store.getters.appConfig;
    },
    pageInfo() {
      return this.$store.getters.pageInfo;
    },
    sections() {
      return this.$store.getters.sections;
    },
    visibleComponents() {
      return this.$store.getters.visibleComponents;
    },
    isEditMode() {
      return this.$store.state.editMode;
    },
    hasCriticalError() {
      return this.$store.state.criticalError;
    },
    subPageClassName() {
      return this.$store.state.currentConfigInfo?.confId || '';
    },
    /* Dep tuple so the metaDeps watcher tracks every reactive input */
    metaDeps() {
      return [this.$route.fullPath, this.pageInfo, this.sections];
    },
    topLevelStyleModifications() {
      const vc = this.visibleComponents;
      let styles = '';
      if (!this.footerVisible && !vc.pageTitle) styles += '--footer-height: 1rem;';
      else if (!this.footerVisible) styles += '--footer-height: 5rem;';
      else if (!vc.pageTitle) styles += '--footer-height: 4rem;';
      const maxWidth = this.parseContentMaxWidth(this.appConfig.contentMaxWidth);
      if (maxWidth) {
        styles += `--content-max-width: ${maxWidth};`;
      }
      return styles;
    },
  },
  methods: {
    /* Parse appConfig.contentMaxWidth into valid CSS unit */
    parseContentMaxWidth(usersCmw) {
      if (usersCmw === undefined || usersCmw === null || usersCmw === '') return null;
      const maxWidthStr = String(usersCmw).trim();
      if (/^\d+(\.\d+)?$/.test(maxWidthStr)) {
        return Number(maxWidthStr) <= 100 ? `${maxWidthStr}%` : `${maxWidthStr}px`;
      }
      if (/^\d+(\.\d+)?(%|px|rem|em|vw|vh)$/.test(maxWidthStr)) return maxWidthStr;
      ErrorHandler(`Invalid contentMaxWidth value: '${usersCmw}'`);
      return null;
    },
    /* Hide splash screen, either after 2 seconds, or immediately based on user preference */
    hideSplash() {
      if (this.shouldShowSplash) {
        setTimeout(() => { this.isLoading = false; }, splashScreenTime || 1000);
      } else {
        this.isLoading = false;
      }
    },

    /* Case-insensitive lookup that returns the canonical locale code, or undefined */
    resolveLocale(availibleLocales, userLang) {
      if (!userLang) return undefined;
      const target = userLang.toLowerCase();
      return availibleLocales.find((lang) => lang.toLowerCase() === target);
    },

    /* Auto-detects users language from browser/ os, when not specified */
    autoDetectLanguage(availibleLocales) {
      const usersBorwserLang1 = window.navigator.language || ''; // e.g. en-GB or or ''
      const usersBorwserLang2 = usersBorwserLang1.split('-')[0]; // e.g. en or undefined
      const usersSpairLangs = window.navigator.languages || []; // e.g [en, en-GB, en-US]
      return this.resolveLocale(availibleLocales, usersBorwserLang1)
        || this.resolveLocale(availibleLocales, usersBorwserLang2)
        || usersSpairLangs.map((spair) => this.resolveLocale(availibleLocales, spair)).find(Boolean)
        || defaultLanguage;
    },

    /* Get users language, if not available then call auto-detect */
    getLanguage() {
      const availibleLocales = this.$i18n.availableLocales; // All available locales
      const usersLang = localStorage[localStorageKeys.LANGUAGE] || this.appConfig.language;
      if (usersLang) {
        const resolved = this.resolveLocale(availibleLocales, usersLang);
        if (resolved) return resolved;
        ErrorHandler(`Unsupported Language: '${usersLang}'`);
      }
      return this.autoDetectLanguage(availibleLocales);
    },

    /* Fetch or detect users language, then apply it */
    async applyLanguage() {
      const language = this.getLanguage();
      try {
        const msg = await loadLocale(language);
        i18n.global.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);
    },
    /* If placeholder element still visible, hide it */
    hideLoader() {
      const loader = document.getElementById('loader');
      if (loader) loader.style.display = 'none';
    },
    /* Called when in edit mode and navigating away from page */
    confirmExit(e) {
      e.preventDefault();
      return 'You may have unsaved edits. Are you sure you want to exit the page?';
    },
  },
  /* Basic initialization tasks on app load. Config is already loaded by router.beforeEach. */
  mounted() {
    this.applyLanguage();
    this.hideSplash();
    this.hideLoader();
    welcomeMsg();
  },
};
</script>

<style lang="scss">
/* Import styles used globally throughout the app */
@import '@/styles/global-styles.scss';
@import '@/styles/color-palette.scss';
@import '@/styles/dimensions.scss';
@import '@/styles/color-themes.scss';
@import '@/styles/typography.scss';
@import '@/styles/user-defined-themes.scss';

</style>