@patternfly/react-core 5.2.0-prerelease.9 → 6.0.0-alpha.10

package/src/components/HelperText/__tests__/HelperText.test.tsx

@@ -1,66 +1,76 @@
 import * as React from 'react';
-import { render } from '@testing-library/react';
+import { render, screen } from '@testing-library/react';
 import { HelperText } from '../HelperText';
-import { HelperTextItem } from '../HelperTextItem';
-import { CheckIcon } from '@patternfly/react-icons';
 
-describe('HelperText', () => {
-  test('simple helper text renders successfully', () => {
-    const { asFragment } = render(
-      <HelperText>
-        <HelperTextItem>help test text</HelperTextItem>
-      </HelperText>
-    );
-    expect(asFragment()).toMatchSnapshot();
-  });
+import styles from '@patternfly/react-styles/css/components/HelperText/helper-text';
 
-  Object.values(['default', 'indeterminate', 'warning', 'success', 'invalid']).forEach(variant => {
-    test(`${variant} helper text variant applies successfully`, () => {
-      const { asFragment } = render(
-        <HelperTextItem variant={variant as 'default' | 'indeterminate' | 'warning' | 'success' | 'error'}>
-          {variant} help test text
-        </HelperTextItem>
-      );
-      expect(asFragment()).toMatchSnapshot();
-    });
-  });
+test('Renders to match snapshot', () => {
+  const { asFragment } = render(<HelperText />);
+  expect(asFragment()).toMatchSnapshot();
+});
+
+test('Renders without children', () => {
+  render(
+    <div data-testid="container">
+      <HelperText />
+    </div>
+  );
+
+  expect(screen.getByTestId('container').firstChild).toBeVisible();
+});
+
+test('Renders default classes', () => {
+  render(<HelperText>text</HelperText>);
+  expect(screen.getByText('text')).toHaveClass(styles.helperText);
+});
 
-  test('variant comonent helper text renders properly', () => {
-    const { asFragment } = render(
-      <HelperText component="ul">
-        <HelperTextItem component="li">help test text 1</HelperTextItem>
-        <HelperTextItem component="li">help test text 2</HelperTextItem>
-      </HelperText>
-    );
-    expect(asFragment()).toMatchSnapshot();
-  });
+test('Renders id when id is passed', () => {
+  render(<HelperText id="helper-id">text </HelperText>);
+  expect(screen.getByText('text')).toHaveAttribute('id', 'helper-id');
+});
 
-  test('icon helper text renders properly', () => {
-    const { asFragment } = render(
-      <HelperText>
-        <HelperTextItem icon={<CheckIcon />}>help test text</HelperTextItem>
-      </HelperText>
-    );
-    expect(asFragment()).toMatchSnapshot();
-  });
+test('Renders aria-live when isLiveRegion is passed', () => {
+  render(<HelperText isLiveRegion>text </HelperText>);
+  expect(screen.getByText('text')).toHaveAttribute('aria-live', 'polite');
+});
+
+test('Does not render aria-live by default', () => {
+  render(<HelperText>text </HelperText>);
+  expect(screen.getByText('text')).not.toHaveAttribute('aria-live');
+});
 
-  test('dynamic helper text renders successfully', () => {
-    const { asFragment } = render(
-      <HelperText>
-        <HelperTextItem isDynamic>help test text</HelperTextItem>
-      </HelperText>
-    );
-    expect(asFragment()).toMatchSnapshot();
-  });
+test('Spreads additional props when passed', () => {
+  render(<HelperText dir="rtl">text </HelperText>);
+  expect(screen.getByText('text')).toHaveAttribute('dir', 'rtl');
+});
+
+test('Renders custom className', () => {
+  render(<HelperText className="custom">text </HelperText>);
+  expect(screen.getByText('text')).toHaveClass('custom');
+});
+
+test('Renders with element passed to component prop', () => {
+  render(<HelperText component="ul">text</HelperText>);
+  expect(screen.getByText('text').tagName).toBe('UL');
+});
+
+test('Renders with div by default when no component prop is passed', () => {
+  render(<HelperText>text</HelperText>);
+  expect(screen.getByText('text').tagName).toBe('DIV');
+});
+
+test('Renders aria-label and role when component = ul', () => {
+  render(
+    <HelperText component="ul" aria-label="helper">
+      text
+    </HelperText>
+  );
+  expect(screen.getByText('text')).toHaveAttribute('aria-label', 'helper');
+  expect(screen.getByText('text')).toHaveAttribute('role', 'list');
+});
 
-  test('helper text block renders successfully', () => {
-    const { asFragment } = render(
-      <HelperText>
-        <HelperTextItem>help test text 1</HelperTextItem>
-        <HelperTextItem>help test text 2</HelperTextItem>
-        <HelperTextItem>help test text 3</HelperTextItem>
-      </HelperText>
-    );
-    expect(asFragment()).toMatchSnapshot();
-  });
+test('Does not render aria-label and role when component != ul', () => {
+  render(<HelperText aria-label="helper">text</HelperText>);
+  expect(screen.getByText('text')).not.toHaveAttribute('aria-label', 'helper');
+  expect(screen.getByText('text')).not.toHaveAttribute('role', 'list');
 });

package/src/components/HelperText/__tests__/HelperTextItem.test.tsx

@@ -0,0 +1,93 @@
+import * as React from 'react';
+import { render, screen } from '@testing-library/react';
+import { HelperTextItem } from '../HelperTextItem';
+
+import styles from '@patternfly/react-styles/css/components/HelperText/helper-text';
+
+test('Renders to match snapshot', () => {
+  const { asFragment } = render(<HelperTextItem>help test text</HelperTextItem>);
+  expect(asFragment()).toMatchSnapshot();
+});
+
+test('Renders without children', () => {
+  render(
+    <div data-testid="container">
+      <HelperTextItem />
+    </div>
+  );
+
+  expect(screen.getByTestId('container').firstChild).toBeVisible();
+});
+
+test('Renders default classes', () => {
+  render(<HelperTextItem>help test text 1</HelperTextItem>);
+  expect(screen.getByText('help test text 1')).toHaveClass(styles.helperTextItemText);
+  expect(screen.getByText('help test text 1').parentElement).toHaveClass(styles.helperTextItem);
+});
+
+test('Renders custom className', () => {
+  render(<HelperTextItem className="custom">help test text 1</HelperTextItem>);
+  expect(screen.getByText('help test text 1').parentElement).toHaveClass('custom');
+});
+
+Object.values(['indeterminate', 'warning', 'success', 'error']).forEach((variant) => {
+  test(`Renders with class ${styles.modifiers[variant]} when variant = ${variant}`, () => {
+    render(
+      <HelperTextItem variant={variant as 'default' | 'indeterminate' | 'warning' | 'success' | 'error'}>
+        text
+      </HelperTextItem>
+    );
+    expect(screen.getByText('text').parentElement).toHaveClass(styles.modifiers[variant]);
+  });
+});
+
+test('Renders id when id is passed', () => {
+  render(<HelperTextItem id="text-item">help test text 1</HelperTextItem>);
+  expect(screen.getByText('help test text 1').parentElement).toHaveAttribute('id', 'text-item');
+});
+
+test('Renders as div by default when component is not passed', () => {
+  render(<HelperTextItem>help test text 1</HelperTextItem>);
+  expect(screen.getByText('help test text 1').parentElement?.tagName).toBe('DIV');
+});
+
+test('Renders with element passed to component prop', () => {
+  render(<HelperTextItem component="li">help test text 1</HelperTextItem>);
+  expect(screen.getByText('help test text 1').parentElement?.tagName).toBe('LI');
+});
+
+test('Renders custom icon', () => {
+  render(<HelperTextItem icon={<div>test</div>}>help test text</HelperTextItem>);
+  expect(screen.getByText('test').parentElement).toHaveClass(styles.helperTextItemIcon);
+});
+
+test('Renders default icon when hasIcon = true and icon is not passed', () => {
+  render(<HelperTextItem hasIcon>help test text</HelperTextItem>);
+  expect(screen.getByText('help test text').parentElement?.querySelector('span')).toHaveClass(
+    styles.helperTextItemIcon
+  );
+});
+
+test('Renders custom icon when icon is passed and hasIcon = true', () => {
+  render(
+    <HelperTextItem hasIcon icon={<div>test</div>}>
+      help test text
+    </HelperTextItem>
+  );
+  expect(screen.getByText('test').parentElement).toHaveClass(styles.helperTextItemIcon);
+});
+
+test('Renders dynamic helper text', () => {
+  render(<HelperTextItem isDynamic>help test text</HelperTextItem>);
+  expect(screen.getByText('help test text').parentElement).toHaveClass(styles.modifiers.dynamic);
+  expect(screen.getByText('help test text').querySelector('span')).toHaveClass('pf-v5-screen-reader');
+});
+
+test('Renders custom screenreader text when isDynamic = true and screenReaderText is passed', () => {
+  render(
+    <HelperTextItem isDynamic screenReaderText="sr test">
+      help test text
+    </HelperTextItem>
+  );
+  expect(screen.getByText('help test text').querySelector('span')).toHaveTextContent('sr test');
+});

package/src/components/HelperText/__tests__/__snapshots__/HelperText.test.tsx.snap

@@ -1,230 +1,9 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`HelperText default helper text variant applies successfully 1`] = `
+exports[`Renders to match snapshot 1`] = `
 <DocumentFragment>
   <div
-    class="pf-v5-c-helper-text__item"
-  >
-    <span
-      class="pf-v5-c-helper-text__item-text"
-    >
-      default help test text
-    </span>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText dynamic helper text renders successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text"
-  >
-    <div
-      class="pf-v5-c-helper-text__item pf-m-dynamic"
-    >
-      <span
-        aria-hidden="true"
-        class="pf-v5-c-helper-text__item-icon"
-      >
-        <svg
-          aria-hidden="true"
-          class="pf-v5-svg"
-          fill="currentColor"
-          height="1em"
-          role="img"
-          viewBox="0 0 448 512"
-          width="1em"
-        >
-          <path
-            d="M416 208H32c-17.67 0-32 14.33-32 32v32c0 17.67 14.33 32 32 32h384c17.67 0 32-14.33 32-32v-32c0-17.67-14.33-32-32-32z"
-          />
-        </svg>
-      </span>
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text
-        <span
-          class="pf-v5-screen-reader"
-        >
-          : default status;
-        </span>
-      </span>
-    </div>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText helper text block renders successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text"
-  >
-    <div
-      class="pf-v5-c-helper-text__item"
-    >
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text 1
-      </span>
-    </div>
-    <div
-      class="pf-v5-c-helper-text__item"
-    >
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text 2
-      </span>
-    </div>
-    <div
-      class="pf-v5-c-helper-text__item"
-    >
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text 3
-      </span>
-    </div>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText icon helper text renders properly 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text"
-  >
-    <div
-      class="pf-v5-c-helper-text__item"
-    >
-      <span
-        aria-hidden="true"
-        class="pf-v5-c-helper-text__item-icon"
-      >
-        <svg
-          aria-hidden="true"
-          class="pf-v5-svg"
-          fill="currentColor"
-          height="1em"
-          role="img"
-          viewBox="0 0 512 512"
-          width="1em"
-        >
-          <path
-            d="M173.898 439.404l-166.4-166.4c-9.997-9.997-9.997-26.206 0-36.204l36.203-36.204c9.997-9.998 26.207-9.998 36.204 0L192 312.69 432.095 72.596c9.997-9.997 26.207-9.997 36.204 0l36.203 36.204c9.997 9.997 9.997 26.206 0 36.204l-294.4 294.401c-9.998 9.997-26.207 9.997-36.204-.001z"
-          />
-        </svg>
-      </span>
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text
-      </span>
-    </div>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText indeterminate helper text variant applies successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text__item pf-m-indeterminate"
-  >
-    <span
-      class="pf-v5-c-helper-text__item-text"
-    >
-      indeterminate help test text
-    </span>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText invalid helper text variant applies successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text__item"
-  >
-    <span
-      class="pf-v5-c-helper-text__item-text"
-    >
-      invalid help test text
-    </span>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText simple helper text renders successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text"
-  >
-    <div
-      class="pf-v5-c-helper-text__item"
-    >
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text
-      </span>
-    </div>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText success helper text variant applies successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text__item pf-m-success"
-  >
-    <span
-      class="pf-v5-c-helper-text__item-text"
-    >
-      success help test text
-    </span>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`HelperText variant comonent helper text renders properly 1`] = `
-<DocumentFragment>
-  <ul
     class="pf-v5-c-helper-text"
-    role="list"
-  >
-    <li
-      class="pf-v5-c-helper-text__item"
-    >
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text 1
-      </span>
-    </li>
-    <li
-      class="pf-v5-c-helper-text__item"
-    >
-      <span
-        class="pf-v5-c-helper-text__item-text"
-      >
-        help test text 2
-      </span>
-    </li>
-  </ul>
-</DocumentFragment>
-`;
-
-exports[`HelperText warning helper text variant applies successfully 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-v5-c-helper-text__item pf-m-warning"
-  >
-    <span
-      class="pf-v5-c-helper-text__item-text"
-    >
-      warning help test text
-    </span>
-  </div>
+  />
 </DocumentFragment>
 `;

package/src/components/HelperText/__tests__/__snapshots__/HelperTextItem.test.tsx.snap

@@ -0,0 +1,15 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Renders to match snapshot 1`] = `
+<DocumentFragment>
+  <div
+    class="pf-v5-c-helper-text__item"
+  >
+    <span
+      class="pf-v5-c-helper-text__item-text"
+    >
+      help test text
+    </span>
+  </div>
+</DocumentFragment>
+`;

package/src/components/Icon/__tests__/Icon.test.tsx

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { render, screen } from '@testing-library/react';
 import { Icon } from '../Icon';
-import { CheckIcon } from '@patternfly/react-icons';
+import CheckIcon from '@patternfly/react-icons/dist/esm/icons/check-icon';
 import styles from '@patternfly/react-styles/css/components/Icon/icon';
 
 test('renders basic icon successfully', () => {
@@ -14,7 +14,7 @@ test('renders basic icon successfully', () => {
 });
 
 test('checks basic icon structure', () => {
-  const { asFragment } = render(
+  render(
     <Icon title="icon">
       <CheckIcon />
     </Icon>

package/src/components/InputGroup/InputGroup.tsx

@@ -1,9 +1,6 @@
 import * as React from 'react';
 import styles from '@patternfly/react-styles/css/components/InputGroup/input-group';
 import { css } from '@patternfly/react-styles';
-import { FormSelect } from '../FormSelect';
-import { TextArea } from '../TextArea';
-import { TextInput } from '../TextInput';
 
 export interface InputGroupProps extends React.HTMLProps<HTMLDivElement> {
   /** Additional classes added to the input group. */
@@ -20,61 +17,12 @@ export const InputGroupBase: React.FunctionComponent<InputGroupProps> = ({
   innerRef,
   ...props
 }: InputGroupProps) => {
-  const getIdItem = () => {
-    const getChildId = (_children: any) =>
-      React.Children.toArray(_children).find(
-        (_child: any) => !formCtrls.includes(_child?.type?.displayName) && _child?.props?.id
-      );
-    let childId = getChildId(children);
-    if (childId) {
-      return childId;
-    }
-    React.Children.toArray(children).find((child: any) => {
-      const _childId = getChildId(child.props.children);
-      if (_childId) {
-        childId = _childId;
-        return true;
-      }
-    });
-    return childId;
-  };
-  const formCtrls = [FormSelect, TextArea, TextInput].map((comp) => comp.displayName);
-  const idItem = getIdItem() as React.ReactElement<{ id: string }>;
   const ref = React.useRef(null);
   const inputGroupRef = innerRef || ref;
 
-  const childrenWithId = React.Children.map(children, (child: any) => {
-    if (child?.type.displayName === 'InputGroupItem') {
-      const newChildren = React.Children.map(child.props.children, (_child) => {
-        if (!_child.props) {
-          return _child;
-        }
-        if (_child.props['aria-describedby']) {
-          return _child;
-        }
-        if (!formCtrls.includes(_child.type.displayName)) {
-          return _child;
-        }
-        return React.cloneElement(_child, {
-          'aria-describedby': _child.props['aria-describedby'] === '' ? undefined : idItem?.props?.id
-        });
-      });
-      return React.cloneElement(child, {}, newChildren);
-    }
-
-    if (child?.props['aria-describedby']) {
-      return child;
-    }
-    if (!formCtrls.includes(child?.type.displayName)) {
-      return child;
-    }
-    return React.cloneElement(child, {
-      'aria-describedby': child.props['aria-describedby'] === '' ? undefined : idItem?.props?.id
-    });
-  });
   return (
     <div ref={inputGroupRef} className={css(styles.inputGroup, className)} {...props}>
-      {idItem ? childrenWithId : children}
+      {children}
     </div>
   );
 };

package/src/components/InputGroup/__tests__/InputGroup.test.tsx

@@ -8,59 +8,22 @@ import { Button } from '../../Button';
 import { TextInput } from '../../TextInput';
 
 describe('InputGroup', () => {
-  test('add aria-describedby to form-control if one of the non form-controls has id', () => {
-    // In this test, TextInput is a form-control component and Button is not.
-    // If Button has an id props, this should be used in aria-describedby.
+  // Regression test for https://github.com/patternfly/patternfly-react/issues/9667
+  test('wont add aria-describedby automatically to form-control', () => {
     render(
       <InputGroup>
         <InputGroupItem>
-          <TextInput value="some data" aria-label="some text" />
+          <TextInput aria-label="User password" />
         </InputGroupItem>
         <InputGroupItem>
-          <Button variant="primary" id="button-id">
-            hello
+          <Button variant="control" id="show-password-toggler">
+            Show
           </Button>
         </InputGroupItem>
       </InputGroup>
     );
-    expect(screen.getByLabelText('some text')).toHaveAttribute('aria-describedby', 'button-id');
-  });
 
-  test('wont add aria-describedby to form-control if describedby is empty string', () => {
-    // In this test, TextInput is a form-control component and Button is not.
-    // If Button has an id props, this should be used in aria-describedby, but this
-    // example has an empty aria-describedby to prevent that from happening.
-    render(
-      <InputGroup>
-        <InputGroupItem>
-          <TextInput value="some data" aria-describedby="" aria-label="some text" />
-        </InputGroupItem>
-        <InputGroupItem>
-          <Button id="button-id">
-            hello
-          </Button>
-        </InputGroupItem>
-      </InputGroup>
-    );
-    expect(screen.getByLabelText('some text')).not.toHaveAttribute('aria-describedby');
-  });
-
-  test('wont override aria-describedby in form-control if describedby has value', () => {
-    // In this test, TextInput is a form-control component and Button is not.
-    // If Button has an id props, this should be used in aria-describedby, but this
-    // example has a predefined aria-describedby to prevent that from happening
-    render(
-      <InputGroup>
-        <InputGroupItem>
-          <TextInput value="some data" aria-describedby="myself" aria-label="some text" />
-        </InputGroupItem>
-        <InputGroupItem>
-          <Button id="button-id">
-            hello
-          </Button>
-        </InputGroupItem>
-      </InputGroup>
-    );
-    expect(screen.getByLabelText('some text')).toHaveAttribute('aria-describedby', 'myself');
+    const formControl = screen.getByLabelText('User password');
+    expect(formControl).not.toHaveAttribute('aria-describedby');
   });
 });

package/src/components/List/ListItem.tsx

@@ -16,7 +16,7 @@ export const ListItem: React.FunctionComponent<ListItemProps> = ({
 }: ListItemProps) => (
   <li className={css(icon && styles.listItem)} {...props}>
     {icon && <span className={css(styles.listItemIcon)}>{icon}</span>}
-    {children}
+    <span className={icon && css(`${styles.list}__item-text`)}>{children}</span>
   </li>
 );
 ListItem.displayName = 'ListItem';

package/src/components/List/__tests__/Generated/__snapshots__/ListItem.test.tsx.snap

@@ -5,7 +5,9 @@ exports[`ListItem should match snapshot (auto-generated) 1`] = `
   <li
     class=""
   >
-    ReactNode
+    <span>
+      ReactNode
+    </span>
   </li>
 </DocumentFragment>
 `;