Fixes #38822: update pf3 buttons to pf5 - common/ActionButtons

Author: Konstantinos Familonidis

webpack/assets/javascripts/react_app/components/common/ActionButtons/ActionButtons.fixtures.js

@@ -1,7 +1,7 @@
 import { noop } from '../../../common/helpers';
 
 export const buttons = [
-  { title: 'first', action: { onClick: noop } },
-  { title: 'second', action: { href: 'some-url2', 'data-method': 'put' } },
-  { title: 'third', action: { onClick: noop } },
+  { title: 'first', action: { id: 1, onClick: noop } },
+  { title: 'second', action: { id: 2, href: 'some-url2', 'data-method': 'put' } },
+  { title: 'third', action: { id: 3, onClick: noop } },
 ];

webpack/assets/javascripts/react_app/components/common/ActionButtons/ActionButtons.js

@@ -1,34 +1,83 @@
-import React from 'react';
+import React, { useState } from 'react';
 import PropTypes from 'prop-types';
-import { SplitButton, MenuItem, Button } from 'patternfly-react';
+import {
+  Button,
+  Dropdown,
+  DropdownItem,
+  DropdownList,
+  MenuToggle,
+  MenuToggleAction,
+} from '@patternfly/react-core';
+import './actionButtons.scss';
 
 /**
  * Generate a button or a dropdown of buttons
  * @param  {String} title The title of the button for the title and text inside the button
  * @param  {Object} action action to preform when the button is click can be href with data-method or Onclick
- * @return {Function} button component or splitbutton component
+ * @return {Function} button component or dropdown with menu toggle action component
  */
 export const ActionButtons = ({ buttons }) => {
+  const [isOpen, setIsOpen] = useState(false);
+  const onToggleClick = () => setIsOpen(!isOpen);
+  const getUniqueId = () => Math.floor(Math.random() * 1_000) + 1;
+
   if (!buttons.length) return null;
   if (buttons.length === 1)
     return (
-      <Button bsSize="small" {...buttons[0].action}>
+      <Button
+        ouiaId="action-button"
+        size="sm"
+        variant="primary"
+        {...buttons[0].action}
+      >
         {buttons[0].title}
       </Button>
     );
-  const firstButton = buttons.shift();
+
+  const [firstButton, ...restButtons] = buttons;
+  const actionId = firstButton.action?.id || getUniqueId();
+
   return (
-    <SplitButton
-      title={firstButton.title}
-      {...firstButton.action}
-      bsSize="small"
+    <Dropdown
+      ouiaId="action-buttons-dropdown"
+      isOpen={isOpen}
+      onOpenChange={openState => setIsOpen(openState)}
+      toggle={toggleRef => (
+        <MenuToggle
+          ref={toggleRef}
+          onClick={onToggleClick}
+          isExpanded={isOpen}
+          splitButtonOptions={{
+            variant: 'action',
+            items: [
+              <MenuToggleAction
+                id={`split-button-action-${actionId}-toggle-button`}
+                key="split-action"
+                aria-label={firstButton.title}
+                onClick={firstButton.action?.onClick}
+              >
+                {firstButton.title}
+              </MenuToggleAction>,
+            ],
+          }}
+          aria-label="Menu toggle with action split button"
+        />
+      )}
+      shouldFocusToggleOnSelect
     >
-      {buttons.map(button => (
-        <MenuItem key={button.title} title={button.title} {...button.action}>
-          {button.title}
-        </MenuItem>
-      ))}
-    </SplitButton>
+      <DropdownList className="action-buttons">
+        {restButtons.map(button => (
+          <DropdownItem
+            ouiaId={`${button.action?.id || getUniqueId()}-dropdown-item-id`}
+            key={`${button.action?.id || getUniqueId()}-dropdown-item-key`}
+            title={button.title}
+            onClick={button.action?.onClick}
+          >
+            {button.title}
+          </DropdownItem>
+        ))}
+      </DropdownList>
+    </Dropdown>
   );
 };
 

webpack/assets/javascripts/react_app/components/common/ActionButtons/ActionButtons.test.js

@@ -1,12 +1,41 @@
-import { testComponentSnapshotsWithFixtures } from 'foremanReact/common/testHelpers';
+import React from 'react';
+import { screen, fireEvent, render, act } from '@testing-library/react';
+import '@testing-library/jest-dom/extend-expect';
+
 import { ActionButtons } from './ActionButtons';
 import { buttons } from './ActionButtons.fixtures';
 
 const fixtures = {
-  'renders ActionButtons with 0 button': { buttons: [] },
-  'renders ActionButtons with 1 button': { buttons: [buttons[0]] },
-  'renders ActionButtons with 3 button': { buttons },
+  none: { buttons: [] },
+  one: { buttons: [buttons[0]] },
+  many: { buttons },
 };
 
-describe('ActionButtons', () =>
-  testComponentSnapshotsWithFixtures(ActionButtons, fixtures));
+describe('ActionButtons', () => {
+  it('renders with 0 buttons', () => {
+    render(<ActionButtons {...fixtures.none} />);
+    expect(screen.queryByRole('button')).not.toBeInTheDocument();
+  });
+
+  it('renders 1 button', () => {
+    render(<ActionButtons {...fixtures.one} />);
+    expect(screen.getByRole('button')).toHaveTextContent('first');
+  });
+
+  it('renders 2 buttons initially and shows more after clicking toggle', async () => {
+    render(<ActionButtons {...fixtures.many} />);
+    const buttons = screen.getAllByRole('button');
+    expect(buttons).toHaveLength(2);
+    expect(screen.getByRole('button', { name: 'first' })).toBeInTheDocument();
+    const toggleButton = screen.getByRole('button', {
+      name: 'Menu toggle with action split button'
+    });
+    expect(toggleButton).toBeInTheDocument();
+
+    expect(screen.queryByText('second')).not.toBeInTheDocument();
+    expect(screen.queryByText('third')).not.toBeInTheDocument();
+    await act(async () => fireEvent.click(toggleButton));
+    expect(screen.getByText('second')).toBeInTheDocument();
+    expect(screen.getByText('third')).toBeInTheDocument();
+  });
+});

webpack/assets/javascripts/react_app/components/common/ActionButtons/__snapshots__/ActionButtons.test.js.snap

@@ -0,0 +1,5 @@
+.pf-v5-c-menu__content {
+  ul[role="menu"].action-buttons {
+      margin-bottom: 0;
+  }
+}