Improve Input Switch component (#1317)

* [resources/components]: Input switch value attr may now be customized, using 'true' as default

* [src/Components]: Add new is-checked attribute to input switch

* [test]: Fix code style

* [resources/views]: Add workaround to ensure correct input-switch setup on initialization

resources/views/components/form/input-switch.blade.php

@@ -9,8 +9,8 @@
 @section('input_group_item')
 
     {{-- Input Switch --}}
-    <input type="checkbox" id="{{ $id }}" name="{{ $name }}" value="true"
-        {{ $attributes->merge(['class' => $makeItemClass()]) }}>
+    <input type="checkbox" id="{{ $id }}" name="{{ $name }}"
+        {{ $attributes->merge(['class' => $makeItemClass(), 'value' => 'true']) }}>
 
 @overwrite
 
@@ -20,7 +20,13 @@
 <script>
 
     $(() => {
-        $('#{{ $id }}').bootstrapSwitch( @json($config) );
+
+        let usrCfg = @json($config);
+        $('#{{ $id }}').bootstrapSwitch(usrCfg);
+
+        // Workaround to ensure correct state setup on initialization.
+
+        $('#{{ $id }}').bootstrapSwitch('state', usrCfg.state ?? false);
 
         // Add support to auto select the previous submitted value in case of
         // validation errors.

src/View/Components/Form/InputSwitch.php

@@ -24,14 +24,20 @@ class InputSwitch extends InputGroupComponent
     public function __construct(
         $name, $id = null, $label = null, $igroupSize = null, $labelClass = null,
         $fgroupClass = null, $igroupClass = null, $disableFeedback = null,
-        $errorKey = null, $config = [], $enableOldSupport = null
+        $errorKey = null, $config = [], $isChecked = null,
+        $enableOldSupport = null
     ) {
         parent::__construct(
             $name, $id, $label, $igroupSize, $labelClass, $fgroupClass,
             $igroupClass, $disableFeedback, $errorKey
         );
 
         $this->config = is_array($config) ? $config : [];
+
+        if (isset($isChecked)) {
+            $this->config['state'] = ! empty($isChecked);
+        }
+
         $this->enableOldSupport = isset($enableOldSupport);
     }
 

tests/Components/FormComponentsTest.php

@@ -408,7 +408,39 @@ public function testInputSliderComponentOldSupport()
     |--------------------------------------------------------------------------
     */
 
-    public function testInputSwitchComponent()
+    public function testInputSwitchComponentCheckedState()
+    {
+        // Test the state property isn't defined when is-checked attribute
+        // isn't provided.
+
+        $component = new Components\Form\InputSwitch('name');
+
+        $this->assertArrayNotHasKey('state', $component->config);
+
+        // Test the state property is true when is-checked attribute has a
+        // truthy value.
+
+        foreach ([true, 1, 'true'] as $v) {
+            $component = new Components\Form\InputSwitch(
+                'name', null, null, null, null, null, null, null, null, null, $v
+            );
+
+            $this->assertTrue($component->config['state']);
+        }
+
+        // Test the state property is false when is-checked attribute has a
+        // falsy value.
+
+        foreach ([false, 0, ''] as $v) {
+            $component = new Components\Form\InputSwitch(
+                'name', null, null, null, null, null, null, null, null, null, $v
+            );
+
+            $this->assertFalse($component->config['state']);
+        }
+    }
+
+    public function testInputSwitchComponentWithErrorStyle()
     {
         $component = new Components\Form\InputSwitch(
             'name', null, null, 'lg', null, null, 'igroup-class'
@@ -438,7 +470,7 @@ public function testInputSwitchComponentOldSupport()
         // Test component with old support enabled.
 
         $component = new Components\Form\InputSwitch(
-            'name', null, null, null, null, null, null, null, null, null, true
+            'name', null, null, null, null, null, null, null, null, null, null, true
         );
 
         $this->addInputOnCurrentRequest('name', 'foo');