Beautiful Open-Source Form Builder
Add keyboard shortcuts for opening the add field sidebar and enhance block selection in AddFormBlock.vue (#937)
JhumanJ6cbfd3eaa327
diff --git a/client/components/open/forms/components/FormEditor.vue b/client/components/open/forms/components/FormEditor.vueindex befbaa824..18c870cc2 100644--- a/client/components/open/forms/components/FormEditor.vue+++ b/client/components/open/forms/components/FormEditor.vue@@ -205,6 +205,20 @@ const workingFormStore = useWorkingFormStore()const crisp = useCrisp()const amplitude = useAmplitude()+// Keyboard shortcut to open add field sidebar+defineShortcuts({+ meta_b: {+ handler: () => {+ workingFormStore.openAddFieldSidebar()+ }+ },+ ctrl_b: {+ handler: () => {+ workingFormStore.openAddFieldSidebar()+ }+ }+})+// Computed propertiesconst activeTab = computed(() => workingFormStore.activeTab)diff --git a/client/components/open/forms/components/FormFieldsEditor.vue b/client/components/open/forms/components/FormFieldsEditor.vueindex d8bd54a07..9fd1af05b 100644--- a/client/components/open/forms/components/FormFieldsEditor.vue+++ b/client/components/open/forms/components/FormFieldsEditor.vue@@ -1,15 +1,21 @@<template><div class="relative h-[calc(100vh-55px)] overflow-y-auto"><div class="flex gap-2 sticky top-0 bg-white border-b z-10 p-4">- <UButton- color="neutral"- variant="subtle"- icon="i-heroicons-plus"- class="flex-grow justify-center"- @click.prevent="openAddFieldSidebar"+ <UTooltip+ text="Shortcut"+ :kbds="['meta', 'B']"+ arrow>- Add Block- </UButton>+ <UButton+ color="neutral"+ variant="subtle"+ icon="i-heroicons-plus"+ class="flex-grow justify-center"+ @click.prevent="openAddFieldSidebar"+ >+ Add Block+ </UButton>+ </UTooltip></div><div class="p-4">diff --git a/client/components/open/forms/components/form-components/AddFormBlock.vue b/client/components/open/forms/components/form-components/AddFormBlock.vueindex 55f15b7a5..60c6ec3b1 100644--- a/client/components/open/forms/components/form-components/AddFormBlock.vue+++ b/client/components/open/forms/components/form-components/AddFormBlock.vue@@ -1,5 +1,9 @@<template>- <div class="pb-16">+ <div+ class="pb-16"+ @keydown="handleKeydown"+ tabindex="-1"+ ><div class="p-2 border-b border-neutral-300 sticky top-0 z-10 bg-white"><div class="flex items-center"><UButton@@ -20,6 +24,7 @@<div class="py-2 px-4"><UInput+ ref="searchInput"v-model="searchTerm"autofocusvariant="outline"@@ -27,6 +32,10 @@placeholder="Search for a block..."icon="i-heroicons-magnifying-glass-solid":ui="{ trailing: 'pe-1' }"+ @keydown.down.prevent="handleKeydown"+ @keydown.up.prevent="handleKeydown"+ @keydown.enter.prevent="handleKeydown"+ @keydown.esc="handleKeydown"><template v-if="searchTerm?.length" #trailing><UButton@@ -59,11 +68,18 @@><template #default><div- v-for="element in filteredInputBlocks"+ v-for="(element, index) in filteredInputBlocks":key="element.id || element.name"- class="flex hover:bg-neutral-50 rounded-md items-center gap-2 p-2 group"+ :ref="(el) => setBlockRef(el, index)"+ :data-block-index="index"+ :class="[+ 'flex rounded-md items-center gap-2 p-2 group',+ selectedIndex === index ? 'bg-blue-100 dark:bg-blue-900' : 'hover:bg-neutral-50'+ ]"role="button"+ :tabindex="selectedIndex === index ? 0 : -1"@click.prevent="addBlock(element.name)"+ @keydown.enter.prevent="addBlock(element.name)"><BlockTypeIcon :type="element.name" /><p class="w-full text-sm text-neutral-500">@@ -101,11 +117,18 @@><template #default><div- v-for="element in filteredLayoutBlocks"+ v-for="(element, index) in filteredLayoutBlocks":key="element.id || element.name"- class="flex hover:bg-neutral-50 rounded-md items-center gap-2 p-2"+ :ref="(el) => setBlockRef(el, filteredInputBlocks.length + index)"+ :data-block-index="filteredInputBlocks.length + index"+ :class="[+ 'flex rounded-md items-center gap-2 p-2',+ selectedIndex === (filteredInputBlocks.length + index) ? 'bg-blue-100 dark:bg-blue-900' : 'hover:bg-neutral-50'+ ]"role="button"+ :tabindex="selectedIndex === (filteredInputBlocks.length + index) ? 0 : -1"@click.prevent="addBlock(element.name)"+ @keydown.enter.prevent="addBlock(element.name)"><BlockTypeIcon :type="element.name" /><p class="w-full text-sm text-neutral-500">@@ -149,9 +172,6 @@ const allowedBlocks = computed(() => {})})-const inputBlocks = computed(() => allowedBlocks.value.filter(block => !block.name.startsWith('nf-')))-const layoutBlocks = computed(() => allowedBlocks.value.filter(block => block.name.startsWith('nf-')))-const searchTerm = ref('')const normalizedSearch = computed(() => searchTerm.value.trim().toLowerCase())@@ -161,27 +181,140 @@ const fuseOptions = {ignoreLocation: true,includeScore: false,}++// Create a single Fuse instance that's reused+const fuseInstance = computed(() => {+ return new Fuse(allowedBlocks.value, fuseOptions)+})++// Search through all blocks once+const filteredBlocks = computed(() => {+ if (!normalizedSearch.value) return allowedBlocks.value+ return fuseInstance.value.search(normalizedSearch.value).map(r => r.item)+})++// Split filtered results into input and layout blocksconst filteredInputBlocks = computed(() => {- if (!normalizedSearch.value) return inputBlocks.value- return new Fuse(inputBlocks.value, fuseOptions).search(normalizedSearch.value).map(r => r.item)+ return filteredBlocks.value.filter(block => !block.name.startsWith('nf-'))})const filteredLayoutBlocks = computed(() => {- if (!normalizedSearch.value) return layoutBlocks.value- return new Fuse(layoutBlocks.value, fuseOptions).search(normalizedSearch.value).map(r => r.item)+ return filteredBlocks.value.filter(block => block.name.startsWith('nf-'))})+// Combined flat list of all blocks for keyboard navigation+const allFilteredBlocks = computed(() => {+ return [...filteredInputBlocks.value, ...filteredLayoutBlocks.value]+})++const selectedIndex = ref(-1)+const blockRefsMap = new Map()+const searchInput = ref(null)++// Reset selection when search changes+watch([filteredInputBlocks, filteredLayoutBlocks], () => {+ selectedIndex.value = -1+ blockRefsMap.clear()+})++// Set block refs for scrolling+const setBlockRef = (el, index) => {+ if (el) {+ blockRefsMap.set(index, el)+ } else {+ blockRefsMap.delete(index)+ }+}++// Scroll selected block into view+const scrollToSelected = () => {+ nextTick(() => {+ if (selectedIndex.value >= 0) {+ // Try to use ref map first, fallback to querySelector+ const element = blockRefsMap.get(selectedIndex.value) ||+ document.querySelector(`[data-block-index="${selectedIndex.value}"]`)++ if (element) {+ element.scrollIntoView({+ behavior: 'smooth',+ block: 'nearest'+ })+ }+ }+ })+}++// Handle keyboard navigation+const handleKeydown = (event) => {+ const totalBlocks = allFilteredBlocks.value.length++ if (totalBlocks === 0) return++ // Only handle arrow keys, Enter, and Escape+ if (!['ArrowDown', 'ArrowUp', 'Enter', 'Escape'].includes(event.key)) {+ return+ }++ event.preventDefault()+ event.stopPropagation()++ switch (event.key) {+ case 'ArrowDown':+ // If starting from -1, go to 0, otherwise increment+ selectedIndex.value = selectedIndex.value < totalBlocks - 1+ ? selectedIndex.value + 1+ : 0+ scrollToSelected()+ break++ case 'ArrowUp':+ // If at 0 or -1, wrap to last item, otherwise decrement+ selectedIndex.value = selectedIndex.value > 0+ ? selectedIndex.value - 1+ : totalBlocks - 1+ scrollToSelected()+ break++ case 'Enter':+ if (selectedIndex.value >= 0 && selectedIndex.value < totalBlocks.length) {+ const selectedBlock = allFilteredBlocks.value[selectedIndex.value]+ if (selectedBlock) {+ addBlock(selectedBlock.name)+ }+ } else if (totalBlocks > 0) {+ // If no selection, select and add the first block+ selectedIndex.value = 0+ const firstBlock = allFilteredBlocks.value[0]+ if (firstBlock) {+ addBlock(firstBlock.name)+ }+ }+ break++ case 'Escape':+ if (searchTerm.value) {+ searchTerm.value = ''+ selectedIndex.value = -1+ nextTick(() => {+ const inputEl = searchInput.value?.$el?.querySelector('input') || searchInput.value?.$el+ if (inputEl) {+ inputEl.focus()+ }+ })+ }+ break+ }+}+const closeSidebar = () => {workingFormStore.closeAddFieldSidebar()}const addBlock = (type) => {-workingFormStore.addBlock(type)}const handleInputClone = (item) => {-return item.name}diff --git a/client/components/open/forms/components/form-components/FormEditorPreview.vue b/client/components/open/forms/components/form-components/FormEditorPreview.vueindex 2297e0320..221406f8c 100644--- a/client/components/open/forms/components/form-components/FormEditorPreview.vue+++ b/client/components/open/forms/components/form-components/FormEditorPreview.vue@@ -72,7 +72,11 @@v-if="!isExpanded && form && form.presentation_style === 'focused'"class="absolute top-2 right-2 z-20 flex items-center gap-2">- <UTooltip text="Add block">+ <UTooltip+ text="Add block"+ :kbds="['meta', 'B']"+ arrow+ ><UButtonicon="i-heroicons-plus"color="neutral"diff --git a/client/components/open/forms/components/form-components/components/AiFieldGenerator.vue b/client/components/open/forms/components/form-components/components/AiFieldGenerator.vueindex f40b752ac..659497211 100644--- a/client/components/open/forms/components/form-components/components/AiFieldGenerator.vue+++ b/client/components/open/forms/components/form-components/components/AiFieldGenerator.vue@@ -1,7 +1,7 @@<template><div><UPopover v-model:open="isPopoverOpen" arrow :content="popoverContent">- <UTooltip text="Add question with AI">+ <UTooltip text="Add question with AI" arrow><UButtonsize="sm"color="neutral"diff --git a/client/data/blocks_types.json b/client/data/blocks_types.jsonindex 3e989b113..34274bdd0 100644--- a/client/data/blocks_types.json+++ b/client/data/blocks_types.json@@ -251,6 +251,37 @@},"actual_input": "barcode"},+ "password": {+ "name": "password",+ "title": "Password Input",+ "icon": "i-heroicons-key",+ "default_block_name": "Password",+ "bg_class": "bg-blue-100",+ "text_class": "text-blue-900",+ "available_in": ["classic", "focused"],+ "is_input": true,+ "default_values": {+ "secret_input": true,+ "multi_lines": false,+ "max_char_limit": 2000,+ "placeholder": "Enter your password"+ },+ "actual_input": "text"+ },+ "toggle_switch": {+ "name": "toggle_switch",+ "title": "Toggle Switch",+ "icon": "i-heroicons-adjustments-horizontal",+ "default_block_name": "Toggle",+ "bg_class": "bg-red-100",+ "text_class": "text-red-900",+ "available_in": ["classic", "focused"],+ "is_input": true,+ "default_values": {+ "use_toggle_switch": true+ },+ "actual_input": "checkbox"+ },"payment": {"name": "payment","title": "Payment",diff --git a/client/stores/working_form.js b/client/stores/working_form.jsindex d2b4f9cd3..988e72143 100644--- a/client/stores/working_form.js+++ b/client/stores/working_form.js@@ -258,15 +258,17 @@ export const useWorkingFormStore = defineStore("working_form", {newBlock.hidden = falsenewBlock.help_position = "below_input"- // If the type was changed due to actual_input, apply original type's change settings- if (originalBlockDefinition?.actual_input && originalBlockDefinition?.type_change_settings) {- Object.assign(newBlock, originalBlockDefinition.type_change_settings)- }-+ // Apply effective block's default_values (base block defaults)if (effectiveBlockDefinition?.default_values) {Object.assign(newBlock, effectiveBlockDefinition.default_values)}+ // Apply original block's default_values to override effective block defaults when using actual_input+ // (e.g., password secret_input, toggle_switch use_toggle_switch)+ if (originalBlockDefinition?.actual_input && originalBlockDefinition?.default_values) {+ Object.assign(newBlock, originalBlockDefinition.default_values)+ }+const insertIndex = this.determineInsertIndex(index)const newFields = clonedeep(this.content.properties || [])