feat(Frontend v2): Viewport Background (#99)

Author: mslaursen

frontend/package-lock.json

@@ -13,6 +13,7 @@
     "format": "prettier --write src/"
   },
   "dependencies": {
+    "@vue-flow/background": "^1.3.2",
     "@vue-flow/core": "^1.45.0",
     "cytoscape": "^3.32.1",
     "pinia": "^3.0.3",

frontend/package.json

@@ -80,6 +80,7 @@ const closeNodeActions = () => {
   border-radius: 6px;
   width: 250px;
   overflow: hidden;
+  background-color: white;
 }
 
 .custom-node-header {

frontend/src/components/schema_editor/CustomNode.vue

@@ -8,19 +8,17 @@
       </div>
 
       <div class="vue-flow-viewport">
+        <div class="toggle-grid-button" @click="showGrid = !showGrid">#</div>
+
         <VueFlow
           v-model:nodes="projectStore.nodes"
           v-model:edges="projectStore.edges"
           :default-viewport="{ zoom: 2 }"
           :max-zoom="2"
           :min-zoom="0.1"
           :fit-view-on-init="true"
-          :snap-to-grid="true"
         >
-          <!-- <Background 
-            variant="lines"
-            style="{z-index: -1}"
-          /> -->
+          <Background v-if="showGrid" variant="lines" :size="51" :gap="51" />
           <div class="create-wrapper">
             <div v-if="showInput" class="floating-create-expanded">
               <button class="collapse-btn" @click="showInput = false">
@@ -82,12 +80,14 @@ import { useProjectStore } from "@/stores/useProjectStore"
 import { VueFlow } from "@vue-flow/core"
 import { useModalStore } from "@/stores/useModalStore"
 import type { RelationalRelationField, RelationalField } from "@/types.types"
+import { Background } from "@vue-flow/background"
 
 const projectStore = useProjectStore()
 const modalStore = useModalStore()
 
 const modelName = ref("")
 const showInput = ref(false)
+const showGrid = ref(false)
 
 const handleCreateClick = () => {
   if (modelName.value.trim() === "") return
@@ -167,6 +167,30 @@ const openEditRelationModal = (id: string, relation: RelationalRelationField) =>
   height: calc(100% - 42px);
 }
 
+.toggle-grid-button {
+  caret-color: transparent;
+  position: absolute;
+  top: 10px;
+  right: 10px;
+  background-color: var(--color-primary);
+  color: black;
+  border: 2px solid black;
+  padding: 3px 6px;
+  font-weight: bold;
+  border-radius: 8px;
+  cursor: pointer;
+  z-index: 10;
+  box-shadow: 2px 2px 0px rgba(0, 0, 0, 1);
+  transition:
+    transform 0.1s ease-out,
+    box-shadow 0.1s;
+}
+
+.toggle-grid-button:hover {
+  box-shadow: 0px 0px 0px rgba(0, 0, 0, 1);
+  transform: translate(2px, 2px);
+}
+
 .create-wrapper {
   position: absolute;
   top: 10px;
@@ -247,6 +271,7 @@ const openEditRelationModal = (id: string, relation: RelationalRelationField) =>
   cursor: pointer;
   font-weight: bold;
 }
+
 .create-model-btn:hover {
   background-color: var(--color-success);
 }