Add ability to redirect after form submission (#64)

aerni · Jun 17, 2024 · 246a8f5 · 246a8f5
1 parent cfac89e
commit 246a8f5
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ import Clipboard from '@ryangjchandler/alpine-clipboard'
 + import "../../vendor/aerni/livewire-forms/resources/dist/js/livewire-forms";
 
 Alpine.plugin(Clipboard)
- 
+
 Livewire.start()
 ```
 
@@ -47,14 +47,14 @@ Then, add the `{{ livewire:styles }}` and `{{ livewire:scriptConfig }}` tags to
     <head>
         <!-- Antlers -->
         {{ livewire:styles }}
-    
+
         <!-- Blade -->
         @livewireStyles
     </head>
     <body>
         <!-- Antlers -->
         {{ livewire:scriptConfig }}
-    
+
         <!-- Blade -->
         @livewireScriptConfig
     </body>
@@ -128,11 +128,12 @@ Use the `view` and `theme` parameters if you want to use a view or theme that is
 
 #### Available Properties
 
-| Property | Description                                       |
-| -------- | ------------------------------------------------- |
-| `handle` | The handle of the form you want to use (required) |
-| `view`   | The component view you want to use (optional)     |
-| `theme`  | The theme you want to use (optional)              |
+| Property   | Description                                                           |
+| ---------- | --------------------------------------------------------------------- |
+| `handle`   | The handle of the form you want to use (required)                     |
+| `view`     | The component view you want to use (optional)                         |
+| `theme`    | The theme you want to use (optional)                                  |
+| `redirect` | Redirect the user to this URL after successfull submission (optional) |
 
 ## Views
 
@@ -419,7 +420,7 @@ Lastly, we need to render our new `ContactForm` component in the template.
 
 ### Validation Rules
 
-You can use any validation rule you want. Simply add it to the field in the form blueprint or use the blueprint builder in the CP. 
+You can use any validation rule you want. Simply add it to the field in the form blueprint or use the blueprint builder in the CP.
 
 To validate against the value of another field, you need to get its value like in the following example:
 

diff --git a/resources/views/dynamic-form.blade.php b/resources/views/dynamic-form.blade.php
@@ -1,3 +1,3 @@
 <div>
-    <livewire:dynamic-component :is="$this->component" :$handle :$theme :$type :$view />
+    <livewire:dynamic-component :is="$this->component" :$handle :$theme :$type :$view :$redirect />
 </div>
diff --git a/src/Commands/form.stub b/src/Commands/form.stub
@@ -25,6 +25,7 @@ class [class] extends BaseForm
     //     $this->theme = 'secondary';
     //     $this->type = 'wizard';
     //     $this->view = 'default';
+    //     $this->redirect = 'thank-you';
     // }
 
     /*

diff --git a/src/Livewire/BaseForm.php b/src/Livewire/BaseForm.php
@@ -8,6 +8,7 @@
 use Aerni\LivewireForms\Livewire\Concerns\WithForm;
 use Aerni\LivewireForms\Livewire\Concerns\WithHandle;
 use Aerni\LivewireForms\Livewire\Concerns\WithMessages;
+use Aerni\LivewireForms\Livewire\Concerns\WithRedirect;
 use Aerni\LivewireForms\Livewire\Concerns\WithSections;
 use Aerni\LivewireForms\Livewire\Concerns\WithSteps;
 use Aerni\LivewireForms\Livewire\Concerns\WithTheme;
@@ -27,6 +28,7 @@ class BaseForm extends Component
     use WithSections;
     use WithSteps;
     use WithMessages;
+    use WithRedirect;
     use SubmitsForm;
 
     public function render(): View

diff --git a/src/Livewire/Concerns/HandlesSuccess.php b/src/Livewire/Concerns/HandlesSuccess.php
@@ -6,9 +6,14 @@
 
 trait HandlesSuccess
 {
-    protected function handleSuccess(): self
+    protected function handleSuccess(): ?self
     {
         session()->flash('success', $this->successMessage());
+        session()->flash('submission', $this->submission);
+
+        if (! empty($this->redirect)) {
+            return $this->redirect($this->redirect);
+        }
 
         if (! $this->isWizardForm()) {
             $this->resetForm();

diff --git a/src/Livewire/Concerns/WithRedirect.php b/src/Livewire/Concerns/WithRedirect.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Aerni\LivewireForms\Livewire\Concerns;
+
+use Livewire\Attributes\Locked;
+
+trait WithRedirect
+{
+    #[Locked]
+    public string $redirect = '';
+}
diff --git a/src/Livewire/DynamicForm.php b/src/Livewire/DynamicForm.php
@@ -4,6 +4,7 @@
 
 use Aerni\LivewireForms\Livewire\Concerns\WithComponent;
 use Aerni\LivewireForms\Livewire\Concerns\WithHandle;
+use Aerni\LivewireForms\Livewire\Concerns\WithRedirect;
 use Aerni\LivewireForms\Livewire\Concerns\WithTheme;
 use Aerni\LivewireForms\Livewire\Concerns\WithType;
 use Aerni\LivewireForms\Livewire\Concerns\WithView;
@@ -17,6 +18,7 @@ class DynamicForm extends Component
     use WithTheme;
     use WithType;
     use WithView;
+    use WithRedirect;
 
     public function render(): View
     {