feat: hide empty errors option

Author: tobimori

config/options.php

@@ -17,6 +17,7 @@
 	],
 	'useDataAttributes' => false, // uses data-form-url instead of action
 	'mode' => 'prg', // prg / api / htmx
+	'hideEmptyErrors' => false, // hide error elements when there's no error message
 	'multiStep' => true, // Enable multi-step forms
 	'storeSubmissions' => true, // Store submissions in the content folder
 	'partialSubmissions' => true, // Allow partial submissions toggle in panel (requires precognition)

snippets/fields/partials/error.php

@@ -10,8 +10,12 @@
  */
 
 use Kirby\Toolkit\A;
+use tobimori\DreamForm\DreamForm;
 
-$error = $submission?->errorFor($block->key(), $form) ?>
+$error = $submission?->errorFor($block->key(), $form);
+$hideEmptyErrors = DreamForm::option('hideEmptyErrors');
+
+if (!$hideEmptyErrors || $error) : ?>
 
 <span <?= attr(A::merge(
 	$attr['error'] ?? [],
@@ -21,4 +25,6 @@
 		'role' => 'alert',
 		'aria-atomic' => true
 	]
-)) ?>><?= $error ?></span>
+)) ?>><?= $error ?></span>
+
+<?php endif; ?>

snippets/form.php

@@ -10,6 +10,7 @@
  */
 
 use Kirby\Toolkit\A;
+use tobimori\DreamForm\DreamForm;
 
 $attr = A::merge([
 	// general attributes
@@ -98,16 +99,21 @@
 )) ?>>
 	<?php snippet('dreamform/session', ['form' => $form, 'submission' => $submission]) ?>
 
-	<div <?= attr(A::merge(['data-error' => true, 'role' => 'alert', 'aria-atomic' => true], $attr['error'])) ?>><?= $submission?->errorFor(null, $form) ?></div>
+	<?php
+	$formError = $submission?->errorFor(null, $form);
+$hideEmptyErrors = DreamForm::option('hideEmptyErrors');
+if (!$hideEmptyErrors || $formError) : ?>
+		<div <?= attr(A::merge(['data-error' => true, 'role' => 'alert', 'aria-atomic' => true], $attr['error'])) ?>><?= $formError ?></div>
+	<?php endif; ?>
 
 	<?php foreach ($form->currentLayouts() as $layoutRow) : ?>
 		<div <?= attr(A::merge($attr['row'], [
-			'style' => 'display: grid; grid-template-columns: repeat(12, 1fr);',
-		])) ?>>
+		'style' => 'display: grid; grid-template-columns: repeat(12, 1fr);',
+	])) ?>>
 			<?php foreach ($layoutRow->columns() as $layoutColumn) : ?>
 				<div <?= attr(A::merge($attr['column'], [
-					'style' => "grid-column-start: span {$layoutColumn->span(12)};",
-				])) ?>>
+				'style' => "grid-column-start: span {$layoutColumn->span(12)};",
+			])) ?>>
 					<?php foreach ($layoutColumn->blocks() as $block) {
 						// get the field instance to access field methods
 						$field = $block->toFormField($form->formFields());
@@ -128,4 +134,4 @@
 			<?php endforeach ?>
 		</div>
 	<?php endforeach; ?>
-</form>
+</form>