Skip to content

Beautiful Open-Source Form Builder

Dc3e4 new matrix field (#484)

Favour Olayinka1adac8e00fcb
diff --git a/app/Http/Requests/AnswerFormRequest.php b/app/Http/Requests/AnswerFormRequest.php
index 4057c9bc5..8bfc10ee9 100644
--- a/app/Http/Requests/AnswerFormRequest.php
+++ b/app/Http/Requests/AnswerFormRequest.php
@@ -4,6 +4,7 @@ namespace App\Http\Requests;
use App\Models\Forms\Form;
use App\Rules\CustomFieldValidationRule;
+use App\Rules\MatrixValidationRule;
use App\Rules\StorageFile;
use App\Rules\ValidHCaptcha;
use App\Rules\ValidPhoneInputRule;
@@ -82,9 +83,14 @@ class AnswerFormRequest extends FormRequest
} elseif ($property['type'] == 'rating') {
// For star rating, needs a minimum of 1 star
$rules[] = 'min:1';
+ } elseif ($property['type'] == 'matrix') {
+ $rules[] = new MatrixValidationRule($property, true);
}
} else {
$rules[] = 'nullable';
+ if ($property['type'] == 'matrix') {
+ $rules[] = new MatrixValidationRule($property, false);
+ }
}
// Clean id to escape "."
@@ -97,7 +103,7 @@ class AnswerFormRequest extends FormRequest
}
// User custom validation
- if(!(Str::of($property['type'])->startsWith('nf-')) && isset($property['validation'])) {
+ if (!(Str::of($property['type'])->startsWith('nf-')) && isset($property['validation'])) {
$rules[] = (new CustomFieldValidationRule($property['validation'], $data));
}
diff --git a/app/Rules/FormPropertyLogicRule.php b/app/Rules/FormPropertyLogicRule.php
index 795171a4d..cfaee33bb 100644
--- a/app/Rules/FormPropertyLogicRule.php
+++ b/app/Rules/FormPropertyLogicRule.php
@@ -73,6 +73,34 @@ class FormPropertyLogicRule implements DataAwareRule, ValidationRule
],
],
],
+ 'matrix' => [
+ 'comparators' => [
+ 'equals' => [
+ 'expected_type' => 'object',
+ 'format' => [
+ 'type' => 'object',
+ ],
+ ],
+ 'does_not_equal' => [
+ 'expected_type' => 'object',
+ 'format' => [
+ 'type' => 'object',
+ ],
+ ],
+ 'contains' => [
+ 'expected_type' => 'object',
+ 'format' => [
+ 'type' => 'object',
+ ],
+ ],
+ 'does_not_contain' => [
+ 'expected_type' => 'object',
+ 'format' => [
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ ],
'url' => [
'comparators' => [
'equals' => [
diff --git a/app/Rules/MatrixValidationRule.php b/app/Rules/MatrixValidationRule.php
new file mode 100644
index 000000000..f50c1238b
--- /dev/null
+++ b/app/Rules/MatrixValidationRule.php
@@ -0,0 +1,61 @@
+<?php
+
+namespace App\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class MatrixValidationRule implements ValidationRule
+{
+ protected $field;
+ protected $isRequired;
+
+ public function __construct(array $field, bool $isRequired)
+ {
+ $this->field = $field;
+ $this->isRequired = $isRequired;
+ }
+
+ public function validate(string $attribute, mixed $value, Closure $fail): void
+ {
+ if (!$this->isRequired && empty($value)) {
+ return; // If not required and empty, validation passes
+ }
+
+ if (!is_array($value)) {
+ $fail('The Matrix field must be an array.');
+ return;
+ }
+
+ $rows = $this->field['rows'];
+ $columns = $this->field['columns'];
+
+ foreach ($rows as $row) {
+ if (!array_key_exists($row, $value)) {
+ if ($this->isRequired) {
+ $fail("Missing value for row '{$row}'.");
+ }
+ continue;
+ }
+
+ $cellValue = $value[$row];
+
+ if ($cellValue === null) {
+ if ($this->isRequired) {
+ $fail("Value for row '{$row}' is required.");
+ }
+ continue;
+ }
+
+ if (!in_array($cellValue, $columns)) {
+ $fail("Invalid value '{$cellValue}' for row '{$row}'.");
+ }
+ }
+
+ // Check for extra rows that shouldn't be there
+ $extraRows = array_diff(array_keys($value), $rows);
+ foreach ($extraRows as $extraRow) {
+ $fail("Unexpected row '{$extraRow}' in the matrix.");
+ }
+ }
+}
diff --git a/app/Service/Forms/FormLogicConditionChecker.php b/app/Service/Forms/FormLogicConditionChecker.php
index 11f2794d7..44e347b46 100644
--- a/app/Service/Forms/FormLogicConditionChecker.php
+++ b/app/Service/Forms/FormLogicConditionChecker.php
@@ -72,6 +72,8 @@ class FormLogicConditionChecker
return $this->multiSelectConditionMet($propertyCondition, $value);
case 'files':
return $this->filesConditionMet($propertyCondition, $value);
+ case 'matrix':
+ return $this->matrixConditionMet($propertyCondition, $value);
}
return false;
@@ -90,6 +92,30 @@ class FormLogicConditionChecker
return \Str::contains($fieldValue, $condition['value']);
}
+ private function checkMatrixContains($condition, $fieldValue): bool
+ {
+
+ foreach($condition['value'] as $key => $value) {
+ if(!(array_key_exists($key, $condition['value']) && array_key_exists($key, $fieldValue))) {
+ return false;
+ }
+ if($condition['value'][$key] == $fieldValue[$key]) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ private function checkMatrixEquals($condition, $fieldValue): bool
+ {
+ foreach($condition['value'] as $key => $value) {
+ if($condition['value'][$key] !== $fieldValue[$key]) {
+ return false;
+ }
+ }
+ return true;
+ }
+
private function checkListContains($condition, $fieldValue): bool
{
if (is_null($fieldValue)) {
@@ -408,4 +434,20 @@ class FormLogicConditionChecker
return false;
}
+
+ private function matrixConditionMet(array $propertyCondition, $value): bool
+ {
+ switch ($propertyCondition['operator']) {
+ case 'equals':
+ return $this->checkMatrixEquals($propertyCondition, $value);
+ case 'does_not_equal':
+ return !$this->checkMatrixEquals($propertyCondition, $value);
+ case 'contains':
+ return $this->checkMatrixContains($propertyCondition, $value);
+ case 'does_not_contain':
+ return !$this->checkMatrixContains($propertyCondition, $value);
+ }
+
+ return false;
+ }
}
diff --git a/app/Service/Forms/FormSubmissionFormatter.php b/app/Service/Forms/FormSubmissionFormatter.php
index b21317704..5b123c854 100644
--- a/app/Service/Forms/FormSubmissionFormatter.php
+++ b/app/Service/Forms/FormSubmissionFormatter.php
@@ -81,6 +81,17 @@ class FormSubmissionFormatter
return $this;
}
+ public function getMatrixString(array $val): string
+ {
+ $parts = [];
+ foreach ($val as $key => $value) {
+ if ($key !== null && $value !== null) {
+ $parts[] = "$key: $value";
+ }
+ }
+ return implode(' | ', $parts);
+ }
+
/**
* Return a nice "FieldName": "Field Response" array
* - If createLink enabled, returns html link for emails and links
@@ -145,7 +156,9 @@ class FormSubmissionFormatter
} else {
$returnArray[$field['name']] = $val;
}
- } elseif (in_array($field['type'], ['files', 'signature'])) {
+ } elseif ($field['type'] == 'matrix' && is_array($data[$field['id']])) {
+ $returnArray[$field['name']] = $this->getMatrixString($data[$field['id']]);
+ } elseif ($field['type'] == 'files') {
if ($this->outputStringsOnly) {
$formId = $this->form->id;
$returnArray[$field['name']] = implode(
@@ -219,7 +232,9 @@ class FormSubmissionFormatter
} else {
$field['value'] = $val;
}
- } elseif (in_array($field['type'], ['files', 'signature'])) {
+ } elseif ($field['type'] == 'matrix') {
+ $field['value'] = str_replace(' | ', "\n", $this->getMatrixString($data[$field['id']]));
+ } elseif ($field['type'] == 'files') {
if ($this->outputStringsOnly) {
$formId = $this->form->id;
$field['value'] = implode(
diff --git a/client/components/forms/FlatSelectInput.vue b/client/components/forms/FlatSelectInput.vue
index a417bee20..7f6b4c414 100644
--- a/client/components/forms/FlatSelectInput.vue
+++ b/client/components/forms/FlatSelectInput.vue
@@ -16,60 +16,45 @@
theme.default.input,
theme.default.borderRadius,
{
- 'mb-2': index !== options.length,
'!ring-red-500 !ring-2 !border-transparent': hasError,
'!cursor-not-allowed !bg-gray-200': disabled,
},
]"
>
- <template
- v-if="options && options.length"
- >
- <div
- v-for="(option) in options"
- :key="option[optionKey]"
- :role="multiple?'checkbox':'radio'"
- :aria-checked="isSelected(option[optionKey])"
- :class="[
- theme.FlatSelectInput.spacing.vertical,
- theme.FlatSelectInput.fontSize,
- theme.FlatSelectInput.option,
- ]"
- @click="onSelect(option[optionKey])"
+ <template
+ v-if="options && options.length"
>
- <template v-if="multiple">
- <Icon
- v-if="isSelected(option[optionKey])"
- name="material-symbols:check-box"
- class="text-inherit"
- :color="color"
- :class="[theme.FlatSelectInput.icon]"
- />
- <Icon
- v-else
- name="material-symbols:check-box-outline-blank"
- :class="[theme.FlatSelectInput.icon,theme.FlatSelectInput.unselectedIcon]"
- />
- </template>
- <template v-else>
- <Icon
- v-if="isSelected(option[optionKey])"
- name="material-symbols:radio-button-checked-outline"
- class="text-inherit"
- :color="color"
- :class="[theme.FlatSelectInput.icon]"
- />
- <Icon
- v-else
- name="material-symbols:radio-button-unchecked"
- :class="[theme.FlatSelectInput.icon,theme.FlatSelectInput.unselectedIcon]"
- />
- </template>
- <p class="flex-grow">
- {{ option[displayKey] }}
- </p>
- </div>
- </template>
+ <div
+ v-for="(option) in options"
+ :key="option[optionKey]"
+ :role="multiple?'checkbox':'radio'"
+ :aria-checked="isSelected(option[optionKey])"
+ :class="[
+ theme.FlatSelectInput.spacing.vertical,
+ theme.FlatSelectInput.fontSize,
+ theme.FlatSelectInput.option,
+ ]"
+ @click="onSelect(option[optionKey])"
+ >
+ <template v-if="multiple">
+ <CheckboxIcon
+ :is-checked="isSelected(option[optionKey])"
+ :color="color"
+ :theme="theme"
+ />
+ </template>
+ <template v-else>
+ <RadioButtonIcon
+ :is-checked="isSelected(option[optionKey])"
+ :color="color"
+ :theme="theme"
+ />
+ </template>
+ <p class="flex-grow">
+ {{ option[displayKey] }}
+ </p>
+ </div>
+ </template>
<div
v-else
:class="[
@@ -96,13 +81,15 @@
<script>
import {inputProps, useFormInput} from "./useFormInput.js"
import InputWrapper from "./components/InputWrapper.vue"
+import RadioButtonIcon from "./components/RadioButtonIcon.vue"
+import CheckboxIcon from "./components/CheckboxIcon.vue"
/**
* Options: {name,value} objects
*/
export default {
name: "FlatSelectInput",
- components: {InputWrapper},
+ components: {InputWrapper, RadioButtonIcon, CheckboxIcon},
props: {
...inputProps,
@@ -156,4 +143,4 @@ export default {
},
},
}
-</script>
+</script>
\ No newline at end of file
diff --git a/client/components/forms/MatrixInput.vue b/client/components/forms/MatrixInput.vue
new file mode 100644
index 000000000..25cdad39f
--- /dev/null
+++ b/client/components/forms/MatrixInput.vue
@@ -0,0 +1,121 @@
+<template>
+ <input-wrapper v-bind="inputWrapperProps">
+ <template #label>
+ <slot name="label" />
+ </template>
+ <div
+ class="border border-gray-300"
+ :class="[
+ theme.default.borderRadius,
+ {
+ '!ring-red-500 !ring-2 !border-transparent': hasError,
+ '!cursor-not-allowed !bg-gray-300': disabled,
+ },
+ ]"
+ >
+ <table
+ class="w-full table-fixed overflow-hidden"
+ >
+ <thead class="">
+ <tr>
+ <th />
+ <td
+ v-for="column in columns"
+ :key="column"
+ class="border-l border-gray-300"
+ >
+ <div class="p-2 w-full flex items-center justify-center capitalize text-sm truncate">
+ {{ column }}
+ </div>
+ </td>
+ </tr>
+ </thead>
+
+ <tbody>
+ <tr
+ v-for="row, rowIndex in rows"
+ :key="rowIndex"
+ class="border-t border-gray-300"
+ >
+ <td>
+ <div class="w-full flex-grow p-2 text-sm truncate">
+ {{ row }}
+ </div>
+ </td>
+ <td
+ v-for="column in columns"
+ :key="row + column"
+ class="border-l border-gray-300 hover:!bg-gray-100 dark:hover:!bg-gray-800"
+ >
+ <div
+ v-if="compVal"
+ class="w-full flex items-center justify-center"
+ role="radio"
+ :aria-checked="compVal[row] === column"
+ :class="[
+ theme.FlatSelectInput.spacing.vertical,
+ theme.FlatSelectInput.fontSize,
+ theme.FlatSelectInput.option,
+ ]"
+ @click="onSelect(row, column)"
+ >
+ <RadioButtonIcon
+ :key="row+column"
+ :is-checked="compVal[row] === column"
+ :color="color"
+ :theme="theme"
+ />
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <template #help>
+ <slot name="help" />
+ </template>
+ <template #error>
+ <slot name="error" />
+ </template>
+ </input-wrapper>
+</template>
+<script>
+import {inputProps, useFormInput} from "./useFormInput.js"
+import InputWrapper from "./components/InputWrapper.vue"
+import RadioButtonIcon from "./components/RadioButtonIcon.vue"
+
+export default {
+ name: "MatrixInput",
+ components: {InputWrapper, RadioButtonIcon},
+
+ props: {
+ ...inputProps,
+ rows: {type: Array, required: true},
+ columns: {type: Array, required: true},
+ },
+ setup(props, context) {
+ return {
+ ...useFormInput(props, context),
+ }
+ },
+ data() {
+ return {
+ }
+ },
+ computed: {},
+ beforeMount() {
+ if (!this.compVal || typeof this.compVal !== 'object') {
+ this.compVal = {}
+ }
+ },
+ methods: {
+ onSelect(row, column) {
+ if (this.compVal[row] === column && !this.required) {
+ this.compVal[row] = null
+ } else {
+ this.compVal[row] = column
+ }
+ },
+ },
+}
+</script>
\ No newline at end of file
diff --git a/client/components/forms/components/CheckboxIcon.vue b/client/components/forms/components/CheckboxIcon.vue
new file mode 100644
index 000000000..2c80db4e0
--- /dev/null
+++ b/client/components/forms/components/CheckboxIcon.vue
@@ -0,0 +1,27 @@
+<template>
+ <Icon
+ :name="isChecked ? 'material-symbols:check-box' : 'material-symbols:check-box-outline-blank'"
+ :class="[
+ theme.FlatSelectInput.icon,
+ isChecked ? '' : theme.FlatSelectInput.unselectedIcon,
+ ]"
+ :color="isChecked ? color : undefined"
+ />
+</template>
+
+<script setup>
+const props = defineProps({
+ isChecked: {
+ type: Boolean,
+ required: true
+ },
+ color: {
+ type: String,
+ default: ''
+ },
+ theme: {
+ type: Object,
+ required: true
+ }
+})
+</script>
\ No newline at end of file
diff --git a/client/components/forms/components/RadioButtonIcon.vue b/client/components/forms/components/RadioButtonIcon.vue
new file mode 100644
index 000000000..157971945
--- /dev/null
+++ b/client/components/forms/components/RadioButtonIcon.vue
@@ -0,0 +1,29 @@
+<template>
+ <Icon
+ :name="isChecked ? 'ic:round-radio-button-checked' : 'ic:round-radio-button-unchecked'"
+ :class="[
+ theme.FlatSelectInput.icon,
+ isChecked ? '' : theme.FlatSelectInput.unselectedIcon,
+ ]"
+ :color="isChecked ? color : undefined"
+ />
+</template>
+
+<script setup>
+import { computed } from 'vue'
+
+const props = defineProps({
+ isChecked: {
+ type: Boolean,
+ required: true
+ },
+ color: {
+ type: String,
+ default: ''
+ },
+ theme: {
+ type: Object,
+ required: true
+ }
+})
+</script>
\ No newline at end of file
diff --git a/client/components/open/forms/OpenForm.vue b/client/components/open/forms/OpenForm.vue
index e20cbe458..f2ef896f7 100644
--- a/client/components/open/forms/OpenForm.vue
+++ b/client/components/open/forms/OpenForm.vue
@@ -448,6 +448,8 @@ export default {
formData[field.id] = urlPrefill.getAll(field.id + '[]')
} else if (field.type === 'date' && field.prefill_today === true) { // For Prefill with 'today'
formData[field.id] = new Date().toISOString()
+ } else if (field.type === 'matrix') {
+ formData[field.id] = {...field.prefill}
} else { // Default prefill if any
formData[field.id] = field.prefill
}
diff --git a/client/components/open/forms/OpenFormField.vue b/client/components/open/forms/OpenFormField.vue
index 67ea37464..5022df793 100644
--- a/client/components/open/forms/OpenFormField.vue
+++ b/client/components/open/forms/OpenFormField.vue
@@ -6,7 +6,7 @@
:class="[
getFieldWidthClasses(field),
{
- 'group/nffield hover:bg-gray-100/50 relative hover:z-10 transition-colors hover:border-gray-200 dark:hover:bg-gray-900 border-dashed border border-transparent box-border dark:hover:border-blue-900 rounded-md':adminPreview,
+ 'group/nffield hover:bg-gray-100/50 relative hover:z-10 transition-colors hover:border-gray-200 dark:hover:!bg-gray-900 border-dashed border border-transparent box-border dark:hover:border-blue-900 rounded-md':adminPreview,
'bg-blue-50 hover:!bg-blue-50 dark:bg-gray-800 rounded-md': beingEdited,
}]"
>
@@ -95,8 +95,12 @@
>
</div>
</template>
- <div class="hidden group-hover/nffield:flex translate-x-full absolute right-0 top-0 h-full w-5 flex-col justify-center pl-1 pt-3">
- <div class="flex items-center bg-gray-100 dark:bg-gray-800 border rounded-md h-12 text-gray-500 dark:text-gray-400 dark:border-gray-500 cursor-grab handle">
+ <div
+ class="hidden group-hover/nffield:flex translate-x-full absolute right-0 top-0 h-full w-5 flex-col justify-center pl-1 pt-3"
+ >
+ <div
+ class="flex items-center bg-gray-100 dark:bg-gray-800 border rounded-md h-12 text-gray-500 dark:text-gray-400 dark:border-gray-500 cursor-grab handle"
+ >
<Icon
name="clarity:drag-handle-line"
class="h-6 w-6 -ml-1 block shrink-0"
@@ -200,7 +204,8 @@ export default {
checkbox: 'CheckboxInput',
url: 'TextInput',
email: 'TextInput',
- phone_number: 'TextInput'
+ phone_number: 'TextInput',
+ matrix: 'MatrixInput'
}[field.type]
},
isPublicFormPage() {
@@ -299,6 +304,11 @@ export default {
isDark: this.darkMode
}
+ if (field.type === 'matrix') {
+ inputProperties.rows = field.rows
+ inputProperties.columns = field.columns
+ }
+
if (['select', 'multi_select'].includes(field.type)) {
inputProperties.options = (_has(field, field.type))
? field[field.type].options.map(option => {
diff --git a/client/components/open/forms/components/form-components/AddFormBlock.vue b/client/components/open/forms/components/form-components/AddFormBlock.vue
index 562269e3b..18afe5407 100644
--- a/client/components/open/forms/components/form-components/AddFormBlock.vue
+++ b/client/components/open/forms/components/form-components/AddFormBlock.vue
@@ -204,6 +204,11 @@ export default {
title: "Signature Input",
icon: '<path stroke-linecap="round" stroke-linejoin="round" d="M16.862 4.487l1.687-1.688a1.875 1.875 0 112.652 2.652L6.832 19.82a4.5 4.5 0 01-1.897 1.13l-2.685.8.8-2.685a4.5 4.5 0 011.13-1.897L16.863 4.487zm0 0L19.5 7.125" />',
},
+ {
+ name: "matrix",
+ title: "Matrix Input",
+ icon: '<path fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.5" d="M3.375 19.5h17.25m-17.25 0a1.125 1.125 0 0 1-1.125-1.125M3.375 19.5h7.5c.621 0 1.125-.504 1.125-1.125m-9.75 0V5.625m0 12.75v-1.5c0-.621.504-1.125 1.125-1.125m18.375 2.625V5.625m0 12.75c0 .621-.504 1.125-1.125 1.125m1.125-1.125v-1.5c0-.621-.504-1.125-1.125-1.125m0 3.75h-7.5A1.125 1.125 0 0 1 12 18.375m9.75-12.75c0-.621-.504-1.125-1.125-1.125H3.375c-.621 0-1.125.504-1.125 1.125m19.5 0v1.5c0 .621-.504 1.125-1.125 1.125M2.25 5.625v1.5c0 .621.504 1.125 1.125 1.125m0 0h17.25m-17.25 0h7.5c.621 0 1.125.504 1.125 1.125M3.375 8.25c-.621 0-1.125.504-1.125 1.125v1.5c0 .621.504 1.125 1.125 1.125m17.25-3.75h-7.5c-.621 0-1.125.504-1.125 1.125m8.625-1.125c.621 0 1.125.504 1.125 1.125v1.5c0 .621-.504 1.125-1.125 1.125m-17.25 0h7.5m-7.5 0c-.621 0-1.125.504-1.125 1.125v1.5c0 .621.504 1.125 1.125 1.125M12 10.875v-1.5m0 1.5c0 .621-.504 1.125-1.125 1.125M12 10.875c0 .621.504 1.125 1.125 1.125m-2.25 0c.621 0 1.125.504 1.125 1.125M13.125 12h7.5m-7.5 0c-.621 0-1.125.504-1.125 1.125M20.625 12c.621 0 1.125.504 1.125 1.125v1.5c0 .621-.504 1.125-1.125 1.125m-17.25 0h7.5M12 14.625v-1.5m0 1.5c0 .621-.504 1.125-1.125 1.125M12 14.625c0 .621.504 1.125 1.125 1.125m-2.25 0c.621 0 1.125.504 1.125 1.125m0 1.5v-1.5m0 0c0-.621.504-1.125 1.125-1.125m0 0h7.5"></path>',
+ },
],
layoutBlocks: [
{
diff --git a/client/components/open/forms/components/form-logic-components/ColumnCondition.vue b/client/components/open/forms/components/form-logic-components/ColumnCondition.vue
index bc541d75b..a64f9d3fa 100644
--- a/client/components/open/forms/components/form-logic-components/ColumnCondition.vue
+++ b/client/components/open/forms/components/form-logic-components/ColumnCondition.vue
@@ -58,6 +58,7 @@ export default {
url: "TextInput",
email: "TextInput",
phone_number: "TextInput",
+ matrix: "MatrixInput",
},
}
},
@@ -93,6 +94,10 @@ export default {
} else if (this.property.type === "checkbox") {
componentData.label = this.property.name
}
+ else if (this.property.type === "matrix"){
+ componentData.rows = this.property.rows
+ componentData.columns = this.property.columns
+ }
return componentData
},
@@ -184,8 +189,9 @@ export default {
) {
this.content.value = {}
} else if (
- typeof this.content.value === "boolean" ||
- typeof this.content.value === "object"
+ this.property.type !== 'matrix' &&
+ (typeof this.content.value === 'boolean' ||
+ typeof this.content.value === 'object')
) {
this.content.value = null
}
diff --git a/client/components/open/forms/fields/components/FieldOptions.vue b/client/components/open/forms/fields/components/FieldOptions.vue
index 248a463e7..dbfb1a73d 100644
--- a/client/components/open/forms/fields/components/FieldOptions.vue
+++ b/client/components/open/forms/fields/components/FieldOptions.vue
@@ -187,6 +187,11 @@
/>
</div>
+ <MatrixFieldOptions
+ :model-value="field"
+ @update:model-value="field = $event"
+ />
+
<!-- Text Options -->
<div
v-if="field.type === 'text' && displayBasedOnAdvanced"
@@ -290,7 +295,6 @@
Advanced options for your select/multiselect fields.
</p>
<text-area-input
- v-model="optionsText"
:name="field.id + '_options_text'"
class="mt-3"
label="Set selection options"
@@ -423,6 +427,15 @@
label="Pre-filled value"
:multiple="field.type === 'multi_select'"
/>
+ <template v-else-if="field.type === 'matrix'">
+ <MatrixInput
+ :form="field"
+ :rows="field.rows"
+ :columns="field.columns"
+ name="prefill"
+ label="Pre-filled value"
+ />
+ </template>
<date-input
v-else-if="field.type === 'date' && field.prefill_today !== true"
name="prefill"
@@ -594,7 +607,7 @@
:field="field"
/>
- <custom-field-validation
+ <custom-field-validation
class="py-2 px-4 border-b pb-16"
:form="form"
:field="field"
@@ -608,12 +621,13 @@ import countryCodes from '~/data/country_codes.json'
import CountryFlag from 'vue-country-flag-next'
import FormBlockLogicEditor from '../../components/form-logic-components/FormBlockLogicEditor.vue'
import CustomFieldValidation from '../../components/CustomFieldValidation.vue'
+import MatrixFieldOptions from './MatrixFieldOptions.vue'
import { format } from 'date-fns'
import { default as _has } from 'lodash/has'
export default {
name: 'FieldOptions',
- components: { CountryFlag, FormBlockLogicEditor, CustomFieldValidation },
+ components: { CountryFlag, FormBlockLogicEditor, CustomFieldValidation, MatrixFieldOptions },
props: {
field: {
type: Object,
@@ -682,12 +696,6 @@ export default {
}
return true
},
- optionsText() {
- if (!this.field[this.field.type]) return ''
- return this.field[this.field.type].options.map(option => {
- return option.name
- }).join('\n')
- }
},
watch: {
@@ -868,6 +876,13 @@ export default {
date: {
date_format: this.dateFormatOptions[0].value,
time_format: this.timeFormatOptions[0].value
+ },
+ matrix: {
+ rows:['Row 1'],
+ columns: [1 ,2 ,3],
+ selection_data:{
+ 'Row 1': null
+ }
}
}
if (this.field.type in defaultFieldValues) {
@@ -877,6 +892,9 @@ export default {
}
})
}
+ },
+ updateMatrixField(newField) {
+ this.field = newField
}
}
}
diff --git a/client/components/open/forms/fields/components/MatrixFieldOptions.vue b/client/components/open/forms/fields/components/MatrixFieldOptions.vue
new file mode 100644
index 000000000..cb654e3cc
--- /dev/null
+++ b/client/components/open/forms/fields/components/MatrixFieldOptions.vue
@@ -0,0 +1,132 @@
+<template>
+ <div
+ v-if="localField.type === 'matrix'"
+ class="border-b py-2 px-4"
+ >
+ <h3 class="font-semibold block text-lg">
+ Matrix
+ </h3>
+ <p class="text-gray-400 mb-3 text-xs">
+ Advanced options for matrix.
+ </p>
+
+ <div class="grid grid-cols-2 gap-4">
+ <div class="">
+ <div
+ v-for="(row, i) in localField.rows"
+ :key="i"
+ class="flex items-center space-x-2"
+ >
+ <text-input
+ v-model="localField.rows[i]"
+ name="rows"
+ wrapper-class="mb-1"
+ @update:model-value="updateField"
+ />
+ <button @click="removeMatrixRow(i)">
+ <Icon
+ name="heroicons:trash"
+ class="text-gray-300 w-4 h-4 mb-2"
+ />
+ </button>
+ </div>
+ <UButton
+ size="xs"
+ color="gray"
+ icon="i-heroicons-plus"
+ @click="addMatrixRow"
+ >
+ Add row
+ </UButton>
+ </div>
+ <div class="">
+ <div
+ v-for="(column, i) in localField.columns"
+ :key="i"
+ class="flex items-center space-x-2"
+ >
+ <text-input
+ v-model="localField.columns[i]"
+ wrapper-class="mb-1"
+ @update:model-value="updateField"
+ />
+ <button @click="removeMatrixColumn(i)">
+ <Icon
+ name="heroicons:trash"
+ class="text-gray-300 w-4 h-4 mb-2"
+ />
+ </button>
+ </div>
+ <UButton
+ size="xs"
+ color="gray"
+ icon="i-heroicons-plus"
+ @click="addMatrixColumn"
+ >
+ Add column
+ </UButton>
+ </div>
+ </div>
+ </div>
+</template>
+
+<script setup>
+import { ref, watch, computed } from 'vue'
+
+const props = defineProps({
+ modelValue: {
+ type: Object,
+ required: true
+ },
+})
+
+const emit = defineEmits(['update:modelValue'])
+
+const localField = ref({ ...props.modelValue })
+
+watch(() => props.modelValue, (newField) => {
+ localField.value = { ...newField }
+}, { deep: true })
+
+const selectionData = computed(() => {
+ return Object.fromEntries(localField.value.rows?.map(row => [row, '']))
+})
+
+function updateField() {
+ emit('update:modelValue', { ...localField.value })
+}
+
+function addMatrixRow() {
+ localField.value.rows.push(generateUniqueLabel(localField.value.rows, 'Row'))
+ localField.value.selection_data = selectionData.value
+ updateField()
+}
+
+function removeMatrixRow(index) {
+ localField.value.rows.splice(index, 1)
+ localField.value.selection_data = selectionData.value
+ updateField()
+}
+
+function addMatrixColumn() {
+ localField.value.columns.push(generateUniqueLabel(localField.value.columns, null))
+ localField.value.selection_data = selectionData.value
+ updateField()
+}
+
+function removeMatrixColumn(index) {
+ localField.value.columns.splice(index, 1)
+ localField.value.selection_data = selectionData.value
+ updateField()
+}
+
+function generateUniqueLabel(array, prefix = null) {
+ let uniqueNumber = 1 // Start checking from 1
+ let label = prefix ? `${prefix} ${uniqueNumber}` : uniqueNumber
+ while (array.includes(label)) {
+ uniqueNumber++ // Increment if the number is found in the array
+ label = prefix ? `${prefix} ${uniqueNumber}` : uniqueNumber
+ }
+ return label // Return the first unique number found
+}
+</script>
\ No newline at end of file
diff --git a/client/components/open/forms/fields/components/MatrixPrefilledValues.vue b/client/components/open/forms/fields/components/MatrixPrefilledValues.vue
new file mode 100644
index 000000000..11bf47f11
--- /dev/null
+++ b/client/components/open/forms/fields/components/MatrixPrefilledValues.vue
@@ -0,0 +1,52 @@
+<template>
+ <p class="font-semibold">Prefilled values</p>
+ <select-input
+ v-for="row in matrixData"
+ :key="row.label"
+ name="prefill"
+ class="mt-3"
+ :options="row.options"
+ :label="row.label"
+ v-model="selection[row.label]"
+ @update:model-value="onSelection"
+ />
+</template>
+<script>
+export default {
+ name: 'MatrixPrefilledValues',
+ props: {
+ field: {
+ type: Object,
+ required: false
+ },
+ form: {
+ type: Object,
+ required: false
+ }
+ },
+ data() {
+ return {
+ selection: {}
+ }
+ },
+ computed: {
+ matrixData() {
+ const options = this.field.columns || []
+ return (this.field.row || []).map(row => {
+ return {
+ label: row,
+ options: options?.map(option => ({ name: option, value: option }))
+ }
+ })
+ },
+ },
+ mounted() {
+ this.selection = this.field.prefill ?? this.field.selection_data ?? {}
+ },
+ methods: {
+ onSelection() {
+ this.field.prefill = this.selection
+ }
+ }
+}
+</script>
\ No newline at end of file
diff --git a/client/components/open/tables/OpenTable.vue b/client/components/open/tables/OpenTable.vue
index a541cfa1f..9807d7f2a 100644
--- a/client/components/open/tables/OpenTable.vue
+++ b/client/components/open/tables/OpenTable.vue
@@ -140,6 +140,7 @@
import OpenText from "./components/OpenText.vue"
import OpenUrl from "./components/OpenUrl.vue"
import OpenSelect from "./components/OpenSelect.vue"
+import OpenMatrix from "./components/OpenMatrix.vue"
import OpenDate from "./components/OpenDate.vue"
import OpenFile from "./components/OpenFile.vue"
import OpenCheckbox from "./components/OpenCheckbox.vue"
@@ -197,6 +198,7 @@ export default {
scale: shallowRef(OpenText),
slider: shallowRef(OpenText),
select: shallowRef(OpenSelect),
+ matrix: shallowRef(OpenMatrix),
multi_select: shallowRef(OpenSelect),
date: shallowRef(OpenDate),
files: shallowRef(OpenFile),
diff --git a/client/components/open/tables/components/OpenMatrix.vue b/client/components/open/tables/components/OpenMatrix.vue
new file mode 100644
index 000000000..f8b68755f
--- /dev/null
+++ b/client/components/open/tables/components/OpenMatrix.vue
@@ -0,0 +1,50 @@
+<template>
+ <span
+ v-if="value"
+ class="-mb-2"
+ >
+ <template v-if="matrixData">
+ <div
+ v-for="(data) in matrixData"
+ :key="data.label+data.value"
+ class="mr-2 mb-1 text-gray-700 bg-gray-100 dark:text-gray-300 rounded-md flex px-2 text-sm w-max"
+ >
+ <span class="py-0.5 pr-1 border-r border-gray-300">{{ data.label }}</span>
+ <span class="py-0.5 pl-1">{{ data.value }}</span>
+ </div>
+
+ </template>
+ <open-tag
+ v-else
+ :opt="value"
+ />
+ </span>
+</template>
+
+<script>
+import OpenTag from "./OpenTag.vue"
+
+export default {
+ components: { OpenTag },
+ props: {
+ value: {
+ type: Object,
+ },
+ },
+
+ data() {
+ return {}
+ },
+
+ computed: {
+ matrixData() {
+ if (typeof this.value === "object" && this.value !== null) {
+ return Object.entries(this.value).map(([label, value]) => {
+ return { label, value }
+ })
+ }
+ return null
+ },
+ },
+}
+</script>
diff --git a/client/data/open_filters.json b/client/data/open_filters.json
index 3d72525e3..09826647e 100644
--- a/client/data/open_filters.json
+++ b/client/data/open_filters.json
@@ -231,6 +231,34 @@
}
}
},
+ "matrix": {
+ "comparators": {
+ "equals": {
+ "expected_type": "object",
+ "format": {
+ "type": "object"
+ }
+ },
+ "does_not_equal": {
+ "expected_type": "object",
+ "format": {
+ "type":"object"
+ }
+ },
+ "contains": {
+ "expected_type": "object",
+ "format": {
+ "type":"object"
+ }
+ },
+ "does_not_contain": {
+ "expected_type": "object",
+ "format": {
+ "type":"object"
+ }
+ }
+ }
+ },
"number": {
"comparators": {
"equals": {
diff --git a/client/lib/forms/FormLogicConditionChecker.js b/client/lib/forms/FormLogicConditionChecker.js
index f80aef114..d75b891fa 100644
--- a/client/lib/forms/FormLogicConditionChecker.js
+++ b/client/lib/forms/FormLogicConditionChecker.js
@@ -1,3 +1,5 @@
+import { default as _isEqual } from "lodash/isEqual"
+
export function conditionsMet(conditions, formData) {
if (conditions === undefined || conditions === null) {
return false
@@ -59,6 +61,8 @@ function propertyConditionMet(propertyCondition, value) {
return multiSelectConditionMet(propertyCondition, value)
case "files":
return filesConditionMet(propertyCondition, value)
+ case "matrix":
+ return matrixConditionMet(propertyCondition, value)
}
return false
}
@@ -67,6 +71,24 @@ function checkEquals(condition, fieldValue) {
return condition.value === fieldValue
}
+function checkObjectEquals(condition, fieldValue) {
+ return _isEqual(condition.value, fieldValue)
+}
+
+function checkMatrixContains(condition, fieldValue)
+{
+ if (typeof fieldValue === "undefined" || typeof fieldValue !== "object") {
+ return false
+ }
+ const conditionValue = condition.value
+ for (const key in conditionValue) {
+ if(conditionValue[key] == fieldValue[key]){
+ return true
+ }
+ }
+ return false
+}
+
function checkContains(condition, fieldValue) {
return fieldValue ? fieldValue.includes(condition.value) : false
}
@@ -148,7 +170,7 @@ function checkPastWeek(condition, fieldValue) {
return (
fieldDate <= today &&
fieldDate >=
- new Date(today.getFullYear(), today.getMonth(), today.getDate() - 7)
+ new Date(today.getFullYear(), today.getMonth(), today.getDate() - 7)
)
}
@@ -159,7 +181,7 @@ function checkPastMonth(condition, fieldValue) {
return (
fieldDate <= today &&
fieldDate >=
- new Date(today.getFullYear(), today.getMonth() - 1, today.getDate())
+ new Date(today.getFullYear(), today.getMonth() - 1, today.getDate())
)
}
@@ -170,7 +192,7 @@ function checkPastYear(condition, fieldValue) {
return (
fieldDate <= today &&
fieldDate >=
- new Date(today.getFullYear() - 1, today.getMonth(), today.getDate())
+ new Date(today.getFullYear() - 1, today.getMonth(), today.getDate())
)
}
@@ -181,7 +203,7 @@ function checkNextWeek(condition, fieldValue) {
return (
fieldDate >= today &&
fieldDate <=
- new Date(today.getFullYear(), today.getMonth(), today.getDate() + 7)
+ new Date(today.getFullYear(), today.getMonth(), today.getDate() + 7)
)
}
@@ -192,7 +214,7 @@ function checkNextMonth(condition, fieldValue) {
return (
fieldDate >= today &&
fieldDate <=
- new Date(today.getFullYear(), today.getMonth() + 1, today.getDate())
+ new Date(today.getFullYear(), today.getMonth() + 1, today.getDate())
)
}
@@ -203,7 +225,7 @@ function checkNextYear(condition, fieldValue) {
return (
fieldDate >= today &&
fieldDate <=
- new Date(today.getFullYear() + 1, today.getMonth(), today.getDate())
+ new Date(today.getFullYear() + 1, today.getMonth(), today.getDate())
)
}
@@ -371,3 +393,17 @@ function filesConditionMet(propertyCondition, value) {
}
return false
}
+
+function matrixConditionMet(propertyCondition, value) {
+ switch (propertyCondition.operator) {
+ case "equals":
+ return checkObjectEquals(propertyCondition, value)
+ case "does_not_equal":
+ return !checkObjectEquals(propertyCondition, value)
+ case "contains":
+ return checkMatrixContains(propertyCondition, value)
+ case "does_not_contain":
+ return !checkMatrixContains(propertyCondition, value)
+ }
+ return false
+}
diff --git a/client/lib/forms/FormPropertyLogicRule.js b/client/lib/forms/FormPropertyLogicRule.js
index a1ae5c1c8..49df65d1d 100644
--- a/client/lib/forms/FormPropertyLogicRule.js
+++ b/client/lib/forms/FormPropertyLogicRule.js
@@ -107,7 +107,7 @@ class FormPropertyLogicRule {
(type === "string" && typeof value !== "string") ||
(type === "boolean" && typeof value !== "boolean") ||
(type === "number" && typeof value !== "number") ||
- (type === "object" && !Array.isArray(value))
+ (type === "object" && !(Array.isArray(value) || typeof value === 'object'))
) {
return false
}
diff --git a/client/stores/working_form.js b/client/stores/working_form.js
index efabbcb21..61a8a445c 100644
--- a/client/stores/working_form.js
+++ b/client/stores/working_form.js
@@ -17,6 +17,7 @@ const defaultBlockNames = {
multi_select: "Multi Select",
files: "Files",
signature: "Signature",
+ matrix: "Matrix",
"nf-text": "Text Block",
"nf-page-break": "Page Break",
"nf-divider": "Divider",
diff --git a/database/factories/FormFactory.php b/database/factories/FormFactory.php
index 05586f549..a8d91d9d9 100644
--- a/database/factories/FormFactory.php
+++ b/database/factories/FormFactory.php
@@ -21,15 +21,6 @@ class FormFactory extends Factory
});
}
- public function forDatabase(string $databaseId)
- {
- return $this->state(function (array $attributes) use ($databaseId) {
- return [
- 'database_id' => $databaseId,
- ];
- });
- }
-
public function withProperties(array $properties)
{
return $this->state(function (array $attributes) use ($properties) {
diff --git a/resources/views/mail/form/submission-notification.blade.php b/resources/views/mail/form/submission-notification.blade.php
index f421359bf..80b28c72c 100644
--- a/resources/views/mail/form/submission-notification.blade.php
+++ b/resources/views/mail/form/submission-notification.blade.php
@@ -16,7 +16,7 @@ Your form "{{$form->title}}" has a new submission.
<a href="{{$link['signed_url']}}">{{$link['label']}}</a> <br/>
@endforeach
@else
-{!! is_array($field['value'])?implode(',',$field['value']):$field['value']!!}
+{!! is_array($field['value'])?implode(',',$field['value']):nl2br(e($field['value']))!!}
@endif
@endif
@endforeach
diff --git a/tests/Feature/Forms/MatrixInputTest.php b/tests/Feature/Forms/MatrixInputTest.php
new file mode 100644
index 000000000..6215bb8bb
--- /dev/null
+++ b/tests/Feature/Forms/MatrixInputTest.php
@@ -0,0 +1,185 @@
+<?php
+
+use Tests\Helpers\FormSubmissionDataFactory;
+
+it('can submit form with valid matrix input', function () {
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+
+ $matrixProperty = [
+ 'id' => 'matrix_field',
+ 'name' => 'Matrix Question',
+ 'type' => 'matrix',
+ 'rows' => ['Row 1', 'Row 2', 'Row 3'],
+ 'columns' => ['Column A', 'Column B', 'Column C'],
+ 'required' => true
+ ];
+
+ $form->properties = array_merge($form->properties, [$matrixProperty]);
+ $form->update();
+
+ $submissionData = [
+ 'matrix_field' => [
+ 'Row 1' => 'Column A',
+ 'Row 2' => 'Column B',
+ 'Row 3' => 'Column C'
+ ]
+ ];
+
+ $formData = FormSubmissionDataFactory::generateSubmissionData($form, $submissionData);
+
+ $this->postJson(route('forms.answer', $form->slug), $formData)
+ ->assertSuccessful()
+ ->assertJson([
+ 'type' => 'success',
+ 'message' => 'Form submission saved.',
+ ]);
+});
+
+it('cannot submit form with invalid matrix input', function () {
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+
+ $matrixProperty = [
+ 'id' => 'matrix_field',
+ 'name' => 'Matrix Question',
+ 'type' => 'matrix',
+ 'rows' => ['Row 1', 'Row 2', 'Row 3'],
+ 'columns' => ['Column A', 'Column B', 'Column C'],
+ 'required' => true
+ ];
+
+ $form->properties = array_merge($form->properties, [$matrixProperty]);
+ $form->update();
+
+ $submissionData = [
+ 'matrix_field' => [
+ 'Row 1' => 'Column A',
+ 'Row 2' => 'Invalid Column',
+ 'Row 3' => 'Column C'
+ ]
+ ];
+
+ $formData = FormSubmissionDataFactory::generateSubmissionData($form, $submissionData);
+
+ $this->postJson(route('forms.answer', $form->slug), $formData)
+ ->assertStatus(422)
+ ->assertJson([
+ 'message' => "Invalid value 'Invalid Column' for row 'Row 2'.",
+ 'errors' => [
+ 'matrix_field' => [
+ "Invalid value 'Invalid Column' for row 'Row 2'."
+ ]
+ ]
+ ]);
+});
+
+it('can submit form with optional matrix input left empty', function () {
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+
+ $matrixProperty = [
+ 'id' => 'matrix_field',
+ 'name' => 'Matrix Question',
+ 'type' => 'matrix',
+ 'rows' => ['Row 1', 'Row 2', 'Row 3'],
+ 'columns' => ['Column A', 'Column B', 'Column C'],
+ 'required' => false
+ ];
+
+ $form->properties = array_merge($form->properties, [$matrixProperty]);
+ $form->update();
+
+ $submissionData = [
+ 'matrix_field' => []
+ ];
+
+ $formData = FormSubmissionDataFactory::generateSubmissionData($form, $submissionData);
+
+ $this->postJson(route('forms.answer', $form->slug), $formData)
+ ->assertSuccessful()
+ ->assertJson([
+ 'type' => 'success',
+ 'message' => 'Form submission saved.',
+ ]);
+});
+
+it('cannot submit form with required matrix input left empty', function () {
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+
+ $matrixProperty = [
+ 'id' => 'matrix_field',
+ 'name' => 'Matrix Question',
+ 'type' => 'matrix',
+ 'rows' => ['Row 1', 'Row 2', 'Row 3'],
+ 'columns' => ['Column A', 'Column B', 'Column C'],
+ 'required' => true
+ ];
+
+ $form->properties = array_merge($form->properties, [$matrixProperty]);
+ $form->update();
+
+ $submissionData = [
+ 'matrix_field' => []
+ ];
+
+ $formData = FormSubmissionDataFactory::generateSubmissionData($form, $submissionData);
+
+ $this->postJson(route('forms.answer', $form->slug), $formData)
+ ->assertStatus(422)
+ ->assertJson([
+ 'message' => 'The Matrix Question field is required.',
+ 'errors' => [
+ 'matrix_field' => [
+ 'The Matrix Question field is required.'
+ ]
+ ]
+ ]);
+});
+
+it('can validate matrix input with precognition', function () {
+ $user = $this->actingAsUser();
+ $workspace = $this->createUserWorkspace($user);
+ $form = $this->createForm($user, $workspace);
+
+ $matrixProperty = [
+ 'id' => 'matrix_field',
+ 'name' => 'Matrix Question',
+ 'type' => 'matrix',
+ 'rows' => ['Row 1', 'Row 2', 'Row 3'],
+ 'columns' => ['Column A', 'Column B', 'Column C'],
+ 'required' => true
+ ];
+
+ $form->properties = array_merge($form->properties, [$matrixProperty]);
+ $form->update();
+
+ $submissionData = [
+ 'matrix_field' => [
+ 'Row 1' => 'Column A',
+ 'Row 2' => 'Invalid Column',
+ 'Row 3' => 'Column C'
+ ]
+ ];
+
+ $formData = FormSubmissionDataFactory::generateSubmissionData($form, $submissionData);
+
+ $response = $this->withPrecognition()->withHeaders([
+ 'Precognition-Validate-Only' => 'matrix_field'
+ ])
+ ->postJson(route('forms.answer', $form->slug), $formData);
+
+ $response->assertStatus(422)
+ ->assertJson([
+ 'errors' => [
+ 'matrix_field' => [
+ 'Invalid value \'Invalid Column\' for row \'Row 2\'.'
+ ]
+ ]
+ ]);
+});