Fixed #2195 - Add empty property to MultiStateCheckbox

primefaces · Jul 16, 2021 · a5bd2d2 · a5bd2d2
1 parent 52d6e8f
commit a5bd2d2
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 1 deletion.
diff --git a/api-generator/components/multistatecheckbox.js b/api-generator/components/multistatecheckbox.js
@@ -65,6 +65,12 @@ const MultiStateCheckboxProps = [
         default: 'false',
         description: 'When present, it specifies that the element value cannot be altered.'
     },
+    {
+        name: 'empty',
+        type: 'boolean',
+        default: 'true',
+        description: 'If false, the empty state is skipped in the chekbox.'
+    },
     {
         name: 'tooltip',
         type: 'any',

diff --git a/src/components/multistatecheckbox/MultiStateCheckbox.d.ts b/src/components/multistatecheckbox/MultiStateCheckbox.d.ts
@@ -47,6 +47,7 @@ export interface MultiStateCheckboxProps {
     className?: string;
     disabled?: boolean;
     readOnly?: boolean;
+    empty?: boolean;
     tooltip?: string;
     tooltipOptions?: TooltipOptions;
     ariaLabelledBy?: string;

diff --git a/src/components/multistatecheckbox/MultiStateCheckbox.js b/src/components/multistatecheckbox/MultiStateCheckbox.js
@@ -19,6 +19,7 @@ export class MultiStateCheckbox extends Component {
         className: null,
         disabled: false,
         readOnly: false,
+        empty: true,
         tooltip: null,
         tooltipOptions: null,
         ariaLabelledBy: null,
@@ -39,6 +40,7 @@ export class MultiStateCheckbox extends Component {
         className: PropTypes.string,
         disabled: PropTypes.bool,
         readOnly: PropTypes.bool,
+        empty: PropTypes.bool,
         tooltip: PropTypes.string,
         tooltipOptions: PropTypes.object,
         ariaLabelledBy: PropTypes.string,
@@ -89,7 +91,7 @@ export class MultiStateCheckbox extends Component {
     findNextOption() {
         if (this.props.options) {
             const { index } = this.findSelectedOptionMap();
-            return index === this.props.options.length - 1 ? null : this.props.options[index + 1];
+            return index === this.props.options.length - 1 ? (this.props.empty ? null : this.props.options[0]) : this.props.options[index + 1];
         }
 
         return null;
@@ -140,6 +142,10 @@ export class MultiStateCheckbox extends Component {
         if (this.props.tooltip && !this.props.disabled) {
             this.renderTooltip();
         }
+
+        if (!this.props.empty && this.props.value === null) {
+            this.toggle();
+        }
     }
 
     componentDidUpdate(prevProps) {

diff --git a/src/showcase/multistatecheckbox/MultiStateCheckboxDoc.js b/src/showcase/multistatecheckbox/MultiStateCheckboxDoc.js
@@ -240,6 +240,12 @@ import {MultiStateCheckbox} from 'primereact/multistatecheckbox';
                                     <td>false</td>
                                     <td>When present, it specifies that the element value cannot be altered.</td>
                                 </tr>
+                                <tr>
+                                    <td>empty</td>
+                                    <td>boolean</td>
+                                    <td>true</td>
+                                    <td>If false, the empty state is skipped in the chekbox.</td>
+                                </tr>
                                 <tr>
                                     <td>tooltip</td>
                                     <td>any</td>