Merge pull request #188 from yajra/editor-hiddenOn

feat: hide/show fields based on editor action

Author: yajra

src/Html/Editor/Editor.php

@@ -24,14 +24,14 @@ class Editor extends Fluent
     use HasEvents;
     use HasAuthorizations;
 
-    public array $events = [];
-
     const DISPLAY_LIGHTBOX = 'lightbox';
     const DISPLAY_ENVELOPE = 'envelope';
     const DISPLAY_BOOTSTRAP = 'bootstrap';
     const DISPLAY_FOUNDATION = 'foundation';
     const DISPLAY_JQUERYUI = 'jqueryui';
 
+    public array $events = [];
+
     /**
      * Editor constructor.
      *
@@ -156,30 +156,30 @@ public function fields(array $fields): static
     }
 
     /**
-     * Set Editor's formOptions.
+     * Set Editor's bubble formOptions.
      *
      * @param  array  $formOptions
      * @return $this
-     * @see https://editor.datatables.net/reference/option/formOptions
-     * @see https://editor.datatables.net/reference/type/form-options
+     * @see https://editor.datatables.net/reference/option/formOptions.bubble
      */
-    public function formOptions(array $formOptions): static
+    public function formOptionsBubble(array $formOptions): static
     {
-        $this->attributes['formOptions'] = $formOptions;
-
-        return $this;
+        return $this->formOptions(['bubble' => Helper::castToArray($formOptions)]);
     }
 
     /**
-     * Set Editor's bubble formOptions.
+     * Set Editor's formOptions.
      *
      * @param  array  $formOptions
      * @return $this
-     * @see https://editor.datatables.net/reference/option/formOptions.bubble
+     * @see https://editor.datatables.net/reference/option/formOptions
+     * @see https://editor.datatables.net/reference/type/form-options
      */
-    public function formOptionsBubble(array $formOptions): static
+    public function formOptions(array $formOptions): static
     {
-        return $this->formOptions(['bubble' => Helper::castToArray($formOptions)]);
+        $this->attributes['formOptions'] = $formOptions;
+
+        return $this;
     }
 
     /**
@@ -272,4 +272,53 @@ public function toJson($options = 0): string
 
         return Helper::toJsonScript($parameters, $options);
     }
+
+    /**
+     * Hide fields on create action.
+     *
+     * @param  array  $fields
+     * @return $this
+     */
+    public function hiddenOnCreate(array $fields): static
+    {
+        return $this->hiddenOn('create', $fields);
+    }
+
+    /**
+     * Hide fields on specific action.
+     *
+     * @param  string  $action
+     * @param  array  $fields
+     * @return $this
+     */
+    public function hiddenOn(string $action, array $fields): static
+    {
+        $script = 'function(e, mode, action) {';
+        $script .= "if (action === '$action') {";
+        foreach ($fields as $field) {
+            $script .= "this.hide('$field');";
+        }
+        $script .= '} else {';
+        foreach ($fields as $field) {
+            $script .= "this.show('$field');";
+        }
+        $script .= '}';
+        $script .= 'return true;';
+        $script .= '}';
+
+        $this->onPreOpen($script);
+
+        return $this;
+    }
+
+    /**
+     * Hide fields on edit action.
+     *
+     * @param  array  $fields
+     * @return $this
+     */
+    public function hiddenOnEdit(array $fields): static
+    {
+        return $this->hiddenOn('edit', $fields);
+    }
 }

tests/EditorTest.php

@@ -59,6 +59,25 @@ public function it_can_have_events()
         $this->assertEquals($event, $editor->events[0]);
     }
 
+    /** @test */
+    public function it_can_show_hide_fields()
+    {
+        $editor = $this->getEditor();
+
+        $editor->hiddenOnCreate(['name']);
+        $editor->hiddenOnEdit(['email']);
+
+        $this->assertCount(2, $editor->events);
+
+        $this->assertEquals('preOpen', $editor->events[0]['event']);
+        $this->assertStringContainsString("action === 'create'", $editor->events[0]['script']);
+        $this->assertStringContainsString("this.hide('name')", $editor->events[0]['script']);
+
+        $this->assertEquals('preOpen', $editor->events[1]['event']);
+        $this->assertStringContainsString("action === 'edit'", $editor->events[1]['script']);
+        $this->assertStringContainsString("this.hide('email')", $editor->events[1]['script']);
+    }
+
     /** @test */
     public function it_has_authorizations()
     {