feat: confirmation before any action. (#1599)

* adding macros functions and methods for Button class * adding English translations for default message * writing tests for confirm and confirmPrompt method * fix: test ConfirmPromptTest.php * style: adding line break in both macro functions * use camel case for $confirm_value to $confirmValue * adding missing multi_sort translations * adding english lang messages in all language * wip we change lang translation separator(-) to underscore(-) to make it similar to all other translations. * pint --------- Co-authored-by: luanfreitasdev <luanfreitas10@protonmail.com>
Power-Components · Jul 4, 2024 · c0d2be2 · c0d2be2
1 parent 1899b41
commit c0d2be2
Show file tree

Hide file tree

Showing 22 changed files with 252 additions and 0 deletions.
diff --git a/resources/lang/ar/datatable.php b/resources/lang/ar/datatable.php
@@ -62,4 +62,15 @@
         'with_trashed'         => 'مع المحذوف',
         'only_trashed'         => 'فقط محذوف',
     ],
+    'multi_sort' => [
+        'message' => 'Multiple sort is active',
+    ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/ca/datatable.php b/resources/lang/ca/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/cs/datatable.php b/resources/lang/cs/datatable.php
@@ -62,4 +62,15 @@
         'with_trashed'         => 'Se smazanými',
         'only_trashed'         => 'Pouze smazané',
     ],
+    'multi_sort' => [
+        'message' => 'Multiple sort is active',
+    ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/de/datatable.php b/resources/lang/de/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple Suche ist aktiv',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/en/datatable.php b/resources/lang/en/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/es/datatable.php b/resources/lang/es/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/fa/datatable.php b/resources/lang/fa/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/fr/datatable.php b/resources/lang/fr/datatable.php
@@ -65,4 +65,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/id/datatable.php b/resources/lang/id/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Pengurutan ganda diaktifkan',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/it/datatable.php b/resources/lang/it/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/ms_MY/datatable.php b/resources/lang/ms_MY/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/nl/datatable.php b/resources/lang/nl/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Meervoudige sortering is actief',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/pl/datatable.php b/resources/lang/pl/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Wielokolumnowe sortowanie jest aktywne',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/pt_BR/datatable.php b/resources/lang/pt_BR/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'A classificação múltipla está ativa',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/ru/datatable.php b/resources/lang/ru/datatable.php
@@ -65,4 +65,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/tr/datatable.php b/resources/lang/tr/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Çoklu sıralama etkin',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/uk/datatable.php b/resources/lang/uk/datatable.php
@@ -65,4 +65,12 @@
     'multi_sort' => [
         'message' => 'Сортувати за',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/resources/lang/yr/datatable.php b/resources/lang/yr/datatable.php
@@ -64,4 +64,12 @@
     'multi_sort' => [
         'message' => 'Multiple sort is active',
     ],
+    'buttons_macros' => [
+        'confirm' => [
+            'message' => 'Are you sure you want to perform this action?',
+        ],
+        'confirm_prompt' => [
+            'message' => "Are you sure you want to perform this action? \n\n Enter :confirmValue to confirm.",
+        ],
+    ],
 ];
diff --git a/src/Button.php b/src/Button.php
@@ -21,6 +21,8 @@
  * @method static bladeComponent(string $component, array $params)
  * @method static can(bool|\Closure $allowed = true)
  * @method static id(string $id = null)
+ * @method static confirm(string $message = 'Are you sure you want to perform this action?')
+ * @method static confirmPrompt(string $message = 'Are you sure you want to perform this action?', string $confirmValue = 'Confirm')
  *
  */
 final class Button implements Wireable

diff --git a/src/Components/Actions/Macros.php b/src/Components/Actions/Macros.php
@@ -194,5 +194,27 @@ public static function boot(): void
 
             return $this;
         });
+
+        Button::macro('confirm', function (?string $message = null) {
+            $this->dynamicProperties['confirm'] = [
+                'component' => 'button',
+                'attribute' => 'wire:confirm',
+                'value'     => $message ?? trans('livewire-powergrid::datatable.buttons_macros.confirm.message'),
+            ];
+
+            return $this;
+        });
+
+        Button::macro('confirmPrompt', function (?string $message = null, string $confirmValue = 'Confirm') {
+            $message                                  = $message ?? trans('livewire-powergrid::datatable.buttons_macros.confirm_prompt.message', ['confirm_value' => $confirmValue]);
+            $confirm_value                            = trim($confirmValue);
+            $this->dynamicProperties['confirmPrompt'] = [
+                'component' => 'button',
+                'attribute' => 'wire:confirm.prompt',
+                'value'     => "$message |$confirmValue",
+            ];
+
+            return $this;
+        });
     }
 }
