From 00510820a2794efcadbc83f7f8b54318fe198ecb Mon Sep 17 00:00:00 2001
From: Zéro~Informatique
Date: Tue, 26 Jul 2022 08:44:34 +0200
Subject: viewer: migrate to vue 3, general refactoring and cleanup

Non-exhaustive list of fixes and improvements done at the same time:

- html default background to grey (avoids white flash during init)
- unified links behavior
- added more theme variables
- removed the flex-expand transition (it wasn't working) and replaced it
  with a slide
- fixed LdLoading not centered on the content
- title on removable tags
- fixed an issue with encoded URI from vue-router
- unified Item resource URLs
- removed the iframe for PlainTextViewer (it wasn't working properly)
  and replaced it with a pre
- fixed clear and search buttons tabindex
- fixed the information panel bumping up during the fade animation of
  tag's dropdown
- fixed some focus outlines not appearing correctly
- moved CSS variables to the :root context
- Code cleaning

GitHub: closes #217
GitHub: closes #300
GitHub: closes #297
GitHub: closes #105
GitHub: closes #267
GitHub: closes #275
GitHub: closes #228
GitHub: closes #215
GitHub: closes #112
---
 viewer/src/views/layout/top/LayoutBreadcrumb.vue  | 130 ++++++++++++++++++++++
 viewer/src/views/layout/top/LayoutCommand.vue     | 127 +++++++++++++++++++++
 viewer/src/views/layout/top/LayoutCommandSort.vue | 117 +++++++++++++++++++
 viewer/src/views/layout/top/LayoutTop.vue         |  38 +++++++
 4 files changed, 412 insertions(+)
 create mode 100644 viewer/src/views/layout/top/LayoutBreadcrumb.vue
 create mode 100644 viewer/src/views/layout/top/LayoutCommand.vue
 create mode 100644 viewer/src/views/layout/top/LayoutCommandSort.vue
 create mode 100644 viewer/src/views/layout/top/LayoutTop.vue

(limited to 'viewer/src/views/layout/top')

diff --git a/viewer/src/views/layout/top/LayoutBreadcrumb.vue b/viewer/src/views/layout/top/LayoutBreadcrumb.vue
new file mode 100644
index 0000000..2e70d66
--- /dev/null
+++ b/viewer/src/views/layout/top/LayoutBreadcrumb.vue
@@ -0,0 +1,130 @@
+<!-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2022  Guillaume FOUET
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <div
+    ref="breadcrumb"
+    v-dragscroll.x
+    class="flex scrollbar"
+    :class="$style.ldBreadcrumb"
+  >
+    <div
+      v-show="!arrivedState.left"
+      :class="$style.ldBreadcrumbOverflowMask"
+    />
+    <ul>
+      <li
+        v-for="(item, idx) in currentItemPath"
+        :key="item.path"
+      >
+        <fa-icon
+          v-if="idx > 0"
+          :icon="faAngleRight"
+          class="disabled"
+        />
+        <LdLink
+          :to="item.path"
+        >
+          <fa-icon
+            :icon="navigation.getIcon(item)"
+            size="lg"
+          />
+          {{ item.title }}
+        </LdLink>
+      </li>
+      <li v-if="searchMode">
+        <fa-icon
+          :icon="faAngleRight"
+          class="disabled"
+        />
+        <fa-icon
+          :icon="faSearch"
+          size="lg"
+          class="disabled"
+        />
+      </li>
+    </ul>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { Item } from '@/@types/gallery';
+import LdLink from '@/components/LdLink.vue';
+import { useNavigation } from '@/services/navigation';
+import { faAngleRight, faSearch } from '@fortawesome/free-solid-svg-icons';
+import { useScroll } from '@vueuse/core';
+import { nextTick, onMounted, ref, watch } from 'vue';
+
+const props = defineProps({
+  currentItemPath: { type: Array<Item>, required: true },
+  searchMode: Boolean,
+});
+
+const breadcrumb = ref<HTMLDivElement>();
+
+const navigation = useNavigation();
+const { arrivedState } = useScroll(breadcrumb);
+
+onMounted(() =>
+  watch(() => props.currentItemPath, () => {
+    const div = breadcrumb.value;
+    if (div) nextTick(() => (div.scrollLeft = div.scrollWidth));
+  }, { immediate: true }));
+</script>
+
+<style lang="scss" module>
+@import "~@/assets/scss/theme";
+
+.ldBreadcrumbOverflowMask {
+  position: absolute;
+  width: 100%;
+  height: 100%;
+  background: linear-gradient(
+    to right,
+    rgba($panel-top-bgcolor, 1) $breadcrumb-margins,
+    rgba($panel-top-bgcolor, 0) $breadcrumb-overflow-mask-size
+  );
+  pointer-events: none;
+}
+
+.ldBreadcrumb {
+  ul {
+    display: flex;
+    white-space: nowrap;
+    list-style: none;
+    padding: 2px; // Necessary for the focus outline
+    align-items: center;
+    li {
+      > * {
+        margin-left: $breadcrumb-margins;
+      }
+      > a {
+        padding: $breadcrumb-margins 2px;
+      }
+    }
+  }
+  &:global(.scrollbar) {
+    overflow-y: hidden;
+    scrollbar-width: none;
+    &::-webkit-scrollbar {
+      height: 0;
+    }
+  }
+}
+</style>
diff --git a/viewer/src/views/layout/top/LayoutCommand.vue b/viewer/src/views/layout/top/LayoutCommand.vue
new file mode 100644
index 0000000..8919da3
--- /dev/null
+++ b/viewer/src/views/layout/top/LayoutCommand.vue
@@ -0,0 +1,127 @@
+<!-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2022  Guillaume FOUET
+--               2020       Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <div
+    class="flex"
+    :class="$style.commandBtns"
+  >
+    <LdLink
+      :title="t('command.search.slider')"
+      tabindex="10"
+      @click="uiStore.toggleFullWidth()"
+    >
+      <fa-icon
+        :icon="commandToggleSearchPanelIcon"
+        size="lg"
+      />
+    </LdLink>
+    <LayoutCommandSort :tabindex="20" />
+    <LdLink
+      :class="{ disabled: isEntryPoint(), [$style.commandSecondary]: true }"
+      :title="t('command.back')"
+      tabindex="30"
+      @click="isEntryPoint() || router.back()"
+    >
+      <fa-icon
+        :icon="faArrowLeft"
+        size="lg"
+      />
+    </LdLink>
+    <LdLink
+      :to="parent"
+      :class="{ disabled: isRoot }"
+      :title="t('command.parent')"
+      tabindex="40"
+    >
+      <fa-icon
+        :icon="faFolder"
+        size="xs"
+      />
+      <fa-icon
+        :icon="faLevelUpAlt"
+        size="lg"
+      />
+    </LdLink>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { Item } from '@/@types/gallery';
+import LdLink from '@/components/LdLink.vue';
+import { useUiStore } from '@/store/uiStore';
+import { faAngleDoubleLeft, faArrowLeft, faFolder, faLevelUpAlt, faSearch } from '@fortawesome/free-solid-svg-icons';
+import { computedEager } from '@vueuse/shared';
+import { computed } from 'vue';
+import { useI18n } from 'vue-i18n';
+import { useRoute, useRouter } from 'vue-router';
+import LayoutCommandSort from './LayoutCommandSort.vue';
+
+const props = defineProps({
+  currentItemPath: { type: Array<Item>, required: true },
+});
+
+const { t } = useI18n();
+const route = useRoute();
+const router = useRouter();
+const uiStore = useUiStore();
+
+const commandToggleSearchPanelIcon = computed(() => uiStore.fullWidth ? faSearch : faAngleDoubleLeft);
+const isRoot = computedEager(() => props.currentItemPath.length <= 1 && !uiStore.searchMode);
+const parent = computed(() => {
+  if (uiStore.searchMode) return decodeURIComponent(route.path);
+  const ln = props.currentItemPath.length;
+  if (ln > 1) return props.currentItemPath[ln - 2];
+  return '';
+});
+
+function isEntryPoint() {
+  return history.state?.ldgallery === 'ENTRYPOINT'; // Set by MainLayout.vue
+}
+</script>
+
+<style lang="scss" module>
+@import "~@/assets/scss/theme";
+
+.commandBtns {
+  background-color: $command-buttons-bgcolor;
+  justify-content: space-around;
+  vertical-align: middle;
+  align-items: center;
+  flex: 0 0 $layout-left;
+  user-select: none;
+
+  > a {
+    // normalise icon active boxes
+    width: $layout-top;
+    line-height: calc($layout-top - 4px); // 4px For the focus border
+    text-align: center;
+    vertical-align: middle;
+  }
+
+  @media only screen and (max-width: $tablet) {
+    flex: 0 1;
+
+    > .commandSecondary {
+      display: none;
+    }
+  }
+}
+</style>
diff --git a/viewer/src/views/layout/top/LayoutCommandSort.vue b/viewer/src/views/layout/top/LayoutCommandSort.vue
new file mode 100644
index 0000000..bb9744e
--- /dev/null
+++ b/viewer/src/views/layout/top/LayoutCommandSort.vue
@@ -0,0 +1,117 @@
+<!-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2022  Guillaume FOUET
+--               2020       Pacien TRAN-GIRARD
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <LdLink
+    :title="t('command.sort.title')"
+    :tabindex="props.tabindex"
+    @click="openDropdown"
+  >
+    <fa-icon
+      :icon="faSortAmountDown"
+      size="lg"
+    />
+    <teleport to="body">
+      <Transition name="fade">
+        <div
+          v-if="showDropdown"
+          ref="dropdown"
+          :class="$style.dropdown"
+        >
+          <div
+            v-for="(sort,idx) in itemComparator.ITEM_SORTS"
+            :key="sort.name"
+            :tabindex="props.tabindex + idx + 1"
+            @click="selectedSort=sort"
+            @keypress.enter.space="selectedSort=sort"
+          >
+            <fa-icon :icon="sort.name == selectedSort.name ? faDotCircle : faCircle" />
+            <span v-text="sort.text" />
+          </div>
+        </div>
+      </Transition>
+    </teleport>
+  </LdLink>
+</template>
+
+<script setup lang="ts">
+import LdLink from '@/components/LdLink.vue';
+import { ItemSort, useItemComparator } from '@/services/itemComparator';
+import { useUiStore } from '@/store/uiStore';
+import { faCircle, faDotCircle, faSortAmountDown } from '@fortawesome/free-solid-svg-icons';
+import { onClickOutside, onKeyStroke } from '@vueuse/core';
+import { computed, ref } from 'vue';
+import { useI18n } from 'vue-i18n';
+
+const props = defineProps({
+  tabindex: { type: Number, required: true },
+});
+
+const { t } = useI18n();
+const uiStore = useUiStore();
+const itemComparator = useItemComparator();
+
+const selectedSort = computed({
+  get: () => uiStore.sort,
+  set: (newValue: ItemSort) => (uiStore.sort = newValue),
+});
+
+const showDropdown = ref(false);
+
+const dropdown = ref();
+onClickOutside(dropdown, closeDropdown);
+onKeyStroke('Escape', closeDropdown);
+
+function openDropdown() {
+  showDropdown.value = true;
+}
+function closeDropdown() {
+  setTimeout(() => (showDropdown.value = false));
+}
+</script>
+
+<style lang="scss" module>
+@import "~@/assets/scss/theme";
+
+.dropdown {
+  position: absolute;
+  top: $layout-top;
+  left: 0;
+  z-index: 10;
+  width: $layout-left;
+  color: $input-color;
+  background-color: $dropdown-item-color;
+  padding: 8px 0px;
+  cursor: pointer;
+  > div {
+    padding: 8px 14px;
+    margin: 2px; // For the focus border
+    > span {
+      padding-left: 12px;
+    }
+    &:hover {
+      background-color: $dropdown-item-hover-color;
+    }
+    &:focus {
+      outline: solid 1px $button-active-color;
+    }
+  }
+}
+</style>
diff --git a/viewer/src/views/layout/top/LayoutTop.vue b/viewer/src/views/layout/top/LayoutTop.vue
new file mode 100644
index 0000000..b755c42
--- /dev/null
+++ b/viewer/src/views/layout/top/LayoutTop.vue
@@ -0,0 +1,38 @@
+<!-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2022  Guillaume FOUET
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as
+-- published by the Free Software Foundation, either version 3 of the
+-- License, or (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<template>
+  <div class="flex">
+    <LayoutCommand :current-item-path="galleryStore.currentItemPath" />
+    <LayoutBreadcrumb
+      :current-item-path="galleryStore.currentItemPath"
+      :search-mode="uiStore.searchMode"
+    />
+  </div>
+</template>
+
+<script setup lang="ts">
+import { useGalleryStore } from '@/store/galleryStore';
+import { useUiStore } from '@/store/uiStore';
+import LayoutBreadcrumb from './LayoutBreadcrumb.vue';
+import LayoutCommand from './LayoutCommand.vue';
+
+const uiStore = useUiStore();
+const galleryStore = useGalleryStore();
+</script>
-- 
cgit v1.2.3