From e6c2a8d9653ffde924632ca2f260c3a8cddc14ed Mon Sep 17 00:00:00 2001
From: Zero~Informatique
Date: Fri, 11 Sep 2020 00:15:04 +0200
Subject: viewer: item display order

github: resolves #28
---
 viewer/package-lock.json                |  8 +++++
 viewer/package.json                     |  1 +
 viewer/src/assets/scss/theme.scss       |  2 ++
 viewer/src/components/LdCommand.vue     |  1 +
 viewer/src/components/LdCommandSort.vue | 57 +++++++++++++++++++++++++++++++++
 viewer/src/components/LdGallery.vue     |  6 +++-
 viewer/src/locales/en.json              |  4 ++-
 viewer/src/plugins/buefy.ts             |  3 ++
 viewer/src/plugins/fontawesome-icons.ts |  3 ++
 viewer/src/services/itemSortFn.ts       | 28 ++++++++++++++++
 viewer/src/store/galleryStore.ts        |  4 +--
 viewer/src/store/uiStore.ts             |  8 +++++
 viewer/src/views/MainLayout.vue         |  8 +++--
 13 files changed, 127 insertions(+), 6 deletions(-)
 create mode 100644 viewer/src/components/LdCommandSort.vue
 create mode 100644 viewer/src/services/itemSortFn.ts

(limited to 'viewer')

diff --git a/viewer/package-lock.json b/viewer/package-lock.json
index 5898393..6b57e8e 100644
--- a/viewer/package-lock.json
+++ b/viewer/package-lock.json
@@ -1191,6 +1191,14 @@
         "@fortawesome/fontawesome-common-types": "^0.2.30"
       }
     },