diff --git a/tests/Feature/Buttons/ConfirmPromptTest.php b/tests/Feature/Buttons/ConfirmPromptTest.php
@@ -0,0 +1,39 @@
+<?php
+
+use PowerComponents\LivewirePowerGrid\Button;
+use PowerComponents\LivewirePowerGrid\Tests\Concerns\Components\DishTableBase;
+
+use function PowerComponents\LivewirePowerGrid\Tests\Plugins\livewire;
+
+$component = new class () extends DishTableBase {
+    public function actions($row): array
+    {
+        return [
+            Button::make('confirm-prompt')
+                ->slot('confirm-prompt: ' . $row->id)
+                ->confirmPrompt("$row->id Are you sure? Enter CONFIRM to confirm", "CONFIRM"),
+        ];
+    }
+};
+
+dataset('action:confirm-prompt', [
+    'tailwind'       => [$component::class, (object) ['theme' => 'tailwind', 'join' => false]],
+    'bootstrap'      => [$component::class, (object) ['theme' => 'bootstrap', 'join' => false]],
+    'tailwind join'  => [$component::class, (object) ['theme' => 'tailwind', 'join' => true]],
+    'bootstrap join' => [$component::class, (object) ['theme' => 'bootstrap', 'join' => true]],
+]);
+
+it('properly displays "confirm" on button click', function (string $component, object $params) {
+    livewire($component, [
+        'join' => $params->join,
+    ])
+        ->call($params->theme)
+        ->set('search', 'Pastel de Nata')
+        ->assertSeeHtml('wire:confirm.prompt="1 Are you sure? Enter CONFIRM to confirm |CONFIRM"')
+        ->assertDontSeeHtml('wire:confirm.prompt="2 Are you sure? Enter CONFIRM to confirm |CONFIRM"')
+        ->set('search', 'Peixada da chef Nábia')
+        ->assertSeeHtml('wire:confirm.prompt="2 Are you sure? Enter CONFIRM to confirm |CONFIRM"')
+        ->assertDontSeeHtml('wire:confirm.prompt="1 Are you sure? Enter CONFIRM to confirm |CONFIRM"');
+})
+    ->with('action:confirm-prompt')
+    ->group('action');
diff --git a/tests/Feature/Buttons/ConfirmTest.php b/tests/Feature/Buttons/ConfirmTest.php
@@ -0,0 +1,39 @@
+<?php
+
+use PowerComponents\LivewirePowerGrid\Button;
+use PowerComponents\LivewirePowerGrid\Tests\Concerns\Components\DishTableBase;
+
+use function PowerComponents\LivewirePowerGrid\Tests\Plugins\livewire;
+
+$component = new class () extends DishTableBase {
+    public function actions($row): array
+    {
+        return [
+            Button::make('confirm')
+                ->slot('confirm: ' . $row->id)
+                ->confirm('Are you sure? ' . $row->id),
+        ];
+    }
+};
+
+dataset('action:confirm', [
+    'tailwind'       => [$component::class, (object) ['theme' => 'tailwind', 'join' => false]],
+    'bootstrap'      => [$component::class, (object) ['theme' => 'bootstrap', 'join' => false]],
+    'tailwind join'  => [$component::class, (object) ['theme' => 'tailwind', 'join' => true]],
+    'bootstrap join' => [$component::class, (object) ['theme' => 'bootstrap', 'join' => true]],
+]);
+
+it('properly displays "confirm" on button click', function (string $component, object $params) {
+    livewire($component, [
+        'join' => $params->join,
+    ])
+        ->call($params->theme)
+        ->set('search', 'Pastel de Nata')
+        ->assertSeeHtml('wire:confirm="Are you sure? 1"')
+        ->assertDontSeeHtml('wire:confirm="Are you sure? 2"')
+        ->set('search', 'Peixada da chef Nábia')
+        ->assertSeeHtml('wire:confirm="Are you sure? 2"')
+        ->assertDontSeeHtml('wire:confirm="Are you sure? 1"');
+})
+    ->with('action:confirm')
+    ->group('action');