Migrate Tutorial Mode (#405)

* dummy migration of tutorial mode * basic tut functionality * enable tut in featuremodel * finally working positioning of bubble * removed useless watcher * removed useless div and watcher * remove margin to finally center the polygon correctly * exit Tutorial when clicking outside of the modal * teleport Tutorial Button to Foooter as in Vue2 Frontend * fix after merge * adapt featuremodeltreetoolbar css selectors * fix: back-continue results in exit * Issue 374- Usability Features (#401) * feat: limits when zooming * feat: fit to View on Mousewheel click * make reset view switch to top down drawing * fix: collapse features rotate triangle * mark rotation as constant and remove dummy rotation for vertical * improve: fit to view after changing direction * adjust triangle alignment to fit exactly to rect --------- Co-authored-by: Pierre Coquet <[email protected]> * Fix: Wrong link should fix login Problem * Fix: Merge Zip and Single into one tab to fix Zip bug. * Feat: UploadZip/UploadBUlk now returns Boolean for Upload Summary * Fix: Fixed Zip Bug finally * Fix: Updload Summary now only pops up when upload successfull * Feat: Designed UploadSummary * Update UploadSummary.vue Added License to Upload Summary Card * Refactor: Refactored code for improved consistency and readability. * Fix: Removed DeleteButton * Feat: Make Tags expandable * Feat: Implemented Sortable Columns Label, Family, Uploaded On * Feat: Allow Searching for FeatureModels * Fix: Show Correct Attributes on FileDetail; Ref #411 * Fix: Fixed File Detail View * Fix: Removed Unnecassary console.log * Feat: Make Tags Expandable for FileDetailView * Feat: Migrate HistoryDetail.vue to Vue3 * FIx: Changed Link * Fix: Removed Owner Sign in Histories * Fix: Fix Search for History View * fix FileDetail import --------- Co-authored-by: Pierre Coquet <[email protected]> Co-authored-by: MeisterSeSe <[email protected]>
OBDDimal · Nov 6, 2023 · 43a7d41 · 43a7d41
1 parent fdc9a83
commit 43a7d41
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 93 deletions.
diff --git a/frontendVue3/src/components/FeatureModel/FeatureModelTreeToolbar.vue b/frontendVue3/src/components/FeatureModel/FeatureModelTreeToolbar.vue
@@ -7,6 +7,7 @@
             absolute
             permanent
             location="start"
+            id="feature-model-toolbar"
         >
             <v-list dense>
                 <v-list-item
@@ -104,6 +105,7 @@
                     :disabled="!isUndoAvailable || !editRights"
                     @click="$emit('undo')"
                     prepend-icon="mdi-undo"
+                    id="feature-model-toolbar-undo"
                 >
                     <v-list-item-title>Undo</v-list-item-title>
                 </v-list-item>
@@ -235,7 +237,7 @@
 
                 <v-list-item
                     @click="$emit('show-tutorial')"
-                    id="tutorial-mode"
+                    id="tutorial-mode-button"
                     prepend-icon="mdi-school"
                 >
                     <v-list-item-title>Tutorial</v-list-item-title>

diff --git a/frontendVue3/src/components/Footer.vue b/frontendVue3/src/components/Footer.vue
@@ -1,5 +1,6 @@
 <template>
     <v-footer
+        id="footer"
         class="mt-8 d-flex py-4 h-auto"
         style="flex: initial"
         :class="smAndDown ? 'flex-column' : 'justify-space-between'"

diff --git a/frontendVue3/src/components/TutorialMode.vue b/frontendVue3/src/components/TutorialMode.vue
@@ -1,6 +1,10 @@
 <template>
-    <v-dialog v-model="showDialog" persistent width="400">
-        <div id="tutorial-dialog">
+    <v-dialog content-class="tutorial-dialog" 
+        v-model="showDialog" 
+        persistent width="400" 
+        @keydown.esc="exit"
+        @click:outside="exit" 
+     >
             <svg
                 v-if="!isMobile && isTop && isLeft"
                 height="50px"
@@ -71,12 +75,8 @@
 
                 <v-card-actions>
                     <v-spacer></v-spacer>
-                    <v-btn text color="error" @click="$emit('close')"
-                        >Close</v-btn
-                    >
-                    <v-btn color="primary" text @click="startTutorial"
-                        >Start Tutorial</v-btn
-                    >
+                    <v-btn text color="error" @click="$emit('close')">Close</v-btn>
+                    <v-btn color="primary" text @click="startTutorial">Start Tutorial</v-btn>
                 </v-card-actions>
             </v-card>
             <svg
@@ -107,20 +107,20 @@
                     "
                 />
             </svg>
-        </div>
     </v-dialog>
 </template>
 
 <script setup>
-import { onMounted, ref, watch } from 'vue';
-
+import { count } from 'd3';
+import { onMounted, ref, computed} from 'vue';
+const DIALOG_SELECTOR= '.tutorial-dialog';
 const step = ref(undefined);
 const beforeSteps = ref([]);
 const isTop = ref(false);
 const isLeft = ref(false);
 const isMobile = ref(false);
 const counter = ref(0);
-
+const emit = defineEmits(['close']);
 const props = defineProps({
     show: Boolean,
     nextSteps: {
@@ -131,13 +131,13 @@ const props = defineProps({
                 title: 'Welcome to the tutorial!',
                 description:
                     'You can restart the tutorial anytime by clicking on this icon on the left.',
-                elementCssSelector: '#tutorial-mode',
+                elementCssSelector: "#tutorial-mode-button",
             },
             {
                 title: 'The menu',
                 description:
-                    "For a more precise description of the menu's icons click on this icon on the left.",
-                elementCssSelector: '#feature-model-toolbar-extend',
+                    "For a more precise description of the menu's icons hover over the menu.",
+                elementCssSelector: '#feature-model-toolbar',
             },
             {
                 title: 'Your feature model',
@@ -213,32 +213,31 @@ onMounted(() => {
 });
 function startTutorial() {
     isMobile.value = 'ontouchstart' in window;
-    step.value = this.nextSteps[this.counter];
+    step.value = props.nextSteps[counter.value];
     counter.value++;
     if (!isMobile.value) {
         setBubblePosition();
     }
 }
 
 function setBubblePosition() {
-    const tutorialDialog = document.querySelector('#tutorial-dialog');
-    if (this.isMobile) {
+    const tutorialDialog = document.querySelector(DIALOG_SELECTOR);
+    if (isMobile.value) {
         tutorialDialog.style.position = 'block';
     } else {
         tutorialDialog.style.position = 'absolute';
     }
-    if (this.step.elementCssSelector) {
+    if (step.value.elementCssSelector) {
+        reset(); /// Reset bubble position until fixed
         const rect = document
-            .querySelector(this.step.elementCssSelector)
+            .querySelector(step.value.elementCssSelector)
             .getBoundingClientRect();
-        const middleX = (rect.left - rect.right) / 2 + rect.right;
+        const middleX = (rect.right - rect.left ) / 2+ rect.left;
         const middleY = (rect.bottom - rect.top) / 2 + rect.top;
-
         tutorialDialog.style.left = null;
         tutorialDialog.style.right = null;
         tutorialDialog.style.top = null;
         tutorialDialog.style.bottom = null;
-
         if (
             middleX + 400 >
             (window.innerWidth || document.documentElement.clientWidth)
@@ -253,9 +252,7 @@ function setBubblePosition() {
             middleY + 200 >
             (window.innerHeight || document.documentElement.clientHeight)
         ) {
-            tutorialDialog.style.bottom = `calc(${
-                window.innerHeight - middleY
-            }px)`;
+            tutorialDialog.style.bottom = `calc(${window.innerHeight - middleY}px)`;
             isTop.value = false;
         } else {
             tutorialDialog.style.top = middleY + 'px';
@@ -265,83 +262,66 @@ function setBubblePosition() {
 }
 
 function nextStep() {
-    if (this.nextSteps.length > this.counter) {
-        this.beforeSteps.unshift(this.step);
-        this.step = this.nextSteps[this.counter];
-        this.counter++;
-        if (!this.isMobile) {
-            this.setBubblePosition();
+    if (props.nextSteps.length > counter.value) {
+        beforeSteps.value.unshift(step.value);
+        step.value = props.nextSteps[counter.value];
+        counter.value++;
+        if (!isMobile.value) {
+            setBubblePosition();
         }
     } else {
-        this.exit();
+        exit();
     }
 }
 
 function exit() {
-    console.log('start');
-    if (!isMobile.value) {
-        const tutorialDialog = document.querySelector('#tutorial-dialog');
-        tutorialDialog.style.left = '';
-        tutorialDialog.style.top = '';
-        tutorialDialog.style.position = '';
-    }
+    reset();
     step.value = undefined;
     beforeSteps.value = [];
-    isTop.value = Boolean;
-    isLeft.value = Boolean;
-    isMobile.value = Boolean;
+    isTop.value = false;
+    isLeft.value = false;
+    isMobile.value = false;
     counter.value = 0;
     localStorage[props.localStorageIdentifier] = true;
-    console.log('midd');
-    this.$emit('close');
-    console.log('end');
+    emit('close');
 }
 
 function beforeStep() {
-    counter.value = counter - 1;
-    //this.nextSteps.unshift(this.step);
+    counter.value = counter.value - 1;
     step.value = beforeSteps.value.shift();
     if (!isMobile.value) {
         setBubblePosition();
     }
 }
 
 function reset() {
-    if (!isMobile.value) {
-        const tutorialDialog = document.querySelector('#tutorial-dialog');
-        tutorialDialog.style.left = 0;
-        tutorialDialog.style.top = 0;
-        tutorialDialog.style.position = 'absolute';
+    try {
+        if (!isMobile.value) {
+            const tutorialDialog = document.querySelector(DIALOG_SELECTOR);
+            if(tutorialDialog){
+                tutorialDialog.style.left = 0;
+                tutorialDialog.style.top = 0;
+                tutorialDialog.style.position = 'fixed';
+            }
+        }
+    } catch (error) {
+        console.error(error);
     }
 }
-
-watch(show, (newValue, oldValue) => {
-    if (oldValue) {
-        /*this.nextSteps = [
-        ...this.beforeSteps.reverse(),
-        this.step,
-        ...this.nextSteps,
-    ];*/
-        step.value = undefined;
-        beforeSteps.value = [];
-        isTop.value = false;
-        isLeft.value = false;
-        isMobile.value = false;
-        counter.value = 0;
-
-        // Reset position to 0 0 when restarting the tutorial again
-        reset();
-    }
+const showDialog = computed(() => {
+    return props.show;
 });
 </script>
 
 <style lang="scss">
-#tutorial-dialog {
+.tutorial-dialog {
     max-width: 400px;
     transition: all 0.75s;
-
     > .v-card {
         margin-top: -10px;
     }
+  }
+  .v-dialog > .v-overlay__content {
+    margin: 0px;
 }
 </style>
diff --git a/frontendVue3/src/views/FeatureModel.vue b/frontendVue3/src/views/FeatureModel.vue
@@ -115,7 +115,11 @@
             @continue-editing="continueEditing"
         >
         </collaboration-continue-editing-dialog>
-
+
+        <tutorial-mode
+                :show="showTutorial"
+                @close="showTutorial = false"
+        ></tutorial-mode>
 
     </div>
 </template>

diff --git a/frontendVue3/src/views/FileDetail.vue b/frontendVue3/src/views/FileDetail.vue
@@ -219,9 +219,9 @@
                 </v-list>
                 <div
                     class="mt-3 d-flex justify-space-between align-center"
-                    id="feature-model-actions"
+
                 >
-                    <div>
+                    <div  id="feature-model-actions">
                         <div class="d-inline-block mr-2">
                             <v-btn
                                 color="primary"
@@ -699,6 +699,7 @@ import { computed, onMounted, reactive, ref, watch } from 'vue';
 import api from '@/services/api.service';
 import { useFileStore } from '@/store/file';
 import { useRouter, useRoute } from 'vue-router';
+import TutorialMode from '@/components/TutorialMode';
 
 const router = useRouter();
 const route = useRoute();

diff --git a/frontendVue3/src/views/Home.vue b/frontendVue3/src/views/Home.vue
@@ -10,29 +10,29 @@
             :items="confirmedFeatureModels"
             :loading="loading"
             :addable="true"
-        />
-        <!--    <tutorial-mode
-      :show="showTutorial"
-      @close="showTutorial = false"
-      :next-steps="tutorialSteps"
-      local-storage-identifier="homeTutorialCompleted"
-    ></tutorial-mode>-->
-        <!--        <v-btn
+        />    
+        <tutorial-mode
+        :show="showTutorial"
+        :next-steps="tutorialSteps"
+        local-storage-identifier="homeTutorialCompleted"
+        @close="showTutorial = false"
+        ></tutorial-mode>
+        <teleport to="footer">
+            <v-btn
             id="tutorial-mode"
-            fab
-            fixed
-            right
-            bottom
             color="primary"
             @click="showTutorial = true"
-        >
-            <v-icon> mdi-school </v-icon>
-        </v-btn>-->
+            >
+                <v-icon> mdi-school </v-icon>
+            </v-btn>
+        </teleport>
+
     </div>
 </template>
 
 <script setup>
 import FeatureModelTable from '@/components/FeatureModelTable.vue';
+import TutorialMode from '@/components/TutorialMode';
 import { onMounted, ref } from 'vue';
 import { storeToRefs } from 'pinia';
 import { useFileStore } from '@/store/file';
@@ -85,7 +85,7 @@ const check2 = false;
 const check3 = false;
 const loading = ref(false);
 const info = '';
-const showTutorial = false;
+const showTutorial = ref(false);
 const tutorialSteps = [
     {
         title: 'Welcome to the tutorial!',