tobimori / kirby-dreamform

✨ DreamForm is an opiniated form builder plugin for Kirby CMS that makes forms work like magic

Kirby DreamForm

DreamForm is an opiniated form builder plugin for Kirby CMS that makes forms work like magic.

---

Create powerful single or multi-step forms with a Layout builder directly inside your panel. Create complex submission behaviour workflows with actions. DreamForm supports numerous built-in fieldtypes & actions, but can be expanded and customized as easily as Kirby itself.

Read more about DreamForm on the official plugin website.

Comparison

Feature Comparison	DreamForm	Form Block Suite	Uniform1
Pricing (per license/site)	45 €	25 US$	Free
Single-step forms	✅	✅	✅
Multi-step forms	✅
Create custom forms	✅	✅	✅
...with Blocks in the panel	✅	✅
...with Layouts (multi-column) in the panel	✅
Customize behaviour after submission	✅	✅	✅
...in the panel	✅
...using hooks	✅	✅
Use with JavaScript (API submission)	✅	✅	✅
Use without JavaScript (Form submission)	✅		✅
First-party HTMX support	✅
Built-in fields
Text	✅	✅	2
Multi-line text	✅	✅	2
Email	✅	✅ (using Input)	2
Number	✅	✅ (using Input)	2
Select	✅	✅	2
Radio	✅	✅	2
Checkboxes	✅	✅	2
File uploads	✅	✅	2
Built-in actions
Email	✅	✅	✅
Redirect	✅	✅	✅
Abort	✅		✅
Webhook	✅		✅
Conditional Action	✅
Buttondown	✅ 1.1+
Discord	✅
Mailchimp	✅ 1.2+
Built-in guards
Akismet	✅ 1.1+
CSRF	✅		✅
IP-based Rate limiting	✅
Honeypot	✅	✅	✅
Turnstile Captcha	✅		via third-party plugin
Other
Re-use forms in different places	✅	Each block is a unique form
Mark submissions for spam	✅ 1.1+
Stores submissions in the panel	✅	Sent emails will be stored
Permissions for limiting access	✅
Gravatar integration	✅
Disposable & invalid email domain check	✅ 1.1+

¹ Technically, you can built most of the features that DreamForm offers yourself using Uniform. For a fair comparison, this table only includes features that can be solved by copying code from the official docs & without writing custom code.

² Since Uniform focuses on form validation, all fields are technically possible, but none ship with pre-built HTML snippets.

License

Kirby DreamForm is not free software. In order to run it on a public server, you'll have to purchase a valid Kirby license & a valid DreamForm license.

Copyright 2024 © Tobias Möritz - Love & Kindness GmbH

---

The plugins' name is a homage to Kirby's Dream Land.

kirby-dreamform's Issues

Form snippet doesn't work with Twig templates

Hello, I use Twig plugin on my Kirby projects and recently I tried to use your plugin. There is a issue with slots: snippet throws error "**Undefined variable $slot **".
It seems similar to #37.

Could you point me to a solution?

Redirect does not work on subpath installation (e.g. example.com/website/form) (infinite recursion)

Always inject guards, even without button

Currently, it's not possible to use forms without a Button field, however you can still submit them using hotkeys.

Select fields do not retain their values on page reload when form does not validate

When trying to submit a form that does not validate, the page gets reloaded showing an error message. If I have selected an option from a select-field before submitting, my choice gets lost and I have to select the desired option again.

The expected result would be for the option to be remembered and kept until the form is successfully submitted.

As a sidenote: is there a special reason why the required-attribute is not inserted in required fields? This would add an extra-validation layer before submission and is supported by virtually all modern browsers.

Numbers as values are not read correctly

First of all, great plugin!

I made a set of radio buttons for a 5-star rating system: Value for the first option is "1", label is "⭐️", and so on...

Answers (values) are correct stored in the content files, but not displayed in the structure field in the panel as answers (empty column).

The other way round, value is "⭐️" and label is "1", it works.

Undefined variable $append

When using Kirby's cache and something other than the api mode I get this error when submitting forms:

Whoops\Exception\ErrorException thrown with message "Undefined variable $append"