+    "@fortawesome/free-regular-svg-icons": {
+      "version": "5.14.0",
+      "resolved": "https://registry.npmjs.org/@fortawesome/free-regular-svg-icons/-/free-regular-svg-icons-5.14.0.tgz",
+      "integrity": "sha512-6LCFvjGSMPoUQbn3NVlgiG4CY5iIY8fOm+to/D6QS/GvdqhDt+xZklQeERdCvVRbnFa1ITc1rJHPRXqkX5wztQ==",
+      "requires": {
+        "@fortawesome/fontawesome-common-types": "^0.2.30"
+      }
+    },
     "@fortawesome/free-solid-svg-icons": {
       "version": "5.14.0",
       "resolved": "https://registry.npmjs.org/@fortawesome/free-solid-svg-icons/-/free-solid-svg-icons-5.14.0.tgz",
diff --git a/viewer/package.json b/viewer/package.json
index 74e0636..892125a 100644
--- a/viewer/package.json
+++ b/viewer/package.json
@@ -15,6 +15,7 @@
   "dependencies": {
     "@fortawesome/fontawesome-svg-core": "1.2.30",
     "@fortawesome/free-solid-svg-icons": "5.14.0",
+    "@fortawesome/free-regular-svg-icons": "5.14.0",
     "@fortawesome/vue-fontawesome": "2.0.0",
     "@types/hammerjs": "2.0.36",
     "@types/marked": "1.1.0",
diff --git a/viewer/src/assets/scss/theme.scss b/viewer/src/assets/scss/theme.scss
index c59eba9..19fe673 100644
--- a/viewer/src/assets/scss/theme.scss
+++ b/viewer/src/assets/scss/theme.scss
@@ -54,6 +54,8 @@ $button-focus-color: $button-color;
 $button-focus-border-color: $link;
 $button-focus-box-shadow-size: 0;
 $body-line-height: 1.5;
+$dropdown-item-color: $palette-900;
+$dropdown-item-active-color: $palette-900;
 
 // Custom components
 
diff --git a/viewer/src/components/LdCommand.vue b/viewer/src/components/LdCommand.vue
index d3705de..6059162 100644
--- a/viewer/src/components/LdCommand.vue
+++ b/viewer/src/components/LdCommand.vue
@@ -23,6 +23,7 @@
     <a class="link" :title="$t('command.search')" @click="$uiStore.toggleFullWidth()">
       <fa-icon :icon="commandToggleSearchPanelIcon" size="lg" />
     </a>
+    <ld-command-sort />
     <a
       :class="{ disabled: isEntryPoint }"
       class="link command-secondary"
diff --git a/viewer/src/components/LdCommandSort.vue b/viewer/src/components/LdCommandSort.vue
new file mode 100644
index 0000000..1d2eac3
--- /dev/null
+++ b/viewer/src/components/LdCommandSort.vue
@@ -0,0 +1,57 @@
+<!-- ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2020  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>
+  <b-dropdown v-model="selectedSort" :mobile-modal="false" append-to-body @change="onChangeSort">
+    <a slot="trigger" class="link">
+      <fa-icon icon="sort-amount-down" size="lg" />
+    </a>
+    <b-dropdown-item v-for="(sort, idx) in SORTS" :key="idx" :value="idx">
+      <fa-icon :icon="['far', idx === selectedSort ? 'dot-circle' : 'circle']" />
+      <span :class="$style.ml1">{{ sort.name }}</span>
+    </b-dropdown-item>
+  </b-dropdown>
+</template>
+
+<script lang="ts">
+import { Component, Vue, Prop } from "vue-property-decorator";
+import { RawLocation } from "vue-router";
+import ItemSortFn from "@/services/itemSortFn";
+
+@Component
+export default class LdCommandSort extends Vue {
+  readonly SORTS = [
+    { name: this.$t("command.sort.byName"), fn: ItemSortFn.sortByName },
+    { name: this.$t("command.sort.byDateDesc"), fn: ItemSortFn.sortByDateDesc },
+  ];
+
+  selectedSort = 0;
+
+  onChangeSort(newValue: number) {
+    this.$uiStore.setSortFn(this.SORTS[newValue].fn);
+  }
+}
+</script>
+
+<style lang="scss" module>
+.ml1 {
+  margin-left: 0.5em;
+}
+</style>
diff --git a/viewer/src/components/LdGallery.vue b/viewer/src/components/LdGallery.vue
index 5a72d99..0c0a43c 100644
--- a/viewer/src/components/LdGallery.vue
+++ b/viewer/src/components/LdGallery.vue
@@ -20,7 +20,7 @@
 <template>
   <ld-error v-if="hasNoResults" icon="search" :message="noresult" />
   <div v-else class="thumbnail-tiles">
-    <router-link v-for="item in items" :key="item.path" :to="item.path">
+    <router-link v-for="item in sortedItems" :key="item.path" :to="item.path">
       <ld-thumbnail :item="item" />
     </router-link>
   </div>
@@ -35,6 +35,10 @@ export default class LdPicture extends Vue {
   @Prop({ type: Array, required: true }) readonly items!: Gallery.Item[];
   @Prop(String) readonly noresult?: string;
 
+  get sortedItems() {
+    return this.items.sort(this.$uiStore.sortFn);
+  }
+
   get hasNoResults(): boolean {
     return Boolean(this.noresult) && this.items.length === 0;
   }
diff --git a/viewer/src/locales/en.json b/viewer/src/locales/en.json
index b36ac57..915f600 100644
--- a/viewer/src/locales/en.json
+++ b/viewer/src/locales/en.json
@@ -17,5 +17,7 @@
   "directory.no-results": "Empty directory",
   "panelLeft.propositions.other": "other filters",
   "panelLeft.information.title": "Information",
-  "tag-propositions.showmore": "show more ({0})"
+  "tag-propositions.showmore": "show more ({0})",
+  "command.sort.byName": "By name",
+  "command.sort.byDateDesc": "By most recent"
 }
diff --git a/viewer/src/plugins/buefy.ts b/viewer/src/plugins/buefy.ts
index 7a71019..4794ad9 100644
--- a/viewer/src/plugins/buefy.ts
+++ b/viewer/src/plugins/buefy.ts
@@ -29,6 +29,8 @@ import Button from "buefy/src/components/button";
 import SnackBar from "buefy/src/components/snackbar";
 // @ts-ignore
 import Tag from "buefy/src/components/tag";
+// @ts-ignore
+import DropDown from "buefy/src/components/dropdown";
 
 import "@/assets/scss/buefy.scss";
 
@@ -37,6 +39,7 @@ Vue.use(Loading);
 Vue.use(Button);
 Vue.use(SnackBar);
 Vue.use(Tag);
+Vue.use(DropDown);
 
 declare module "vue/types/vue" {
   interface Vue {
diff --git a/viewer/src/plugins/fontawesome-icons.ts b/viewer/src/plugins/fontawesome-icons.ts
index 8d136a6..4b50641 100644
--- a/viewer/src/plugins/fontawesome-icons.ts
+++ b/viewer/src/plugins/fontawesome-icons.ts
@@ -39,4 +39,7 @@ export {
   faCaretUp,
   faCaretDown,
   faAngleDoubleDown,
+  faSortAmountDown,
 } from "@fortawesome/free-solid-svg-icons";
+
+export { faCircle, faDotCircle } from "@fortawesome/free-regular-svg-icons";
diff --git a/viewer/src/services/itemSortFn.ts b/viewer/src/services/itemSortFn.ts
new file mode 100644
index 0000000..ec9942c
--- /dev/null
+++ b/viewer/src/services/itemSortFn.ts
@@ -0,0 +1,28 @@
+/* ldgallery - A static generator which turns a collection of tagged
+--             pictures into a searchable web gallery.
+--
+-- Copyright (C) 2019-2020  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/>.
+*/
+
+export default class ItemSortFn {
+  static sortByName(left: Gallery.Item, right: Gallery.Item): number {
+    return left.title.localeCompare(right.title);
+  }
+
+  static sortByDateDesc(left: Gallery.Item, right: Gallery.Item): number {
+    return -left.datetime.localeCompare(right.datetime); // TODO: handle timezones
+  }
+}
diff --git a/viewer/src/store/galleryStore.ts b/viewer/src/store/galleryStore.ts
index 5458f20..768adb6 100644
--- a/viewer/src/store/galleryStore.ts
+++ b/viewer/src/store/galleryStore.ts
@@ -31,7 +31,7 @@ export default class GalleryStore extends VuexModule {
   galleryIndex: Gallery.Index | null = null;
   tagsIndex: Tag.Index = {};
   tagsCategories: Tag.Category[] = [];
-  currentPath: string = "/";
+  currentPath: string | null = null;
   currentSearch: Tag.Search[] = [];
 
   // ---
@@ -64,7 +64,7 @@ export default class GalleryStore extends VuexModule {
 
   get currentItemPath(): Gallery.Item[] {
     const root = this.galleryIndex?.tree;
-    if (root) return Navigation.searchCurrentItemPath(root, this.currentPath);
+    if (root && this.currentPath) return Navigation.searchCurrentItemPath(root, this.currentPath);
     return [];
   }
 
diff --git a/viewer/src/store/uiStore.ts b/viewer/src/store/uiStore.ts
index 91ac338..1fe9f49 100644
--- a/viewer/src/store/uiStore.ts
+++ b/viewer/src/store/uiStore.ts
@@ -18,16 +18,20 @@
 */
 
 import { createModule, mutation, action } from "vuex-class-component";
+import ItemSortFn from "@/services/itemSortFn";
 
 const VuexModule = createModule({
   namespaced: "uiStore",
   strict: true,
 });
 
+type TItemSortFn = (left: Gallery.Item, right: Gallery.Item) => number;
+
 export default class UIStore extends VuexModule {
   fullscreen: boolean = false;
   fullWidth: boolean = window.innerWidth < Number(process.env.VUE_APP_FULLWIDTH_LIMIT);
   searchMode: boolean = false;
+  sortFn: TItemSortFn = ItemSortFn.sortByName;
 
   // ---
 
@@ -42,4 +46,8 @@ export default class UIStore extends VuexModule {
   @mutation toggleSearchMode(value?: boolean) {
     this.searchMode = value ?? !this.searchMode;
   }
+
+  @mutation setSortFn(sortFn: TItemSortFn) {
+    this.sortFn = sortFn;
+  }
 }
diff --git a/viewer/src/views/MainLayout.vue b/viewer/src/views/MainLayout.vue
index 80778f6..21c9cb6 100644
--- a/viewer/src/views/MainLayout.vue
+++ b/viewer/src/views/MainLayout.vue
@@ -20,8 +20,8 @@
 <template>
   <div :class="{ fullscreen: $uiStore.fullscreen, fullwidth: $uiStore.fullWidth }">
     <ld-title :gallery-title="$galleryStore.galleryTitle" :current-item="$galleryStore.currentItem" />
-    <panel-top v-if="!isLoading" class="layout layout-top" />
-    <panel-left v-if="!isLoading" class="layout layout-left" />
+    <panel-top v-if="isReady" class="layout layout-top" />
+    <panel-left v-if="isReady" class="layout layout-left" />
     <router-view v-if="!isLoading" ref="content" class="layout layout-content scrollbar" />
     <b-loading :active="isLoading" is-full-page />
     <ld-key-press :keycode="27" @action="$uiStore.toggleFullscreen(false)" />
@@ -69,6 +69,10 @@ export default class MainLayout extends Vue {
       .catch(this.displayError);
   }
 
+  get isReady() {
+    return !this.isLoading && this.$galleryStore.currentPath !== null;
+  }
+
   displayError(reason: any) {
     this.$buefy.snackbar.open({
       message: `Error ${reason}`,
-- 
cgit v1.2.3