fix(Menu toggle): Remove pf-m-action modifier (#11096)

* fix(Menu toggle): Remove pf-m-action modifier * disable integration test that is timing out * disable 2nd integration test that is timing out * fix example
patternfly · Oct 2, 2024 · fe6871c · fe6871c
1 parent 5decd6a
commit fe6871c
Show file tree

Hide file tree

Showing 26 changed files with 229 additions and 289 deletions.
diff --git a/packages/react-core/package.json b/packages/react-core/package.json
@@ -54,7 +54,7 @@
     "tslib": "^2.7.0"
   },
   "devDependencies": {
-    "@patternfly/patternfly": "6.0.0-prerelease.13",
+    "@patternfly/patternfly": "6.0.0-prerelease.15",
     "case-anything": "^2.1.13",
     "css": "^3.0.0",
     "fs-extra": "^11.2.0"

diff --git a/packages/react-core/src/components/MenuToggle/MenuToggle.tsx b/packages/react-core/src/components/MenuToggle/MenuToggle.tsx
@@ -21,13 +21,6 @@ export enum MenuToggleSize {
 
 export type MenuToggleElement = HTMLDivElement | HTMLButtonElement;
 
-export interface SplitButtonOptions {
-  /** Elements to display before the toggle button. When included, renders the menu toggle as a split button. */
-  items: React.ReactNode[];
-  /** Variant of split button toggle */
-  variant?: 'action' | 'checkbox';
-}
-
 export interface MenuToggleProps
   extends Omit<
       React.DetailedHTMLProps<
@@ -51,8 +44,8 @@ export interface MenuToggleProps
   isFullWidth?: boolean;
   /** Flag indicating the toggle contains placeholder text */
   isPlaceholder?: boolean;
-  /** Object used to configure a split button menu toggle */
-  splitButtonOptions?: SplitButtonOptions;
+  /** Elements to display before the toggle button. When included, renders the menu toggle as a split button. */
+  splitButtonItems?: React.ReactNode[];
   /** Variant styles of the menu toggle */
   variant?: 'default' | 'plain' | 'primary' | 'plainText' | 'secondary' | 'typeahead';
   /** Status styles of the menu toggle */
@@ -107,7 +100,7 @@ class MenuToggleBase extends React.Component<MenuToggleProps, MenuToggleState> {
       isFullHeight,
       isFullWidth,
       isPlaceholder,
-      splitButtonOptions,
+      splitButtonItems,
       variant,
       status,
       statusIcon,
@@ -204,17 +197,10 @@ class MenuToggleBase extends React.Component<MenuToggleProps, MenuToggleState> {
       );
     }
 
-    if (splitButtonOptions) {
+    if (splitButtonItems) {
       return (
-        <div
-          ref={innerRef as React.Ref<HTMLDivElement>}
-          className={css(
-            commonStyles,
-            styles.modifiers.splitButton,
-            splitButtonOptions?.variant === 'action' && styles.modifiers.action
-          )}
-        >
-          {splitButtonOptions?.items}
+        <div ref={innerRef as React.Ref<HTMLDivElement>} className={css(commonStyles, styles.modifiers.splitButton)}>
+          {splitButtonItems}
           <button
             className={css(styles.menuToggleButton, children && styles.modifiers.text)}
             type="button"

diff --git a/packages/react-core/src/components/MenuToggle/__tests__/MenuToggle.test.tsx b/packages/react-core/src/components/MenuToggle/__tests__/MenuToggle.test.tsx
@@ -7,6 +7,7 @@ import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-ico
 import userEvent from '@testing-library/user-event';
 import { render, screen } from '@testing-library/react';
 import styles from '@patternfly/react-styles/css/components/MenuToggle/menu-toggle';
+import '@testing-library/jest-dom';
 
 describe('menu toggle', () => {
   test('renders successfully', () => {
@@ -82,17 +83,15 @@ describe('menu toggle', () => {
     render(
       <MenuToggle
         onClick={mockClick}
-        splitButtonOptions={{
-          items: [
-            <MenuToggleCheckbox
-              id="split-button-checkbox-with-text-disabled-example"
-              key="split-checkbox-with-text-disabled"
-              aria-label="Select all"
-            >
-              10 selected
-            </MenuToggleCheckbox>
-          ]
-        }}
+        splitButtonItems={[
+          <MenuToggleCheckbox
+            id="split-button-checkbox-with-text-disabled-example"
+            key="split-checkbox-with-text-disabled"
+            aria-label="Select all"
+          >
+            10 selected
+          </MenuToggleCheckbox>
+        ]}
         aria-label="Menu toggle with checkbox split button and text"
       />
     );

diff --git a/packages/react-core/src/components/MenuToggle/examples/MenuToggle.md b/packages/react-core/src/components/MenuToggle/examples/MenuToggle.md
@@ -3,7 +3,7 @@ id: Menu toggle
 section: components
 subsection: menus
 cssPrefix: pf-v6-c-menu-toggle
-propComponents: ['MenuToggle', 'MenuToggleAction', 'MenuToggleCheckbox', 'SplitButtonOptions']
+propComponents: ['MenuToggle', 'MenuToggleAction', 'MenuToggleCheckbox']
 ---
 
 import './MenuToggle.css'
@@ -203,7 +203,7 @@ import { MenuToggle } from '@patternfly/react-core';
 
 To add a checkbox (or other action/control) to a menu toggle, use a split button.
 
-A `<MenuToggle>` can be rendered as a split button by adding a `splitButtonOptions` object. Elements to be displayed before the toggle button must be included in the `items` property of `splitButtonOptions`.
+A `<MenuToggle>` can be rendered as a split button by adding a `splitButtonItems` property. Elements to be displayed before the toggle button must be included in the `splitButtonItems`.
 
 The following example shows a split button with a `<MenuToggleCheckbox>`.
 
@@ -217,23 +217,23 @@ Variant styling can be applied to split button toggles to adjust their appearanc
 
 You can allow users to select a toggle checkbox by clicking either the checkbox or the text label.
 
-To link a split toggle label to the toggle's checkbox, pass both the label and the `<MenuToggleCheckbox>` component to `splitButtonOptions`. 
+To link a split toggle label to the toggle's checkbox, pass both the label and the `<MenuToggleCheckbox>` component to `splitButtonItems`. 
 
 ```ts file='MenuToggleSplitButtonCheckboxWithText.tsx'
 
 ```
 
 ### Split toggle with checkbox and toggle text 
 
-To link a split toggle label to the toggle button itself, pass the label to the `<MenuToggle>` component, instead of `splitButtonOptions`.
+To link a split toggle label to the toggle button itself, pass the label to the `<MenuToggle>` component, instead of `splitButtonItems`.
 
 ```ts file='MenuToggleSplitButtonCheckboxWithToggleText.tsx'
 
 ```
 
 ### Split toggle with action
 
-To add an action to a split button, pass `variant='action'` into `splitButtonOptions` and add a `<MenuToggleAction>` to the `items` property of `splitButtonOptions`.
+To add an action to a split button, add a `<MenuToggleAction>` to the `splitButtonItems` property.
 
 Actions may be used with primary and secondary toggle variants.
 

diff --git a/packages/react-core/src/components/MenuToggle/examples/MenuToggleSplitButtonAction.tsx b/packages/react-core/src/components/MenuToggle/examples/MenuToggleSplitButtonAction.tsx
@@ -4,46 +4,37 @@ import { MenuToggleAction, MenuToggle } from '@patternfly/react-core';
 export const MenuToggleSplitButtonAction: React.FunctionComponent = () => (
   <React.Fragment>
     <MenuToggle
-      splitButtonOptions={{
-        variant: 'action',
-        items: [
-          <MenuToggleAction id="split-button-action-example-with-toggle-button" key="split-action" aria-label="Action">
-            Action
-          </MenuToggleAction>
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleAction id="split-button-action-example-with-toggle-button" key="split-action" aria-label="Action">
+          Action
+        </MenuToggleAction>
+      ]}
       aria-label="Menu toggle with action split button"
     />{' '}
     <MenuToggle
       variant="primary"
-      splitButtonOptions={{
-        variant: 'action',
-        items: [
-          <MenuToggleAction
-            id="split-button-action-primary-example-with-toggle-button"
-            key="split-action-primary"
-            aria-label="Action"
-          >
-            Action
-          </MenuToggleAction>
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleAction
+          id="split-button-action-primary-example-with-toggle-button"
+          key="split-action-primary"
+          aria-label="Action"
+        >
+          Action
+        </MenuToggleAction>
+      ]}
       aria-label="Menu toggle with action split button"
     />{' '}
     <MenuToggle
       variant="secondary"
-      splitButtonOptions={{
-        variant: 'action',
-        items: [
-          <MenuToggleAction
-            id="split-button-action-secondary-example-with-toggle-button"
-            key="split-action-secondary"
-            aria-label="Action"
-          >
-            Action
-          </MenuToggleAction>
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleAction
+          id="split-button-action-secondary-example-with-toggle-button"
+          key="split-action-secondary"
+          aria-label="Action"
+        >
+          Action
+        </MenuToggleAction>
+      ]}
       aria-label="Menu toggle with action split button"
     />
   </React.Fragment>

diff --git a/packages/react-core/src/components/MenuToggle/examples/MenuToggleSplitButtonCheckbox.tsx b/packages/react-core/src/components/MenuToggle/examples/MenuToggleSplitButtonCheckbox.tsx
@@ -4,23 +4,23 @@ import { MenuToggleCheckbox, MenuToggle } from '@patternfly/react-core';
 export const MenuToggleSplitButtonCheckbox: React.FunctionComponent = () => (
   <React.Fragment>
     <MenuToggle
-      splitButtonOptions={{
-        items: [<MenuToggleCheckbox id="split-button-checkbox-example" key="split-checkbox" aria-label="Select all" />]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox id="split-button-checkbox-example" key="split-checkbox" aria-label="Select all" />
+      ]}
       aria-label="Menu toggle with checkbox split button"
     />{' '}
     <MenuToggle
       variant="primary"
-      splitButtonOptions={{
-        items: [<MenuToggleCheckbox id="split-button-checkbox-example" key="split-checkbox" aria-label="Select all" />]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox id="split-button-checkbox-example" key="split-checkbox" aria-label="Select all" />
+      ]}
       aria-label="Menu toggle with checkbox split button"
     />{' '}
     <MenuToggle
       variant="secondary"
-      splitButtonOptions={{
-        items: [<MenuToggleCheckbox id="split-button-checkbox-example" key="split-checkbox" aria-label="Select all" />]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox id="split-button-checkbox-example" key="split-checkbox" aria-label="Select all" />
+      ]}
       aria-label="Menu toggle with checkbox split button"
     />
   </React.Fragment>

diff --git a/...s/react-core/src/components/MenuToggle/examples/MenuToggleSplitButtonCheckboxWithText.tsx b/...s/react-core/src/components/MenuToggle/examples/MenuToggleSplitButtonCheckboxWithText.tsx
@@ -4,47 +4,41 @@ import { MenuToggleCheckbox, MenuToggle } from '@patternfly/react-core';
 export const MenuToggleSplitButtonCheckboxWithText: React.FunctionComponent = () => (
   <React.Fragment>
     <MenuToggle
-      splitButtonOptions={{
-        items: [
-          <MenuToggleCheckbox
-            id="split-button-checkbox-with-text-example"
-            key="split-checkbox-with-text"
-            aria-label="Select all"
-          >
-            10 selected
-          </MenuToggleCheckbox>
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox
+          id="split-button-checkbox-with-text-example"
+          key="split-checkbox-with-text"
+          aria-label="Select all"
+        >
+          10 selected
+        </MenuToggleCheckbox>
+      ]}
       aria-label="Menu toggle with checkbox split button and text"
     />{' '}
     <MenuToggle
       variant="primary"
-      splitButtonOptions={{
-        items: [
-          <MenuToggleCheckbox
-            id="split-button-checkbox-primary-example"
-            key="split-checkbox-primary"
-            aria-label="Select all"
-          >
-            10 selected
-          </MenuToggleCheckbox>
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox
+          id="split-button-checkbox-primary-example"
+          key="split-checkbox-primary"
+          aria-label="Select all"
+        >
+          10 selected
+        </MenuToggleCheckbox>
+      ]}
       aria-label="Primary menu toggle with checkbox split button"
     />{' '}
     <MenuToggle
       variant="secondary"
-      splitButtonOptions={{
-        items: [
-          <MenuToggleCheckbox
-            id="split-button-checkbox-secondary-example"
-            key="split-checkbox-secondary"
-            aria-label="Select all"
-          >
-            10 selected
-          </MenuToggleCheckbox>
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox
+          id="split-button-checkbox-secondary-example"
+          key="split-checkbox-secondary"
+          aria-label="Select all"
+        >
+          10 selected
+        </MenuToggleCheckbox>
+      ]}
       aria-label="Secondary menu toggle with checkbox split button"
     />
   </React.Fragment>

diff --git a/...t-core/src/components/MenuToggle/examples/MenuToggleSplitButtonCheckboxWithToggleText.tsx b/...t-core/src/components/MenuToggle/examples/MenuToggleSplitButtonCheckboxWithToggleText.tsx
@@ -4,45 +4,39 @@ import { MenuToggleCheckbox, MenuToggle } from '@patternfly/react-core';
 export const MenuToggleSplitButtonCheckboxWithToggleText: React.FunctionComponent = () => (
   <React.Fragment>
     <MenuToggle
-      splitButtonOptions={{
-        items: [
-          <MenuToggleCheckbox
-            id="split-button-checkbox-with-text-example"
-            key="split-checkbox-with-text"
-            aria-label="Select all"
-          />
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox
+          id="split-button-checkbox-with-text-example"
+          key="split-checkbox-with-text"
+          aria-label="Select all"
+        />
+      ]}
       aria-label="Menu toggle with checkbox split button and text"
     >
       10 selected
     </MenuToggle>{' '}
     <MenuToggle
       variant="primary"
-      splitButtonOptions={{
-        items: [
-          <MenuToggleCheckbox
-            id="split-button-checkbox-primary-example"
-            key="split-checkbox-primary"
-            aria-label="Select all"
-          />
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox
+          id="split-button-checkbox-primary-example"
+          key="split-checkbox-primary"
+          aria-label="Select all"
+        />
+      ]}
       aria-label="Primary menu toggle with checkbox split button"
     >
       10 selected
     </MenuToggle>{' '}
     <MenuToggle
       variant="secondary"
-      splitButtonOptions={{
-        items: [
-          <MenuToggleCheckbox
-            id="split-button-checkbox-secondary-example"
-            key="split-checkbox-secondary"
-            aria-label="Select all"
-          />
-        ]
-      }}
+      splitButtonItems={[
+        <MenuToggleCheckbox
+          id="split-button-checkbox-secondary-example"
+          key="split-checkbox-secondary"
+          aria-label="Select all"
+        />
+      ]}
       aria-label="Secondary menu toggle with checkbox split button"
     >
       10 selected