Fix ambigious clearing behaviour on SelectButton (#4107)

primefaces · Oct 9, 2023 · b666789 · b666789
1 parent 0a08c56
commit b666789
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 2 deletions.
diff --git a/api-generator/components/selectbutton.js b/api-generator/components/selectbutton.js
@@ -51,6 +51,12 @@ const SelectButtonProps = [
         name: 'unselectable',
         type: 'boolean',
         default: 'false',
+        description: 'Whether selection can not be cleared.'
+    },
+    {
+        name: 'allowEmpty',
+        type: 'boolean',
+        default: 'true',
         description: 'Whether selection can be cleared.'
     },
     {

diff --git a/components/lib/selectbutton/BaseSelectButton.vue b/components/lib/selectbutton/BaseSelectButton.vue
@@ -16,6 +16,10 @@ export default {
             type: Boolean,
             default: false
         },
+        allowEmpty: {
+            type: Boolean,
+            default: true
+        },
         disabled: Boolean,
         dataKey: null,
         'aria-labelledby': {

diff --git a/components/lib/selectbutton/SelectButton.d.ts b/components/lib/selectbutton/SelectButton.d.ts
@@ -155,10 +155,16 @@ export interface SelectButtonProps {
      */
     dataKey?: string | undefined;
     /**
-     * Whether selection can be cleared.
+     * Whether selection can not be cleared.
      * @defaultValue false
+     * @deprecated Use 'allowEmpty' property instead.
      */
     unselectable?: boolean | undefined;
+    /**
+     * Whether selection can be cleared.
+     * @defaultValue true
+     */
+    allowEmpty?: boolean | undefined;
     /**
      * Identifier of the underlying element.
      */

diff --git a/components/lib/selectbutton/SelectButton.vue b/components/lib/selectbutton/SelectButton.vue
@@ -81,7 +81,7 @@ export default {
 
             let selected = this.isSelected(option);
 
-            if (selected && this.unselectable) {
+            if (selected && (this.unselectable || !this.allowEmpty)) {
                 return;
             }
 

diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json
@@ -42662,6 +42662,15 @@
                             "readonly": false,
                             "type": "boolean",
                             "default": "false",
+                            "description": "Whether selection can not be cleared.",
+                            "deprecated": "Use 'allowEmpty' property instead."
+                        },
+                        {
+                            "name": "allowEmpty",
+                            "optional": true,
+                            "readonly": false,
+                            "type": "boolean",
+                            "default": "true",
                             "description": "Whether selection can be cleared."
                         },
                         {