Beautiful Open-Source Form Builder
Field Help as Html text & Help Position (#115)
Chirag Chhatrala3f2fe352e881
diff --git a/app/Http/Requests/UserFormRequest.php b/app/Http/Requests/UserFormRequest.phpindex 20bbed8fb..f822269f5 100644--- a/app/Http/Requests/UserFormRequest.php+++ b/app/Http/Requests/UserFormRequest.php@@ -82,6 +82,7 @@ abstract class UserFormRequest extends \Illuminate\Foundation\Http\FormRequest'properties.*.placeholder' => 'sometimes|nullable','properties.*.prefill' => 'sometimes|nullable','properties.*.help' => 'sometimes|nullable',+ 'properties.*.help_position' => ['sometimes', Rule::in(['below_input', 'above_input'])],'properties.*.hidden' => 'boolean|nullable','properties.*.required' => 'boolean|nullable','properties.*.multiple' => 'boolean|nullable',diff --git a/resources/js/components/forms/CheckboxInput.vue b/resources/js/components/forms/CheckboxInput.vueindex 406fafa3e..b960b03d8 100644--- a/resources/js/components/forms/CheckboxInput.vue+++ b/resources/js/components/forms/CheckboxInput.vue@@ -1,12 +1,15 @@<template><div :class="wrapperClass">+ <small v-if="help && helpPosition=='above_input'" :class="theme.default.help" class="flex mb-1">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small><v-checkbox :id="id?id:name" v-model="compVal" :disabled="disabled" :name="name" @input="$emit('input',$event)"><slot name="label">{{ label }} <span v-if="required" class="text-red-500 required-dot">*</span></slot></v-checkbox>- <small v-if="help" :class="theme.default.help">- <slot name="help">{{ help }}</slot>+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" /></div>diff --git a/resources/js/components/forms/CodeInput.vue b/resources/js/components/forms/CodeInput.vueindex 07bdc0675..8526df70e 100644--- a/resources/js/components/forms/CodeInput.vue+++ b/resources/js/components/forms/CodeInput.vue@@ -16,7 +16,7 @@/><small v-if="help" :class="theme.CodeInput.help">- <slot name="help">{{ help }}</slot>+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" /></div>diff --git a/resources/js/components/forms/ColorInput.vue b/resources/js/components/forms/ColorInput.vueindex 1b5f7429c..c26325965 100644--- a/resources/js/components/forms/ColorInput.vue+++ b/resources/js/components/forms/ColorInput.vue@@ -9,7 +9,7 @@<span v-if="required" class="text-red-500 required-dot">*</span></label><small v-if="help" :class="theme.default.help">- <slot name="help">{{ help }}</slot>+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" /></div>diff --git a/resources/js/components/forms/DateInput.vue b/resources/js/components/forms/DateInput.vueindex 67865fec8..060fced24 100644--- a/resources/js/components/forms/DateInput.vue+++ b/resources/js/components/forms/DateInput.vue@@ -6,6 +6,9 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>+ <small v-if="help && helpPosition=='above_input'" :class="theme.default.help" class="flex mb-1">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small><div class="flex" v-if="!dateRange"><input :type="useTime ? 'datetime-local' : 'date'" :id="id?id:name" v-model="fromDate" :class="inputClasses" :disabled="disabled"@@ -28,8 +31,8 @@</div></div>- <small v-if="help" :class="theme.default.help">- <slot name="help">{{ help }}</slot>+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name"/></div>diff --git a/resources/js/components/forms/FileInput.vue b/resources/js/components/forms/FileInput.vueindex b2f3ae5f6..7f7104f51 100644--- a/resources/js/components/forms/FileInput.vue+++ b/resources/js/components/forms/FileInput.vue@@ -6,6 +6,9 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>+ <small v-if="help && helpPosition=='above_input'" :class="theme.default.help" class="flex mb-1">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small><span class="inline-block w-full rounded-md shadow-sm"><button type="button" aria-haspopup="listbox" aria-expanded="true" aria-labelledby="listbox-label" role="button"class="cursor-pointer relative flex"@@ -60,8 +63,8 @@</template></button></span>- <small v-if="help" :class="theme.default.help">- <slot name="help">{{ help }}</slot>+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" />diff --git a/resources/js/components/forms/FlatSelectInput.vue b/resources/js/components/forms/FlatSelectInput.vueindex 74eaee95a..149542223 100644--- a/resources/js/components/forms/FlatSelectInput.vue+++ b/resources/js/components/forms/FlatSelectInput.vue@@ -6,8 +6,8 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>- <small v-if="help" :class="theme.SelectInput.help" class="block mb-2">- <slot name="help">{{ help }}</slot>+ <small v-if="help && helpPosition=='above_input'" :class="theme.SelectInput.help" class="block mb-1">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><loader v-if="loading" key="loader" class="h-6 w-6 text-nt-blue mx-auto" />@@ -25,6 +25,9 @@</div></div>+ <small v-if="help && helpPosition=='below_input'" :class="theme.SelectInput.help" class="block">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small><has-error v-if="hasValidation" :form="form" :field="name" /></div></template>diff --git a/resources/js/components/forms/ImageInput.vue b/resources/js/components/forms/ImageInput.vueindex 617c7b2a2..5ecf20a2e 100644--- a/resources/js/components/forms/ImageInput.vue+++ b/resources/js/components/forms/ImageInput.vue@@ -36,7 +36,7 @@</button></span><small v-if="help" :class="theme.default.help">- <slot name="help">{{ help }}</slot>+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" />diff --git a/resources/js/components/forms/RatingInput.vue b/resources/js/components/forms/RatingInput.vueindex 0e10a8abf..f5080f239 100644--- a/resources/js/components/forms/RatingInput.vue+++ b/resources/js/components/forms/RatingInput.vue@@ -6,6 +6,9 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>+ <small v-if="help && helpPosition=='above_input'" :class="theme.default.help" class="flex mb-1">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small><div class="stars-outer"><div v-for="i in numberOfStars" :key="i"@@ -23,8 +26,8 @@</div></div>- <small v-if="help" :class="theme.default.help">- <slot name="help">{{ help }}</slot>+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" /></div>diff --git a/resources/js/components/forms/RichTextAreaInput.vue b/resources/js/components/forms/RichTextAreaInput.vueindex c1a6458fe..00b12f960 100644--- a/resources/js/components/forms/RichTextAreaInput.vue+++ b/resources/js/components/forms/RichTextAreaInput.vue@@ -6,14 +6,19 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>+ <div v-if="help && helpPosition=='above_input'" class="flex mb-1">+ <small :class="theme.RichTextAreaInput.help" class="grow">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small>+ </div><vue-editor :id="id?id:name" ref="editor" v-model="compVal" :disabled="disabled":placeholder="placeholder" :class="[{ '!ring-red-500 !ring-2': hasValidation && form.errors.has(name), '!cursor-not-allowed !bg-gray-200':disabled }, theme.RichTextAreaInput.input]":editor-toolbar="editorToolbar" class="rich-editor resize-y":style="inputStyle"/>- <small v-if="help" :class="theme.RichTextAreaInput.help">- <slot name="help">{{ help }}</slot>+ <small v-if="help && helpPosition=='below_input'" :class="theme.RichTextAreaInput.help">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" /></div>diff --git a/resources/js/components/forms/SelectInput.vue b/resources/js/components/forms/SelectInput.vueindex 5f14ac056..34beb0c5e 100644--- a/resources/js/components/forms/SelectInput.vue+++ b/resources/js/components/forms/SelectInput.vue@@ -17,6 +17,8 @@:has-error="hasValidation && form.errors.has(name)":allowCreation="allowCreation":disabled="disabled"+ :help="help"+ :help-position="helpPosition"@update-options="updateOptions">@@ -55,9 +57,7 @@</slot></template></v-select>- <small v-if="help" :class="theme.SelectInput.help">- <slot name="help">{{ help }}</slot>- </small>+<has-error v-if="hasValidation" :form="form" :field="name" /></div></template>diff --git a/resources/js/components/forms/SignatureInput.vue b/resources/js/components/forms/SignatureInput.vueindex 587281281..a6e86994b 100644--- a/resources/js/components/forms/SignatureInput.vue+++ b/resources/js/components/forms/SignatureInput.vue@@ -6,6 +6,11 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>+ <div v-if="help && helpPosition=='above_input'" class="flex mb-1">+ <small :class="theme.default.help" class="flex-grow">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small>+ </div><VueSignaturePad ref="signaturePad":class="[theme.default.input,{ '!ring-red-500 !ring-2': hasValidation && form.errors.has(name), '!cursor-not-allowed !bg-gray-200':disabled }]" height="150px"@@ -14,7 +19,7 @@/><div class="flex">- <small v-if="help" :class="theme.default.help" class="flex-grow">+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help" class="flex-grow"><slot name="help"><span class="field-help" v-html="help" /></slot></small><small v-else class="flex-grow" />diff --git a/resources/js/components/forms/TextAreaInput.vue b/resources/js/components/forms/TextAreaInput.vueindex 45b4d7b4b..a25e83a87 100644--- a/resources/js/components/forms/TextAreaInput.vue+++ b/resources/js/components/forms/TextAreaInput.vue@@ -6,6 +6,11 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>+ <div v-if="help && helpPosition=='above_input'" class="flex mb-1">+ <small :class="theme.default.help" class="flex-grow">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small>+ </div><textarea :id="id?id:name" v-model="compVal" :disabled="disabled":class="[theme.default.input,{ '!ring-red-500 !ring-2': hasValidation && form.errors.has(name), '!cursor-not-allowed !bg-gray-200':disabled }]"class="resize-y"@@ -13,9 +18,9 @@:placeholder="placeholder":maxlength="maxCharLimit"/>- <div v-if="help || showCharLimit" class="flex">- <small v-if="help" :class="theme.default.help" class="flex-grow">- <slot name="help">{{ help }}</slot>+ <div v-if="(help && helpPosition=='below_input') || showCharLimit" class="flex">+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help" class="flex-grow">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><small v-else class="flex-grow"></small><small v-if="showCharLimit && maxCharLimit" :class="theme.default.help">diff --git a/resources/js/components/forms/TextInput.vue b/resources/js/components/forms/TextInput.vueindex b04e9e6db..3c10ed8c2 100644--- a/resources/js/components/forms/TextInput.vue+++ b/resources/js/components/forms/TextInput.vue@@ -8,6 +8,11 @@<span v-if="required" class="text-red-500 required-dot">*</span></label></slot>+ <div v-if="help && helpPosition=='above_input'" class="flex mb-1">+ <small :class="theme.default.help" class="grow">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small>+ </div><input :id="id?id:name" v-model="compVal" :disabled="disabled":type="nativeType":style="inputStyle"@@ -16,9 +21,9 @@:placeholder="placeholder" :min="min" :max="max" :maxlength="maxCharLimit"@change="onChange" @keydown.enter.prevent="onEnterPress">- <div v-if="help || showCharLimit" class="flex">- <small v-if="help" :class="theme.default.help" class="flex-grow">- <slot name="help">{{ help }}</slot>+ <div v-if="(help && helpPosition=='below_input') || showCharLimit" class="flex">+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help" class="flex-grow">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><small v-else class="flex-grow"></small><small v-if="showCharLimit && maxCharLimit" :class="theme.default.help">diff --git a/resources/js/components/forms/ToggleSwitchInput.vue b/resources/js/components/forms/ToggleSwitchInput.vueindex 197a36f7e..f1d31442c 100644--- a/resources/js/components/forms/ToggleSwitchInput.vue+++ b/resources/js/components/forms/ToggleSwitchInput.vue@@ -1,11 +1,14 @@<template><div :class="wrapperClass">+ <small v-if="help && helpPosition=='above_input'" :class="theme.default.help" class="flex mb-1">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small><div class="flex"><v-switch :id="id?id:name" v-model="compVal" class="inline-block mr-2" :disabled="disabled" :name="name" @input="$emit('input',$event)" /><span>{{ label }} <span v-if="required" class="text-red-500 required-dot">*</span></span></div>- <small v-if="help" :class="theme.default.help">- <slot name="help">{{ help }}</slot>+ <small v-if="help && helpPosition=='below_input'" :class="theme.default.help">+ <slot name="help"><span class="field-help" v-html="help" /></slot></small><has-error v-if="hasValidation" :form="form" :field="name" /></div>diff --git a/resources/js/components/forms/components/VSelect.vue b/resources/js/components/forms/components/VSelect.vueindex e6768711f..406b467bd 100644--- a/resources/js/components/forms/components/VSelect.vue+++ b/resources/js/components/forms/components/VSelect.vue@@ -6,6 +6,9 @@{{ label }}<span v-if="required" class="text-red-500 required-dot">*</span></label>+ <small v-if="help && helpPosition=='above_input'" :class="theme.SelectInput.help" class="flex mb-1">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small><div v-on-clickaway="closeDropdown"class="relative"@@ -73,6 +76,10 @@</ul></div></div>++ <small v-if="help && helpPosition=='below_input'" :class="theme.SelectInput.help">+ <slot name="help"><span class="field-help" v-html="help" /></slot>+ </small></div></template>@@ -108,7 +115,9 @@ export default {uppercaseLabels: { type: Boolean, default: true },theme: { type: Object, default: () => themes.default },allowCreation: { type: Boolean, default: false },- disabled: { type: Boolean, default: false }+ disabled: { type: Boolean, default: false },+ help: { type: String, default: null },+ helpPosition: { type: String, default: 'below_input' },},data () {return {diff --git a/resources/js/components/open/forms/OpenForm.vue b/resources/js/components/open/forms/OpenForm.vueindex 1ec175a83..73702d6f6 100644--- a/resources/js/components/open/forms/OpenForm.vue+++ b/resources/js/components/open/forms/OpenForm.vue@@ -462,6 +462,7 @@ export default {color: this.form.color,placeholder: field.placeholder,help: field.help,+ helpPosition: (field.help_position) ? field.help_position : 'below_input',uppercaseLabels: this.form.uppercase_labels,theme: this.theme,maxCharLimit: (field.max_char_limit) ? parseInt(field.max_char_limit) : 2000,diff --git a/resources/js/components/open/forms/components/FormFieldsEditor.vue b/resources/js/components/open/forms/components/FormFieldsEditor.vueindex 08a6da384..eff4da2dd 100644--- a/resources/js/components/open/forms/components/FormFieldsEditor.vue+++ b/resources/js/components/open/forms/components/FormFieldsEditor.vue@@ -268,6 +268,7 @@ export default {field.placeholder = field.placeholder || nullfield.prefill = field.prefill || nullfield.help = field.help || null+ field.help_position = field.help_position || 'below_input'return field})diff --git a/resources/js/components/open/forms/components/form-components/AddFormBlockModal.vue b/resources/js/components/open/forms/components/form-components/AddFormBlockModal.vueindex 7acb73d21..68fcd93b1 100644--- a/resources/js/components/open/forms/components/form-components/AddFormBlockModal.vue+++ b/resources/js/components/open/forms/components/form-components/AddFormBlockModal.vue@@ -295,6 +295,7 @@ export default {if (['select', 'multi_select'].includes(this.blockForm.type)) {data[this.blockForm.type] = {'options': []}}+ data.help_position = 'below_input'this.$emit('block-added', data)this.close()},diff --git a/resources/js/components/open/forms/fields/FormBlockOptionsModal.vue b/resources/js/components/open/forms/fields/FormBlockOptionsModal.vueindex ace98fb64..fa9f01915 100644--- a/resources/js/components/open/forms/fields/FormBlockOptionsModal.vue+++ b/resources/js/components/open/forms/fields/FormBlockOptionsModal.vue@@ -144,7 +144,11 @@ export default {}},data() {- return {}+ return {+ editorToolbarCustom: [+ ['bold', 'italic', 'underline', 'link'],+ ]+ }},computed: {},@@ -172,6 +176,11 @@ export default {if (this.field.hidden) {this.$set(this.field, 'required', false)}+ },+ onFieldHelpPositionChange (val) {+ if(!val){+ this.$set(this.field, 'help_position', 'below_input')+ }}}}diff --git a/resources/js/components/open/forms/fields/FormFieldOptionsModal.vue b/resources/js/components/open/forms/fields/FormFieldOptionsModal.vueindex d788bc4ad..4d34944b7 100644--- a/resources/js/components/open/forms/fields/FormFieldOptionsModal.vue+++ b/resources/js/components/open/forms/fields/FormFieldOptionsModal.vue@@ -222,7 +222,7 @@</h3><p class="text-gray-400 mb-5">- Change your form field name, pre-fill a value, add hints.+ Change your form field name, pre-fill a value, add hints, etc.</p><text-input name="name" class="mt-4"@@ -275,14 +275,6 @@label="Empty Input Text (Placeholder)"/>- <!-- Help -->- <text-input name="help" class="mt-4"- :form="field"- label="Field Help"-- help="Your field help will be shown below the field, just like this message."- />-<select-input name="width" class="mt-4":options="[{name:'Full',value:'full'},@@ -295,6 +287,23 @@:form="field" label="Field Width"/>+ <!-- Help -->+ <rich-text-area-input name="help" class="mt-4"+ :form="field"+ :editorToolbar="editorToolbarCustom"+ label="Field Help"+ help="Your field help will be shown below/above the field, just like this message."+ :help-position="field.help_position"+ />+ <select-input name="help_position" class="mt-4"+ :options="[+ {name:'Below input',value:'below_input'},+ {name:'Above input',value:'above_input'},+ ]"+ :form="field" label="Field Help Position"+ @input="onFieldHelpPositionChange"+ />+<template v-if="['text','number','url','email','phone_number'].includes(field.type)"><text-input v-model="field.max_char_limit" name="max_char_limit" native-type="number" :min="1" :max="2000":form="field"@@ -379,7 +388,10 @@ export default {},data() {return {- typesWithoutPlaceholder: ['date', 'checkbox', 'files']+ typesWithoutPlaceholder: ['date', 'checkbox', 'files'],+ editorToolbarCustom: [+ ['bold', 'italic', 'underline', 'link'],+ ]}},@@ -546,6 +558,11 @@ export default {this.$set(this.field, 'disable_past_dates', false)this.$set(this.field, 'prefill_today', false)}+ },+ onFieldHelpPositionChange (val) {+ if (!val) {+ this.$set(this.field, 'help_position', 'below_input')+ }}}}diff --git a/resources/js/mixins/forms/input.js b/resources/js/mixins/forms/input.jsindex 36e2a48d5..1e5b83a96 100644--- a/resources/js/mixins/forms/input.js+++ b/resources/js/mixins/forms/input.js@@ -11,7 +11,8 @@ export default {disabled: { type: Boolean, default: false },placeholder: { type: String, default: null },uppercaseLabels: { type: Boolean, default: false },- help: { type: String, default: null }, // Show help or bot+ help: { type: String, default: null },+ helpPosition: { type: String, default: 'below_input' },theme: { type: Object, default: () => themes.default },color: { type: String, default: '#3B82F6' },wrapperClass: { type: String, default: 'relative mb-3' }diff --git a/resources/sass/app.scss b/resources/sass/app.scssindex 7d77dcb72..27806698b 100644--- a/resources/sass/app.scss+++ b/resources/sass/app.scss@@ -46,3 +46,9 @@ body.dark * {.bg-gray-50 {@apply dark:bg-notion-dark-light;}++.field-help {+ p {+ @apply text-gray-400 dark:text-gray-500;+ }+}\ No newline at end of file