feat(admin): Add custom dialog titles for Selectize input

Add options `dialog_title_create` and `dialog_title_update` to customize the dialog to create or update an option. Defaults to the property's label.
charcoalphp · Mar 11, 2024 · ffc3382 · ffc3382
1 parent 26018e9
commit ffc3382
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 3 deletions.
diff --git a/packages/admin/assets/dist/scripts/charcoal.admin.js b/packages/admin/assets/dist/scripts/charcoal.admin.js
@@ -10890,6 +10890,8 @@ Charcoal.Admin.Property_Input_SelectPicker.prototype.create_select = function ()
         this.allow_update = opts.data.allow_update || this.allow_update;
         this.allow_create = opts.data.allow_create || this.allow_create;
         this.title = opts.data.title || this.title;
+        this.dialog_title_update = opts.data.dialog_title_update || this.dialog_title_update;
+        this.dialog_title_create = opts.data.dialog_title_create || this.dialog_title_create;
         this.translations = opts.data.translations || this.translations;
         this.pattern = opts.data.pattern || this.pattern;
         this.multiple = opts.data.multiple || this.multiple;
@@ -11043,6 +11045,16 @@ Charcoal.Admin.Property_Input_SelectPicker.prototype.create_select = function ()
         var selectize_property_ident = this.selectize_property_ident;
         var selectize_obj_type = this.selectize_obj_type;
 
+        if (id) {
+            if (this.dialog_title_update) {
+                title = this.dialog_title_update;
+            }
+        } else {
+            if (this.dialog_title_create) {
+                title = this.dialog_title_create;
+            }
+        }
+
         // Get the form ident
         if (form_ident && typeof form_ident === 'object') {
             if (!id && form_ident.create) {

diff --git a/packages/admin/assets/dist/scripts/charcoal.admin.min.js b/packages/admin/assets/dist/scripts/charcoal.admin.min.js
diff --git a/packages/admin/assets/src/scripts/charcoal/admin/property/input/selectize.js b/packages/admin/assets/src/scripts/charcoal/admin/property/input/selectize.js
@@ -82,6 +82,8 @@
         this.allow_update = opts.data.allow_update || this.allow_update;
         this.allow_create = opts.data.allow_create || this.allow_create;
         this.title = opts.data.title || this.title;
+        this.dialog_title_update = opts.data.dialog_title_update || this.dialog_title_update;
+        this.dialog_title_create = opts.data.dialog_title_create || this.dialog_title_create;
         this.translations = opts.data.translations || this.translations;
         this.pattern = opts.data.pattern || this.pattern;
         this.multiple = opts.data.multiple || this.multiple;
@@ -235,6 +237,16 @@
         var selectize_property_ident = this.selectize_property_ident;
         var selectize_obj_type = this.selectize_obj_type;
 
+        if (id) {
+            if (this.dialog_title_update) {
+                title = this.dialog_title_update;
+            }
+        } else {
+            if (this.dialog_title_create) {
+                title = this.dialog_title_create;
+            }
+        }
+
         // Get the form ident
         if (form_ident && typeof form_ident === 'object') {
             if (!id && form_ident.create) {

diff --git a/packages/admin/src/Charcoal/Admin/Property/Input/SelectizeInput.php b/packages/admin/src/Charcoal/Admin/Property/Input/SelectizeInput.php
@@ -109,6 +109,20 @@ class SelectizeInput extends SelectInput
      */
     private $formData;
 
+    /**
+     * Label for the create item dialog.
+     *
+     * @var \Charcoal\Translator\Translation|string|null
+     */
+    private $dialogTitleCreate;
+
+    /**
+     * Label for the update item dialog.
+     *
+     * @var \Charcoal\Translator\Translation|string|null
+     */
+    private $dialogTitleUpdate;
+
     /**
      * Check used to parse multi Choice map against the obj properties.
      *
@@ -433,6 +447,52 @@ public function formIdentAsJson()
         return json_encode($this->formIdent());
     }
 
+    /**
+     * Set the title for the create item dialog.
+     *
+     * @param  string|string[] $title The dialog title.
+     * @return self
+     */
+    public function setDialogTitleCreate($title)
+    {
+        $this->dialogTitleCreate = $this->translator()->translation($title);
+
+        return $this;
+    }
+
+    /**
+     * Retrieve the title for the create item dialog.
+     *
+     * @return \Charcoal\Translator\Translation|string|null
+     */
+    public function getDialogTitleCreate()
+    {
+        return $this->dialogTitleCreate;
+    }
+
+    /**
+     * Set the title for the update item dialog.
+     *
+     * @param  string|string[] $title The dialog title.
+     * @return self
+     */
+    public function setDialogTitleUpdate($title)
+    {
+        $this->dialogTitleUpdate = $this->translator()->translation($title);
+
+        return $this;
+    }
+
+    /**
+     * Retrieve the title for the update item dialog.
+     *
+     * @return \Charcoal\Translator\Translation|string|null
+     */
+    public function getDialogTitleUpdate()
+    {
+        return $this->dialogTitleUpdate;
+    }
+
     /**
      * Set the selectize picker's options.
      *
@@ -1044,6 +1104,9 @@ public function controlDataForJs()
             'allow_update'             => $this->allowUpdate(),
             'allow_create'             => $this->allowCreate(),
 
+            'dialog_title_create'      => (string)$this->getDialogTitleCreate(),
+            'dialog_title_update'      => (string)$this->getDialogTitleUpdate(),
+
             'form_data'                => $this->getFormData(),
             'form_ident'               => $this->formIdent(),
             'form_widget'              => $this->formWidget(),

diff --git a/packages/property/src/Charcoal/Property/Structure/StructureModel.php b/packages/property/src/Charcoal/Property/Structure/StructureModel.php
@@ -2,11 +2,10 @@
 
 namespace Charcoal\Property\Structure;
 
-// From 'charcoal-core'
 use Charcoal\Model\AbstractModel;
 
 /**
- *
+ * An abstract model designed for structure properties.
  */
 class StructureModel extends AbstractModel
 {