Stacktrace:
#6 Whoops\Exception\ErrorException in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Models/SubmissionPage.php:273
#5 Whoops\Run:handleError in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Models/SubmissionPage.php:273
#4 tobimori\DreamForm\Models\SubmissionPage:redirectToReferer in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Models/FormPage.php:368
#3 tobimori\DreamForm\Models\FormPage:render in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/kirby/src/Cms/App.php:775
#2 Kirby\Cms\App:io in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/kirby/src/Cms/App.php:1189
#1 Kirby\Cms\App:render in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/index.php:5
#0 require in /Applications/Herd.app/Contents/Resources/valet/server.php:151

I'd suggest the following change:

return  $kirby->response()->redirect(
-  ($this->referer() ?? $this->site()->url()) . isset($append) ? $append : ''
+ ($this->referer() ?? $this->site()->url()) . (isset($append) ? $append : '')
);

Scroll to success message in HTMX mode

How do you scroll to the success message on long pages with forms when using the HTMX mode? Do I have to hook into HTMX's events?

Email action does not work with file field in form

Will there come an export function?

Your plugin looks very useful. I'm just missing one thing, an export function of the form submissions.

Whitespace in field label spans

On a regular text field there is whitespace before and after the actual text, which can lead to styling problems:

<span>
		Termin	</span>

Implement custom error message when sender email is empty ("" is not a valid email address)

I just can't seem to get this plugin to work.

No matter what I do, after I add the email action I get an error "" is not a valid email address. It doesn't matter if I choose "static" or "from user input" in the action block. The email address doesn't seem to matter either. Once I remove the block it works (the submission in the panel).

Form snippet not working with Blade templating

Error location:
/var/www/html/site/plugins/kirby-dreamform/snippets/fields/partials/wrapper.php

When I follow the instructions from Using Forms
I get **Undefined variable $slot **.

Empty referer crashes page

Sorry but after solving #23 I run into the next breaking error. Somehow my referer seems to be null while the function expects a string?

TypeError thrown with message "tobimori\DreamForm\DreamForm::findPageOrDraftRecursive(): Argument #1 ($path) must be of type string, null given, called in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Models/SubmissionPage.php on line 41"

Stacktrace:
#10 TypeError in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/DreamForm.php:180
#9 tobimori\DreamForm\DreamForm:findPageOrDraftRecursive in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Models/SubmissionPage.php:41
#8 tobimori\DreamForm\Models\SubmissionPage:findRefererPage in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Actions/EmailAction.php:153
#7 tobimori\DreamForm\Actions\EmailAction:templateValues in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Actions/EmailAction.php:181
#6 tobimori\DreamForm\Actions\EmailAction:subject in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Actions/EmailAction.php:208
#5 tobimori\DreamForm\Actions\EmailAction:run in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Models/FormPage.php:284
#4 tobimori\DreamForm\Models\FormPage:submit in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/site/plugins/kirby-dreamform/classes/Models/FormPage.php:325
#3 tobimori\DreamForm\Models\FormPage:render in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/kirby/src/Cms/App.php:775
#2 Kirby\Cms\App:io in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/kirby/src/Cms/App.php:1189
#1 Kirby\Cms\App:render in /Users/thguenther/Arbeit/Projekte/VerlageGegenRechts/index.php:5
#0 require in /Applications/Herd.app/Contents/Resources/valet/server.php:151

"Report as Spam" dialog doesn't have any text

Empty error-div is included already on load and if there is no error.

The following code is always included in the form. Apart from semantic/redundancy reasons this creates an empty box when styling the error message with a background and padding:

<div class="error" data-error=""></div>

Edge cases when using multiple forms on the same page

If I am not missing the obvious and that’s already possible — it would be nice if the page scrolls to the form and/or the error-/success-messages after submit. Otherwise it’s easy to miss submission errors (on longer pages where the form is further down).

Obviously this would be easy with a #-link, but I have no idea how to implement this, and hardcoding an URL is not an option.

postinstall command does not work with public folder directories

• Consider migrating to a Kirby CLI command that's run manually for now

Workaround:
Use the manual installation directions for now

Install command not working, ID is set randomly on a multi-site

Discover creating the page automatically when it's accessed