Skip to content

Beautiful Open-Source Form Builder

Refactor draggable components to use VueDraggable from vue-draggable-… (#907)

Chirag Chhatrala9e71e012bf32
diff --git a/client/components/open/forms/OpenForm.vue b/client/components/open/forms/OpenForm.vue
index 13257e2dd..6e2eb5115 100644
--- a/client/components/open/forms/OpenForm.vue
+++ b/client/components/open/forms/OpenForm.vue
@@ -14,8 +14,8 @@
:key="formPageIndex"
class="form-group flex flex-wrap w-full"
>
- <draggable
- :list="currentFields"
+ <VueDraggable
+ :model-value="currentFields"
group="form-elements"
item-key="id"
class="grid grid-cols-12 relative transition-all w-full"
@@ -26,17 +26,24 @@
filter=".not-draggable"
:animation="200"
:disabled="!allowDragging"
- @change="handleDragDropped"
+ @add="handleDragAdd"
+ @update="handleDragUpdate"
>
- <template #item="{element}">
- <VTransition name="fadeHeight">
- <open-form-field
- :field="element"
- :form-manager="formManager"
- />
- </VTransition>
+ <template #default>
+ <div
+ v-for="element in currentFields"
+ :key="element.id"
+ :class="getFieldWidthClasses(element.width)"
+ >
+ <VTransition name="fadeHeight">
+ <open-form-field
+ :field="element"
+ :form-manager="formManager"
+ />
+ </VTransition>
+ </div>
</template>
- </draggable>
+ </VueDraggable>
</div>
</transition>
@@ -89,7 +96,7 @@
</template>
<script setup>
-import draggable from 'vuedraggable'
+import { VueDraggable } from 'vue-draggable-plus'
import OpenFormButton from './OpenFormButton.vue'
import CaptchaWrapper from '~/components/forms/heavy/components/CaptchaWrapper.vue'
import OpenFormField from './OpenFormField.vue'
@@ -148,25 +155,43 @@ const handleNextClick = () => {
})
}
-const handleDragDropped = (data) => {
- if (!structure.value) return
+const getAbsoluteIndex = (relativeIndex) => {
+ return structure.value.getTargetDropIndex(relativeIndex, state.value.currentPage)
+}
- const getAbsoluteIndex = (relativeIndex) => {
- return structure.value.getTargetDropIndex(relativeIndex, state.value.currentPage)
- }
+const handleDragAdd = (evt) => {
+ if (!structure.value) return
+ const targetIndex = getAbsoluteIndex(evt.newIndex)
+ const payload = evt?.clonedData
+ workingFormStore.addBlock(payload, targetIndex, false)
+}
- if (data.added) {
- const targetIndex = getAbsoluteIndex(data.added.newIndex)
- workingFormStore.addBlock(data.added.element, targetIndex, false)
- }
- if (data.moved) {
- const oldTargetIndex = getAbsoluteIndex(data.moved.oldIndex)
- const newTargetIndex = getAbsoluteIndex(data.moved.newIndex)
+const handleDragUpdate = (evt) => {
+ if (!structure.value) return
+ const oldTargetIndex = getAbsoluteIndex(evt.oldIndex)
+ const newTargetIndex = getAbsoluteIndex(evt.newIndex)
+ if (oldTargetIndex !== newTargetIndex) {
workingFormStore.moveField(oldTargetIndex, newTargetIndex)
}
}
const isProcessing = computed(() => props.formManager.state.isProcessing)
+
+const getFieldWidthClasses = (width) => {
+ if (!width || width === 'full') return 'col-span-full'
+ else if (width === '1/2') {
+ return 'sm:col-span-6 col-span-full'
+ } else if (width === '1/3') {
+ return 'sm:col-span-4 col-span-full'
+ } else if (width === '2/3') {
+ return 'sm:col-span-8 col-span-full'
+ } else if (width === '1/4') {
+ return 'sm:col-span-3 col-span-full'
+ } else if (width === '3/4') {
+ return 'sm:col-span-9 col-span-full'
+ }
+ return 'col-span-full'
+}
</script>
<style lang='scss' scoped>
diff --git a/client/components/open/forms/OpenFormField.vue b/client/components/open/forms/OpenFormField.vue
index 38b2e7c2b..2327d5cfd 100644
--- a/client/components/open/forms/OpenFormField.vue
+++ b/client/components/open/forms/OpenFormField.vue
@@ -5,7 +5,6 @@
ref="form-block"
class="px-2"
:class="[
- getFieldWidthClasses(field),
{
'group/nffield hover:bg-neutral-100/50 relative hover:z-10 transition-colors hover:border-neutral-200 border-dashed border border-transparent box-border dark:hover:border-blue-900 dark:hover:bg-blue-950 rounded-md': isAdminPreview,
'cursor-pointer':workingFormStore.showEditFieldSidebar && isAdminPreview,
@@ -291,21 +290,6 @@ function removeField() {
workingFormStore.removeField(props.field)
}
-function getFieldWidthClasses(field) {
- if (!field.width || field.width === 'full') return 'col-span-full'
- else if (field.width === '1/2') {
- return 'sm:col-span-6 col-span-full'
- } else if (field.width === '1/3') {
- return 'sm:col-span-4 col-span-full'
- } else if (field.width === '2/3') {
- return 'sm:col-span-8 col-span-full'
- } else if (field.width === '1/4') {
- return 'sm:col-span-3 col-span-full'
- } else if (field.width === '3/4') {
- return 'sm:col-span-9 col-span-full'
- }
-}
-
function getFieldAlignClasses(field) {
if (!field.align || field.align === 'left') return 'text-left'
else if (field.align === 'right') {
diff --git a/client/components/open/forms/components/FormFieldsEditor.vue b/client/components/open/forms/components/FormFieldsEditor.vue
index bde203e9c..71b760ee1 100644
--- a/client/components/open/forms/components/FormFieldsEditor.vue
+++ b/client/components/open/forms/components/FormFieldsEditor.vue
@@ -13,15 +13,16 @@
</div>
<div class="p-4">
- <Draggable
+ <VueDraggable
v-model="form.properties"
- item-key="id"
class="mx-auto w-full overflow-hidden rounded-md border border-neutral-300 bg-white transition-colors dark:bg-notion-dark-light"
ghost-class="bg-blue-100"
:animation="200"
>
- <template #item="{ element, index }">
+ <template #default>
<div
+ v-for="(element, index) in form.properties"
+ :key="element.id || index"
class="mx-auto w-full border-neutral-300 transition-colors cursor-grab"
:class="{
'bg-neutral-100 ': element.hidden && !isBeingEdited(index),
@@ -109,20 +110,20 @@
</div>
</div>
</template>
- </Draggable>
+ </VueDraggable>
</div>
</div>
</template>
<script>
-import draggable from 'vuedraggable'
+import { VueDraggable } from 'vue-draggable-plus'
import EditableTag from '~/components/app/EditableTag.vue'
import BlockTypeIcon from './BlockTypeIcon.vue'
export default {
name: 'FormFieldsEditor',
components: {
- Draggable: draggable,
+ VueDraggable,
EditableTag,
BlockTypeIcon
},
diff --git a/client/components/open/forms/components/form-components/AddFormBlock.vue b/client/components/open/forms/components/form-components/AddFormBlock.vue
index bf707787b..c664458d2 100644
--- a/client/components/open/forms/components/form-components/AddFormBlock.vue
+++ b/client/components/open/forms/components/form-components/AddFormBlock.vue
@@ -22,8 +22,8 @@
<p class="text-neutral-500 text-xs font-medium my-2">
Input Blocks
</p>
- <draggable
- :list="inputBlocks"
+ <VueDraggable
+ :model-value="inputBlocks"
:group="{ name: 'form-elements', pull: 'clone', put: false }"
class="flex flex-col -mx-2"
:sort="false"
@@ -33,16 +33,16 @@
@start="workingFormStore.draggingNewBlock=true"
@end="workingFormStore.draggingNewBlock=false"
>
- <template #item="{element}">
+ <template #default>
<div
+ v-for="element in inputBlocks"
+ :key="element.id || element.name"
class="flex hover:bg-neutral-50 rounded-md items-center gap-2 p-2 group"
role="button"
@click.prevent="addBlock(element.name)"
>
<BlockTypeIcon :type="element.name" />
- <p
- class="w-full text-sm text-neutral-500"
- >
+ <p class="w-full text-sm text-neutral-500">
{{ element.title }}
</p>
<Icon
@@ -52,14 +52,14 @@
/>
</div>
</template>
- </draggable>
+ </VueDraggable>
</div>
<div class="px-4 border-t mb-4">
<p class="text-sm font-medium my-2">
Layout Blocks
</p>
- <draggable
- :list="layoutBlocks"
+ <VueDraggable
+ :model-value="layoutBlocks"
:group="{ name: 'form-elements', pull: 'clone', put: false }"
class="flex flex-col -mx-2"
:sort="false"
@@ -69,16 +69,16 @@
@start="workingFormStore.draggingNewBlock=true"
@end="workingFormStore.draggingNewBlock=false"
>
- <template #item="{element}">
+ <template #default>
<div
+ v-for="element in layoutBlocks"
+ :key="element.id || element.name"
class="flex hover:bg-neutral-50 rounded-md items-center gap-2 p-2"
role="button"
@click.prevent="addBlock(element.name)"
>
<BlockTypeIcon :type="element.name" />
- <p
- class="w-full text-sm text-neutral-500"
- >
+ <p class="w-full text-sm text-neutral-500">
{{ element.title }}
</p>
<Icon
@@ -88,13 +88,13 @@
/>
</div>
</template>
- </draggable>
+ </VueDraggable>
</div>
</div>
</template>
<script setup>
-import draggable from 'vuedraggable'
+import { VueDraggable } from 'vue-draggable-plus'
import blocksTypes from '~/data/blocks_types.json'
import BlockTypeIcon from '../BlockTypeIcon.vue'
import AiFieldGenerator from './components/AiFieldGenerator.vue'
diff --git a/client/components/open/tables/components/TableColumnManager.vue b/client/components/open/tables/components/TableColumnManager.vue
index 06a3702e2..8aa22f4f2 100644
--- a/client/components/open/tables/components/TableColumnManager.vue
+++ b/client/components/open/tables/components/TableColumnManager.vue
@@ -49,18 +49,19 @@
/>
</div>
- <draggable
- :list="section.columns"
+ <VueDraggable
+ :model-value="section.columns"
item-key="id"
:ghost-class="['opacity-50', 'bg-blue-50', 'rounded-md']"
:chosen-class="['bg-blue-100', 'rounded-md']"
:animation="200"
group="columns"
:data-section-type="section.type"
- @change="handleDragChange"
+ @add="handleColumnAdd"
+ @update="handleColumnUpdate"
>
- <template #item="{ element: column }">
- <div class="group">
+ <template #default>
+ <div v-for="column in section.columns" :key="column.id" class="group">
<div class="flex items-center gap-1 p-2 rounded-md hover:bg-neutral-50 transition-colors">
<!-- Drag Handle -->
<div class="w-4 h-4 flex items-center justify-center opacity-60 group-hover:opacity-100 transition-opacity">
@@ -128,7 +129,7 @@
</div>
</div>
</template>
- </draggable>
+ </VueDraggable>
</div>
</template>
</ScrollableContainer>
@@ -140,7 +141,7 @@
</template>
<script setup>
-import draggable from 'vuedraggable'
+import { VueDraggable } from 'vue-draggable-plus'
import BlockTypeIcon from '~/components/open/forms/components/BlockTypeIcon.vue'
import ScrollableContainer from '~/components/dashboard/ScrollableContainer.vue'
@@ -232,20 +233,24 @@ const columnSections = computed(() => {
})
// Handle drag end event
-const handleDragChange = async (event) => {
- if (event.added) {
- const columnId = event.added.element.id
- props.tableState.toggleColumnVisibility(columnId)
- await nextTick() // Wait for Vue to process the visibility change
+const handleColumnAdd = async (evt) => {
+ const column = evt.data || evt.clonedData
+ if (!column) return
+ const isVisibleTarget = evt.to?.dataset?.sectionType === 'visible'
+ if (isVisibleTarget) {
+ props.tableState.toggleColumnVisibility(column.id)
+ await nextTick()
+ props.tableState.setColumnOrder(column.id, evt.newIndex)
+ } else {
+ // Moved into hidden
+ props.tableState.toggleColumnVisibility(column.id)
}
+}
- const isNowVisibleAfterAdd = event.added ? props.tableState.columnVisibility.value[event.added.element.id] : undefined
-
- if (event.moved || (event.added && isNowVisibleAfterAdd)) {
- const eventData = event.moved || event.added
- const { element, newIndex } = eventData
- props.tableState.setColumnOrder(element.id, newIndex)
- }
+const handleColumnUpdate = (evt) => {
+ const column = evt.data
+ if (!column) return
+ props.tableState.setColumnOrder(column.id, evt.newIndex)
}
// Get pin icon - now using computed map
diff --git a/client/lib/utils.js b/client/lib/utils.js
index 00affe0f0..89a7fd4c1 100644
--- a/client/lib/utils.js
+++ b/client/lib/utils.js
@@ -148,4 +148,4 @@ export function formatNumberWithCommas(num) {
export function cleanQuotes(str) {
if (!str) return ''
return str.replace(/^"|"$/g, '')
-}
\ No newline at end of file
+}
diff --git a/client/package-lock.json b/client/package-lock.json
index ac0d11d91..e279393cf 100644
--- a/client/package-lock.json
+++ b/client/package-lock.json
@@ -54,11 +54,11 @@
"vue-codemirror": "^6.1.1",
"vue-confetti": "^2.3.0",
"vue-country-flag-next": "^2.3.2",
+ "vue-draggable-plus": "^0.5.6",
"vue-json-pretty": "^2.4.0",
"vue-notion": "^3.0.0",
"vue-signature-pad": "^3.0.2",
"vue-stripe-js": "^1.0.4",
- "vuedraggable": "next",
"webcam-easy": "^1.1.1"
},
"devDependencies": {
@@ -8326,6 +8326,11 @@
"integrity": "sha512-UE7oxhQLLd9gub6JKIAhDq06T0F6FnztwMNRvYgjeQSBeMc1ZG/tA47EwfduvkuQS8apbkM/lpLpWsaCeYsXVg==",
"license": "MIT"
},
+ "node_modules/@types/sortablejs": {
+ "version": "1.15.8",
+ "resolved": "https://registry.npmjs.org/@types/sortablejs/-/sortablejs-1.15.8.tgz",
+ "integrity": "sha512-b79830lW+RZfwaztgs1aVPgbasJ8e7AXtZYHTELNXZPsERt4ymJdjV4OccDbHQAvHrCcFpbF78jkm0R6h/pZVg=="
+ },
"node_modules/@types/tedious": {
"version": "4.0.14",
"resolved": "https://registry.npmjs.org/@types/tedious/-/tedious-4.0.14.tgz",
@@ -21517,6 +21522,22 @@
"integrity": "sha512-RutnB7X8c5hjq39NceArgXg28WZtZpGc3+J16ljMiYnFhKvd8hITxSWQSQ5bvldxMDU6gG5mkxl1MTQLXckVSQ==",
"license": "MIT"
},
+ "node_modules/vue-draggable-plus": {
+ "version": "0.5.6",
+ "resolved": "https://registry.npmjs.org/vue-draggable-plus/-/vue-draggable-plus-0.5.6.tgz",
+ "integrity": "sha512-RMt8YuoB534GH2LD2M60KxHDPtfjfl2C9mH3YSEsfcZBclcoRs5RyrLiEKhUM0QCAQG2T/c3ktHujzxxomqfIw==",
+ "dependencies": {
+ "@types/sortablejs": "^1.15.8"
+ },
+ "peerDependencies": {
+ "@types/sortablejs": "^1.15.0"
+ },
+ "peerDependenciesMeta": {
+ "@vue/composition-api": {
+ "optional": true
+ }
+ }
+ },
"node_modules/vue-eslint-parser": {
"version": "10.2.0",
"resolved": "https://registry.npmjs.org/vue-eslint-parser/-/vue-eslint-parser-10.2.0.tgz",
@@ -21646,24 +21667,6 @@
"integrity": "sha512-TDfbucH1tnKug6VmZvi4xTIB41CN1CH3hC/GfPT/JWraZ4THFQUXk03R46+KY1e5P4fqr0vUzonZhZAUZHRrxg==",
"license": "MIT"
},
- "node_modules/vuedraggable": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/vuedraggable/-/vuedraggable-4.1.0.tgz",
- "integrity": "sha512-FU5HCWBmsf20GpP3eudURW3WdWTKIbEIQxh9/8GE806hydR9qZqRRxRE3RjqX7PkuLuMQG/A7n3cfj9rCEchww==",
- "license": "MIT",
- "dependencies": {
- "sortablejs": "1.14.0"
- },
- "peerDependencies": {
- "vue": "^3.0.1"
- }
- },
- "node_modules/vuedraggable/node_modules/sortablejs": {
- "version": "1.14.0",
- "resolved": "https://registry.npmjs.org/sortablejs/-/sortablejs-1.14.0.tgz",
- "integrity": "sha512-pBXvQCs5/33fdN1/39pPL0NZF20LeRbLQ5jtnheIPN9JQAaufGjKdWduZn4U7wCtVuzKhmRkI0DFYHYRbB2H1w==",
- "license": "MIT"
- },
"node_modules/w3c-keyname": {
"version": "2.2.8",
"resolved": "https://registry.npmjs.org/w3c-keyname/-/w3c-keyname-2.2.8.tgz",
diff --git a/client/package.json b/client/package.json
index 0088ba446..fb18a5766 100644
--- a/client/package.json
+++ b/client/package.json
@@ -83,11 +83,11 @@
"vue-codemirror": "^6.1.1",
"vue-confetti": "^2.3.0",
"vue-country-flag-next": "^2.3.2",
+ "vue-draggable-plus": "^0.5.6",
"vue-json-pretty": "^2.4.0",
"vue-notion": "^3.0.0",
"vue-signature-pad": "^3.0.2",
"vue-stripe-js": "^1.0.4",
- "vuedraggable": "next",
"webcam-easy": "^1.1.1"
},
"eslintIgnore": [