Skip to content

Beautiful Open-Source Form Builder

Add support for video fields and enhance media embedding functionality (#916)

Chirag Chhatrala9338d26e5985
diff --git a/api/app/Rules/FormPropertyLogicRule.php b/api/app/Rules/FormPropertyLogicRule.php
index a3879123b..59b9b8eed 100644
--- a/api/app/Rules/FormPropertyLogicRule.php
+++ b/api/app/Rules/FormPropertyLogicRule.php
@@ -177,7 +177,7 @@ class FormPropertyLogicRule implements DataAwareRule, ValidationRule
foreach ($actions as $val) {
if (
!in_array($val, static::ACTIONS_VALUES) ||
- (in_array($this->field['type'], ['nf-text', 'nf-code', 'nf-page-break', 'nf-divider', 'nf-image']) && !in_array($val, ['hide-block', 'show-block'])) ||
+ (in_array($this->field['type'], ['nf-text', 'nf-code', 'nf-page-break', 'nf-divider', 'nf-image', 'nf-video']) && !in_array($val, ['hide-block', 'show-block'])) ||
(isset($this->field['hidden']) && $this->field['hidden'] && !in_array($val, ['show-block', 'require-answer'])) ||
(isset($this->field['required']) && $this->field['required'] && !in_array($val, ['make-it-optional', 'hide-block', 'disable-block'])) ||
(isset($this->field['disabled']) && $this->field['disabled'] && !in_array($val, ['enable-block', 'require-answer', 'make-it-optional']))
diff --git a/api/app/Service/AI/Prompts/Form/FormFieldSchemas.php b/api/app/Service/AI/Prompts/Form/FormFieldSchemas.php
index a7583bf9a..46b7db53f 100644
--- a/api/app/Service/AI/Prompts/Form/FormFieldSchemas.php
+++ b/api/app/Service/AI/Prompts/Form/FormFieldSchemas.php
@@ -362,6 +362,15 @@ class FormFieldSchemas
'core' => ['$ref' => '#/definitions/baseProperty'],
]
],
+ 'nfVideoProperty' => [
+ 'type' => 'object',
+ 'required' => ['core', 'type'],
+ 'additionalProperties' => false,
+ 'properties' => [
+ 'type' => ['type' => 'string', 'enum' => ['nf-video']],
+ 'core' => ['$ref' => '#/definitions/baseProperty'],
+ ]
+ ],
'nfCodeProperty' => [
'type' => 'object',
'required' => ['core', 'type'],
diff --git a/api/app/Service/AI/Prompts/Form/GenerateFormFieldsPrompt.php b/api/app/Service/AI/Prompts/Form/GenerateFormFieldsPrompt.php
index 7244ef292..e4db22e53 100644
--- a/api/app/Service/AI/Prompts/Form/GenerateFormFieldsPrompt.php
+++ b/api/app/Service/AI/Prompts/Form/GenerateFormFieldsPrompt.php
@@ -93,6 +93,7 @@ class GenerateFormFieldsPrompt extends Prompt
['$ref' => '#/definitions/nfPageBreakProperty'],
['$ref' => '#/definitions/nfDividerProperty'],
['$ref' => '#/definitions/nfImageProperty'],
+ ['$ref' => '#/definitions/nfVideoProperty'],
['$ref' => '#/definitions/nfCodeProperty']
]
]
@@ -173,6 +174,7 @@ class GenerateFormFieldsPrompt extends Prompt
'nf-page-break' => 'nf-page-break: Page break for multi-page forms',
'nf-divider' => 'nf-divider: Visual divider (not an input field)',
'nf-image' => 'nf-image: Image element',
+ 'nf-video' => 'nf-video: Video element',
'nf-code' => 'nf-code: Code block',
];
diff --git a/api/app/Service/AI/Prompts/Form/GenerateFormPrompt.php b/api/app/Service/AI/Prompts/Form/GenerateFormPrompt.php
index 2e555ad41..45cea8fde 100644
--- a/api/app/Service/AI/Prompts/Form/GenerateFormPrompt.php
+++ b/api/app/Service/AI/Prompts/Form/GenerateFormPrompt.php
@@ -125,6 +125,7 @@ class GenerateFormPrompt extends Prompt
['$ref' => '#/definitions/nfPageBreakProperty'],
['$ref' => '#/definitions/nfDividerProperty'],
['$ref' => '#/definitions/nfImageProperty'],
+ ['$ref' => '#/definitions/nfVideoProperty'],
['$ref' => '#/definitions/nfCodeProperty']
]
]
@@ -218,6 +219,7 @@ class GenerateFormPrompt extends Prompt
'nf-page-break' => 'nf-page-break: Page break for multi-page forms',
'nf-divider' => 'nf-divider: Visual divider (not an input field)',
'nf-image' => 'nf-image: Image element',
+ 'nf-video' => 'nf-video: Video element',
'nf-code' => 'nf-code: Code block',
];
diff --git a/api/app/Service/Forms/FormSubmissionFormatter.php b/api/app/Service/Forms/FormSubmissionFormatter.php
index 237f84c60..a6373f01d 100644
--- a/api/app/Service/Forms/FormSubmissionFormatter.php
+++ b/api/app/Service/Forms/FormSubmissionFormatter.php
@@ -4,6 +4,8 @@ namespace App\Service\Forms;
use App\Models\Forms\Form;
use Carbon\Carbon;
+use Illuminate\Support\Str;
+use Illuminate\Support\Facades\URL;
class FormSubmissionFormatter
{
@@ -112,22 +114,18 @@ class FormSubmissionFormatter
$fields = $fields->merge($removeFields);
}
$fields = $fields->filter(function ($field) {
- return !in_array($field['type'], ['nf-text', 'nf-code', 'nf-page-break', 'nf-divider', 'nf-image']);
+ return !Str::of($field['type'])->startsWith('nf-');
})->values();
$returnArray = [];
foreach ($fields as $field) {
- if (in_array($field['id'], ['nf-text', 'nf-code', 'nf-page-break', 'nf-divider', 'nf-image'])) {
- continue;
- }
-
if ($field['removed'] ?? false) {
$field['name'] = $field['name'] . ' (deleted)';
}
// Add ID to avoid name clashes
- $field['name'] = $field['name'] . ' (' . \Str::of($field['id']) . ')';
+ $field['name'] = $field['name'] . ' (' . Str::of($field['id']) . ')';
// If not present skip
if (!isset($data[$field['id']])) {
@@ -255,7 +253,7 @@ class FormSubmissionFormatter
return [
'unsigned_url' => route('open.forms.submissions.file', [$formId, $file]),
'signed_url' => $this->getFileUrl($formId, $file),
- 'label' => \Str::limit($file, 20, '[...].' . end($splitText)),
+ 'label' => Str::limit($file, 20, '[...].' . end($splitText)),
];
})->toArray();
} else {
@@ -296,7 +294,7 @@ class FormSubmissionFormatter
private function getFileUrl($formId, $file)
{
try {
- return $this->useSignedUrlForFiles ? \URL::signedRoute(
+ return $this->useSignedUrlForFiles ? URL::signedRoute(
'open.forms.submissions.file',
[$formId, $file]
) : route('open.forms.submissions.file', [$formId, $file]);
diff --git a/client/components/forms/heavy/components/EmbedMedia.vue b/client/components/forms/heavy/components/EmbedMedia.vue
new file mode 100644
index 000000000..526b7760b
--- /dev/null
+++ b/client/components/forms/heavy/components/EmbedMedia.vue
@@ -0,0 +1,97 @@
+<template>
+ <div class="w-full">
+ <div v-if="descriptor">
+ <div v-if="descriptor.kind === 'iframe'" :class="wrapperClasses">
+ <iframe
+ :src="descriptor.src"
+ v-bind="iframeAttrs"
+ class="w-full h-full"
+ :class="roundedClass"
+ sandbox="allow-scripts allow-same-origin allow-popups allow-forms"
+ />
+ </div>
+
+ <div v-else-if="descriptor.kind === 'video'" :class="wrapperClasses">
+ <video
+ :src="descriptor.src"
+ class="w-full h-full"
+ :class="roundedClass"
+ controls
+ />
+ </div>
+
+ <div v-else-if="descriptor.kind === 'audio'">
+ <audio :src="descriptor.src" class="w-full" controls />
+ </div>
+
+ <div v-else-if="descriptor.kind === 'image'" :class="['inline-block', 'max-w-full']">
+ <img :src="descriptor.src" :alt="descriptor.title || ''" :class="[roundedClass, 'max-w-full']" />
+ </div>
+
+ <div v-else>
+ <a :href="src" target="_blank" rel="noopener" class="text-blue-600 underline">{{ src }}</a>
+ </div>
+ </div>
+
+ <div v-else>
+ <div class="p-4 border border-dashed text-center text-neutral-500">
+ Invalid or unsupported media URL.
+ </div>
+ </div>
+ </div>
+</template>
+
+<script setup>
+import { resolveEmbed } from 'embedkit'
+
+const props = defineProps({
+ src: { type: String, required: true },
+ isDark: { type: Boolean, default: false },
+ preferLang: { type: String, default: 'en' }
+})
+
+const result = computed(() => {
+ if (!props.src) return null
+ try {
+ const options = {
+ preferLang: props.preferLang,
+ theme: props.isDark ? 'dark' : 'light'
+ }
+ if (process.client && typeof location !== 'undefined') {
+ options.hostname = location.hostname
+ }
+ const res = resolveEmbed(props.src, options)
+ return res.ok ? res : null
+ } catch (error) {
+ console.error('Failed to resolve embed', error)
+ return null
+ }
+})
+
+const descriptor = computed(() => result.value?.descriptor || null)
+
+const iframeAttrs = computed(() => {
+ if (!descriptor.value || descriptor.value.kind !== 'iframe') return {}
+ return descriptor.value.attrs || {}
+})
+
+const aspectClass = computed(() => {
+ const ratio = descriptor.value?.aspectRatio || 'auto'
+ if (ratio === '16:9') return 'aspect-video'
+ if (ratio === '9:16') return 'aspect-[9/16]'
+ if (ratio === '4:3') return 'aspect-[4/3]'
+ if (ratio === '1:1') return 'aspect-square'
+ return 'aspect-auto'
+})
+
+const wrapperClasses = computed(() => ['w-full', aspectClass.value])
+
+const injectedBorderRadius = inject('formBorderRadius', null)
+const resolvedBorderRadius = computed(() => injectedBorderRadius?.value || 'small')
+const roundedClass = computed(() => {
+ const map = { none: 'rounded-none', small: 'rounded-lg', full: 'rounded-[20px]' }
+ return map[resolvedBorderRadius.value] || 'rounded-lg'
+})
+</script>
+
+
diff --git a/client/components/open/forms/BlockRenderer.vue b/client/components/open/forms/BlockRenderer.vue
index aac2e2248..2d871d83a 100644
--- a/client/components/open/forms/BlockRenderer.vue
+++ b/client/components/open/forms/BlockRenderer.vue
@@ -42,10 +42,10 @@
class="border-b my-4 w-full mx-2"
/>
<div
- v-else-if="block.type === 'nf-image'"
+ v-else-if="block.type === 'nf-image' && (isAdminPreview || (!isAdminPreview && block.image_block))"
:id="block.id"
:key="block.id"
- class="my-4 w-full px-2"
+ class="my-4 w-full"
:class="[getFieldAlignClasses(block)]"
@dblclick="editFieldOptions"
>
@@ -63,9 +63,34 @@
v-else
:alt="block.name"
:src="block.image_block"
- class="max-w-full inline-block rounded-lg"
+ class="max-w-full inline-block"
+ :class="roundedClass"
>
</div>
+ <div
+ v-if="block.type === 'nf-video' && (isAdminPreview || (!isAdminPreview && block.video_block))"
+ :id="block.id"
+ :key="block.id"
+ class="my-4 w-full"
+ :class="[getFieldAlignClasses(block)]"
+ @dblclick="editFieldOptions"
+ >
+ <div
+ v-if="!block.video_block"
+ class="p-4 border border-dashed text-center"
+ >
+ <a
+ href="#"
+ class="text-blue-800 dark:text-blue-200"
+ @click.prevent="editFieldOptions"
+ >Open block settings to add video URL.</a>
+ </div>
+ <EmbedMedia
+ v-else
+ :src="block.video_block"
+ :is-dark="darkMode"
+ />
+ </div>
</div>
</template>
@@ -85,6 +110,7 @@ const form = computed(() => props.formManager?.config?.value || {})
const dataForm = computed(() => props.formManager?.form || {})
const darkMode = computed(() => props.formManager?.darkMode?.value || false)
const strategy = computed(() => props.formManager?.strategy?.value || {})
+const isAdminPreview = computed(() => strategy.value?.admin?.showAdminControls || false)
// Use centralized fieldState from manager
const fieldState = computed(() => props.formManager?.fieldState)
@@ -160,6 +186,16 @@ const shouldInjectBetweenMedia = computed(() => (
!(strategy.value?.display?.forceClassicPresentation === true)
))
+const roundedClass = computed(() => {
+ const radius = form.value?.border_radius || 'small'
+ const map = {
+ none: 'rounded-none',
+ small: 'rounded-lg',
+ full: 'rounded-[20px]'
+ }
+ return map[radius] || 'rounded-lg'
+})
+
const boundProps = computed(() => {
const field = props.block
if (!field) return {}
diff --git a/client/components/open/forms/components/form-logic-components/FormBlockLogicEditor.vue b/client/components/open/forms/components/form-logic-components/FormBlockLogicEditor.vue
index cc2a6ebb9..487b0b804 100644
--- a/client/components/open/forms/components/form-logic-components/FormBlockLogicEditor.vue
+++ b/client/components/open/forms/components/form-logic-components/FormBlockLogicEditor.vue
@@ -265,6 +265,7 @@ export default {
"nf-page-break",
"nf-divider",
"nf-image",
+ "nf-video",
].includes(this.field.type)
) {
if (this.field.hidden) {
diff --git a/client/components/open/forms/fields/components/BlockOptions.vue b/client/components/open/forms/fields/components/BlockOptions.vue
index 028530781..d58f06e97 100644
--- a/client/components/open/forms/fields/components/BlockOptions.vue
+++ b/client/components/open/forms/fields/components/BlockOptions.vue
@@ -40,7 +40,7 @@
:columns="6"
/>
<OptionSelectorInput
- v-if="['nf-text', 'nf-image'].includes(field.type)"
+ v-if="['nf-text', 'nf-image', 'nf-video'].includes(field.type)"
v-model="field.align"
name="align"
class="mt-4 w-2/3"
@@ -108,6 +108,19 @@
:required="false"
/>
</div>
+
+ <div
+ v-else-if="field.type == 'nf-video'"
+ class="border-t mt-4"
+ >
+ <TextInput
+ name="video_block"
+ class="mx-4"
+ :form="field"
+ label="Video URL"
+ help="You can add a video URL here. It will be displayed as a video block."
+ />
+ </div>
<div
v-else-if="field.type == 'nf-code'"
diff --git a/client/composables/components/tables/useTableState.js b/client/composables/components/tables/useTableState.js
index 3854004c5..8f7a6bfc8 100644
--- a/client/composables/components/tables/useTableState.js
+++ b/client/composables/components/tables/useTableState.js
@@ -24,7 +24,7 @@ export function useTableState(form, withActions = false) {
const baseColumns = form.value.properties
.filter((field) => {
- return !['nf-text', 'nf-code', 'nf-page-break', 'nf-divider', 'nf-image'].includes(field.type)
+ return !field.type.startsWith('nf-')
})
.map(col => {
const { columns: matrixColumns, ...rest } = col
diff --git a/client/composables/components/useComponentRegistry.js b/client/composables/components/useComponentRegistry.js
index abc28d188..0745a4291 100644
--- a/client/composables/components/useComponentRegistry.js
+++ b/client/composables/components/useComponentRegistry.js
@@ -14,6 +14,7 @@ const clientOnlyHeavyFormComponentsRegistry = new Map([
['RichTextAreaInput', () => import('~/components/forms/heavy/RichTextAreaInput.client.vue')],
['PaymentInput', () => import('~/components/forms/heavy/PaymentInput.client.vue')],
['CodeInput', () => import('~/components/forms/heavy/CodeInput.client.vue')],
+ ['EmbedMedia', () => import('~/components/forms/heavy/components/EmbedMedia.vue')],
])
const actionRegistry = new Map([
diff --git a/client/data/blocks_types.json b/client/data/blocks_types.json
index 34274bdd0..589167e02 100644
--- a/client/data/blocks_types.json
+++ b/client/data/blocks_types.json
@@ -339,6 +339,16 @@
"is_input": false,
"default_values": {}
},
+ "nf-video": {
+ "name": "nf-video",
+ "title": "Video",
+ "icon": "i-heroicons-video-camera",
+ "default_block_name": "Video Block",
+ "bg_class": "bg-yellow-100",
+ "text_class": "text-yellow-900",
+ "is_input": false,
+ "default_values": {}
+ },
"nf-code": {
"name": "nf-code",
"title": "Code",
diff --git a/client/lib/forms/FormPropertyLogicRule.js b/client/lib/forms/FormPropertyLogicRule.js
index 4a689385d..716b01b63 100644
--- a/client/lib/forms/FormPropertyLogicRule.js
+++ b/client/lib/forms/FormPropertyLogicRule.js
@@ -134,6 +134,7 @@ class FormPropertyLogicRule {
"nf-page-break",
"nf-divider",
"nf-image",
+ "nf-video"
].indexOf(this.property["type"]) > -1 &&
["hide-block", "show-block"].indexOf(val) === -1) ||
(this.property["hidden"] !== undefined &&
diff --git a/client/package-lock.json b/client/package-lock.json
index aa8f16467..9c19f69fd 100644
--- a/client/package-lock.json
+++ b/client/package-lock.json
@@ -37,6 +37,7 @@
"crisp-sdk-web": "^1.0.25",
"date-fns": "^2.30.0",
"debounce": "^1.2.1",
+ "embedkit": "^0.1.7",
"esbuild": "^0.23.1",
"fuse.js": "^7.0.0",
"js-sha256": "^0.10.1",
@@ -12099,6 +12100,15 @@
"integrity": "sha512-zlaUk/wwnR/27FHNarzOtMgfxD1Q0/2Aby7PnURumQTal7yauqQ3c2HHcG/pjLFTvF3AWv44kMWyArVlfHeDlw==",
"license": "ISC"
},
+ "node_modules/embedkit": {
+ "version": "0.1.7",
+ "resolved": "https://registry.npmjs.org/embedkit/-/embedkit-0.1.7.tgz",
+ "integrity": "sha512-0k4JkUAL9OcDzKUdItIuaF2AFR/EJCDcVKvduOUM14u/TiWuCtEr7PriBe5PsTEgjdvicTGEADn8LJeeq+NtrA==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ }
+ },
"node_modules/embla-carousel": {
"version": "8.6.0",
"resolved": "https://registry.npmjs.org/embla-carousel/-/embla-carousel-8.6.0.tgz",
@@ -20111,14 +20121,6 @@
"integrity": "sha512-g6T+p7QO8npa+/hNx9ohv1E5pVCmWrVCUzUXJyLdMmftX6ER0oiWY/w9knEonLpnOp6b6FenKnMfR8gqwWdwig==",
"license": "MIT"
},
- "node_modules/sortablejs": {
- "version": "1.15.6",
- "resolved": "https://registry.npmjs.org/sortablejs/-/sortablejs-1.15.6.tgz",
- "integrity": "sha512-aNfiuwMEpfBM/CN6LY0ibyhxPfPbyFeBTYJKCvzkJ2GkUpazIt3H+QIPAMHwqQ7tMKaHz1Qj+rJJCqljnf4p3A==",
- "license": "MIT",
- "optional": true,
- "peer": true
- },
"node_modules/source-map": {
"version": "0.6.1",
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
diff --git a/client/package.json b/client/package.json
index 5200fa542..f711384b6 100644
--- a/client/package.json
+++ b/client/package.json
@@ -75,6 +75,7 @@
"crisp-sdk-web": "^1.0.25",
"date-fns": "^2.30.0",
"debounce": "^1.2.1",
+ "embedkit": "^0.1.7",
"esbuild": "^0.23.1",
"fuse.js": "^7.0.0",
"js-sha256": "^0.10.1",