@patternfly/react-core 4.236.8 → 4.236.11

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 4.236.11 (2022-09-07)
+
+
+### Bug Fixes
+
+* **dashboardheader:** update brand image src to absolute import path for codesandbox functionality ([#7935](https://github.com/patternfly/patternfly-react/issues/7935)) ([6190a7f](https://github.com/patternfly/patternfly-react/commit/6190a7fd51a9606c9f1bf06aa0ebd46215fbd341))
+
+
+
+
+
+## 4.236.10 (2022-09-07)
+
+**Note:** Version bump only for package @patternfly/react-core
+
+
+
+
+
+## 4.236.9 (2022-09-07)
+
+**Note:** Version bump only for package @patternfly/react-core
+
+
+
+
+
 ## 4.236.8 (2022-09-07)
 
 **Note:** Version bump only for package @patternfly/react-core

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patternfly/react-core",
-  "version": "4.236.8",
+  "version": "4.236.11",
   "description": "This library provides a set of common React components for use with the PatternFly reference implementation.",
   "main": "dist/js/index.js",
   "module": "dist/esm/index.js",
@@ -44,9 +44,9 @@
     "generate": "node scripts/copyStyles.js"
   },
   "dependencies": {
-    "@patternfly/react-icons": "^4.87.8",
-    "@patternfly/react-styles": "^4.86.8",
-    "@patternfly/react-tokens": "^4.88.8",
+    "@patternfly/react-icons": "^4.87.11",
+    "@patternfly/react-styles": "^4.86.11",
+    "@patternfly/react-tokens": "^4.88.11",
     "focus-trap": "6.9.2",
     "react-dropzone": "9.0.0",
     "tippy.js": "5.1.2",
@@ -70,5 +70,5 @@
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },
-  "gitHead": "37520d7f027e9777fbd76f40485388b29d93e292"
+  "gitHead": "64c3bec9a5a7941503aa74c467884ea2191dd93c"
 }

package/src/components/AlertGroup/examples/AlertGroup.md

@@ -6,37 +6,74 @@ propComponents: ['Alert', 'AlertGroup', 'AlertActionCloseButton', 'AlertActionLi
 ---
 
 ## Examples
-### Static alert group
-These alerts appear on page load and are discoverable from within the normal page content flow, and will not be announced individually/explicitly to assistive technology.
+
+### Variants 
+
+Alert groups can be one of the following variants:
+
+| Variant | Description |
+| --- | --- |
+| Static inline | Static inline alert groups contain alerts that appear when the page loads, and are seen within the normal page content flow. These groups should not contain alerts that will dynamically appear or update. |
+| Toast | Toast alert groups contain alerts that typically appear in response to an asynchronous event or user action. These groups are positioned on top of other content at the top right of the page.|
+| Dynamic | Dynamic alert groups contain alerts that typically appear in response to a user action, and are seen within the normal page content flow.|  
+
+Dynamic alerts that are generated after the page initially loads must be appended to either a toast or dynamic `AlertGroup`, both of which must use the `isLiveRegion` property. New alerts appended to a toast or dynamic group will be announced by assistive technologies the moment the change happens. For information about customizing this announcement, read the [aria-atomic and aria-relevant](/components/alert-group/accessibility#aria-atomic-and-aria-relevant) section of the alert group accessibility documentation.
+
+### Static inline alert group
+
+All alert group variants may combine multiple [alert variants](/components/alert) For example, the following static inline alert group includes one "success" alert and one "info" alert.
+
 ```ts file="./AlertGroupStatic.tsx"
 ```
 
 ### Toast alert group
-Alerts asynchronously appended into dynamic AlertGroups with `isLiveRegion` will be announced to assistive technology at the moment the change happens, following the strategy used for aria-atomic, which defaults to false. This means only changes of type "addition" will be announced.
+
+Toast alert groups are created by passing in the `isToast` and `isLiveRegion` properties. 
+
+Click the buttons in the example below to add alerts to a toast group.
+
 ```ts file="./AlertGroupToast.tsx"
 ```
 
 ### Toast alert group with overflow capture
-After a specified number of alerts displayed is reached, we will see an overflow message instead of new alerts. Alerts asynchronously appended into dynamic AlertGroups with `isLiveRegion` will be announced to assistive technology at the moment the change happens. When the overflow message appears or is updated in AlertGroups with `isLiveRegion`, the `View 1 more alert` text will be read, but the alert message will not be read. screen reader user or keyboard user will need a way to navigate to and reveal the hidden alerts before they disappear. Alternatively, there should be a place that notifications or alerts are collected to be viewed or read later. In this example we are showing a max of 4 alerts.
+
+Users will see an overflow message once a predefined number of alerts are displayed. They will not see any alerts beyond the display limit, which must be explicitly set.
+
+In the following example, an overflow message will appear when more than 4 alerts would be shown. When a 5th alert would appear, an overflow message is shown instead.
+
+When an overflow message appears in an `AlertGroup` using the `isLiveRegion` property, the "view 1 more alert" text label will be announced, but the alert message will not. 
+
+Users navigating via keyboard or another assistive technology will need a way to navigate to and reveal hidden alerts before they disappear. Alternatively, there should be a place where notifications or alerts are collected to be viewed or read later. 
+
 ```ts file="AlertGroupToastOverflowCapture.tsx" isBeta
 ```
 
-### Singular dynamic alert group
-This alert will appear in the page, most likely in response to a user action.
+### Asynchronous alert groups
+
+The following example shows how alerts can be triggered by an asynchronous event in the application. You can customize how an alert will be announced to assistive technology by adjusting the value of the `aria-live` property. Click the "start async" alert button below and then click the buttons in the above toast examples to demonstrate how asynchronous events add alerts to a group. Click the "stop async alerts" button to halt this behavior.
+
+See the [alert group accessibility tab](/components/alert-group/accessibility) for more information on customizing this behavior.
+
+```ts file="./AlertGroupAsync.tsx"
+```
+
+### Dynamic alert groups
+
+Click the buttons in the example below to add dynamic alerts to a group.
+
 ```ts file="./AlertGroupSingularDynamic.tsx"
 ```
 
-### Singular dynamic alert group with overflow message
-This alert will appear in the page, most likely in response to a user action. In this example we are showing a max of 4 alerts.
+### Dynamic alert group with overflow message
+
+In the following example, there can be a maximum of 4 alerts shown at once. 
+
 ```ts file="AlertGroupSingularDynamicOverflow.tsx" isBeta
 ```
 
-### Multiple dynamic alert group
-These alerts will appear in the page, most likely in response to a user action.
-```ts file="./AlertGroupMultipleDynamic.tsx"
-```
+### Multiple dynamic alert groups
 
-### Async alert group
-This shows how an alert could be triggered by an asynchronous event in the application. Note how you can customize how the alert will be announced to assistive technology. See the alert group accessibility tab for more information.
-```ts file="./AlertGroupAsync.tsx"
+You may add multiple alerts to an alert group at once. Click the "add alert collection" button in the example below to add a batch of 3 toast alerts to a group.
+
+```ts file="./AlertGroupMultipleDynamic.tsx"
 ```

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

@@ -1,22 +1,160 @@
-import React from 'react';
-import { render } from '@testing-library/react';
+import React, { RefObject } from 'react';
+import { fireEvent, render, screen } from '@testing-library/react';
 import { BackToTop } from '../BackToTop';
+import userEvent from '@testing-library/user-event';
 
-describe('BackToTop', () => {
-  test('verify basic', () => {
-    const { asFragment } = render(<BackToTop />);
-    expect(asFragment()).toMatchSnapshot();
-  });
+jest.mock('../../Button', () => ({
+  Button: ({ variant, iconPosition, children, icon }) => (
+    <>
+      <button>{children}</button>
+      <p>{variant}</p>
+      <p>{iconPosition}</p>
+      <div data-testid="icon">{icon}</div>
+    </>
+  )
+}));
 
-  test('verify custom class', () => {
-    const { asFragment } = render(<BackToTop className="custom-css">test</BackToTop>);
+test('Renders BackToTop', () => {
+  render(
+    <div data-testid="backtotop">
+      <BackToTop />
+    </div>
+  );
 
-    expect(asFragment()).toMatchSnapshot();
-  });
+  expect(screen.getByTestId('backtotop').firstChild).toBeTruthy();
+});
+
+test('Renders with the default class', () => {
+  render(<BackToTop />);
+
+  expect(screen.getByRole(`button`).parentElement).toHaveClass('pf-c-back-to-top');
+});
+
+test('BackToTop is not yet visible', () => {
+  render(<BackToTop />);
+
+  expect(screen.getByRole(`button`).parentElement).toHaveClass('pf-m-hidden');
+});
+
+test('BackToTop is visible after scrolling', () => {
+  render(<BackToTop />);
+
+  fireEvent.scroll(window, { target: { scrollY: 401 } });
+  expect(screen.getByRole(`button`).parentElement).not.toHaveClass('pf-m-hidden');
+});
+
+test('ScrollTo event is fired after clicking BackToTop', async () => {
+  render(<BackToTop />);
+  const user = userEvent.setup();
+  fireEvent.scroll(window, { target: { scrollY: 401 } });
+  global.scrollTo = jest.fn();
+
+  await user.click(screen.getByRole(`button`).parentElement as Element);
+  expect(global.scrollTo).toHaveBeenCalledWith({ top: 0, behavior: 'smooth' });
+});
+
+test('BackToTop gets hidden again after user scrolls back up', () => {
+  render(<BackToTop />);
+
+  fireEvent.scroll(window, { target: { scrollY: 401 } });
+
+  fireEvent.scroll(window, { target: { scrollY: 0 } });
+  expect(screen.getByRole(`button`).parentElement).toHaveClass('pf-m-hidden');
+});
+
+test('Renders BackToTop when isAlwaysVisible prop is set', () => {
+  render(<BackToTop isAlwaysVisible />);
+
+  expect(screen.getByRole(`button`).parentElement).not.toHaveClass('pf-m-hidden');
+});
+
+test('Renders with custom className prop passed', () => {
+  render(<BackToTop className="test-class" />);
+  expect(screen.getByRole(`button`).parentElement).toHaveClass('test-class');
+});
+
+test('Renders with custom title prop passed', () => {
+  render(<BackToTop title="Back to the Future" />);
+  expect(screen.getByRole(`button`).parentElement).toHaveTextContent('Back to the Future');
+});
+
+test('Renders with passed aria-label', () => {
+  render(<BackToTop aria-label="Back to top test" />);
+  expect(screen.getByRole(`button`).parentElement).toHaveAccessibleName('Back to top test');
+});
+
+test('BackToTop can be accessed via passed innerRef', () => {
+  const testRef: RefObject<HTMLElement> = React.createRef();
+  render(<BackToTop innerRef={testRef} isAlwaysVisible />);
+  global.scrollTo = jest.fn();
+  testRef.current?.click();
+  expect(global.scrollTo).toBeCalledTimes(1);
+});
+
+test('BackToTop reacts to scrolling inside element passed via scrollableSelector', () => {
+  render(
+    <div id="backToTopWrapper">
+      <BackToTop scrollableSelector="#backToTopWrapper" />
+    </div>
+  );
+  const wrapper = document.getElementById('backToTopWrapper');
+  fireEvent.scroll(wrapper as HTMLElement, { target: { scrollY: 401 } });
+
+  expect(screen.getByRole(`button`).parentElement).not.toHaveClass('pf-m-hidden');
+});
+
+test('BackToTop does not react to scrolling inside window when scrollableSelector passed', () => {
+  render(
+    <div id="backToTopWrapper">
+      <BackToTop scrollableSelector="#backToTopWrapper" />
+    </div>
+  );
+  fireEvent.scroll(window, { target: { scrollY: 401 } });
+
+  expect(screen.getByRole(`button`).parentElement).toHaveClass('pf-m-hidden');
+});
+
+test('Clicking backToTop scrolls back to top of the element passed via scrollableSelector', async () => {
+  render(
+    <div id="backToTopWrapper">
+      <BackToTop scrollableSelector="#backToTopWrapper" />
+    </div>
+  );
+  const user = userEvent.setup();
+  const wrapper = document.getElementById('backToTopWrapper');
+  fireEvent.scroll(wrapper as HTMLElement, { target: { scrollY: 401 } });
+  wrapper!.scrollTo = jest.fn();
+  await user.click(screen.getByRole(`button`).parentElement as Element);
+
+  expect(wrapper?.scrollTo).toBeCalledTimes(1);
+});
+
+test('Passes correct text content to button child component', () => {
+  render(<BackToTop title="Back to the future" />);
+
+  expect(screen.getByText('Back to the future')).toBeVisible();
+});
+
+test('Passes correct variant to button child component', () => {
+  render(<BackToTop title="Back to the future" />);
+
+  expect(screen.getByText('primary')).toBeVisible();
+});
+
+test('Passes correct iconPosition to button child component', () => {
+  render(<BackToTop />);
+
+  expect(screen.getByText('right')).toBeVisible();
+});
+
+test('Passes correct icon to button child component', () => {
+  render(<BackToTop />);
+
+  expect(screen.getByTestId('icon').firstChild).toBeTruthy();
+});
 
-  test('verify always show', () => {
-    const { asFragment } = render(<BackToTop isAlwaysVisible>test</BackToTop>);
+test('Matches the snapshot', () => {
+  const { asFragment } = render(<BackToTop />);
 
-    expect(asFragment()).toMatchSnapshot();
-  });
+  expect(asFragment()).toMatchSnapshot();
 });

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

@@ -1,109 +1,36 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`BackToTop verify always show 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-c-back-to-top"
-  >
-    <button
-      aria-disabled="false"
-      class="pf-c-button pf-m-primary"
-      data-ouia-component-id="OUIA-Generated-Button-primary-3"
-      data-ouia-component-type="PF4/Button"
-      data-ouia-safe="true"
-      type="button"
-    >
-      Back to top
-      <span
-        class="pf-c-button__icon pf-m-end"
-      >
-        <svg
-          aria-hidden="true"
-          fill="currentColor"
-          height="1em"
-          role="img"
-          style="vertical-align: -0.125em;"
-          viewBox="0 0 320 512"
-          width="1em"
-        >
-          <path
-            d="M177 159.7l136 136c9.4 9.4 9.4 24.6 0 33.9l-22.6 22.6c-9.4 9.4-24.6 9.4-33.9 0L160 255.9l-96.4 96.4c-9.4 9.4-24.6 9.4-33.9 0L7 329.7c-9.4-9.4-9.4-24.6 0-33.9l136-136c9.4-9.5 24.6-9.5 34-.1z"
-          />
-        </svg>
-      </span>
-    </button>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`BackToTop verify basic 1`] = `
+exports[`Matches the snapshot 1`] = `
 <DocumentFragment>
   <div
     class="pf-c-back-to-top pf-m-hidden"
   >
-    <button
-      aria-disabled="false"
-      class="pf-c-button pf-m-primary"
-      data-ouia-component-id="OUIA-Generated-Button-primary-1"
-      data-ouia-component-type="PF4/Button"
-      data-ouia-safe="true"
-      type="button"
-    >
+    <button>
       Back to top
-      <span
-        class="pf-c-button__icon pf-m-end"
-      >
-        <svg
-          aria-hidden="true"
-          fill="currentColor"
-          height="1em"
-          role="img"
-          style="vertical-align: -0.125em;"
-          viewBox="0 0 320 512"
-          width="1em"
-        >
-          <path
-            d="M177 159.7l136 136c9.4 9.4 9.4 24.6 0 33.9l-22.6 22.6c-9.4 9.4-24.6 9.4-33.9 0L160 255.9l-96.4 96.4c-9.4 9.4-24.6 9.4-33.9 0L7 329.7c-9.4-9.4-9.4-24.6 0-33.9l136-136c9.4-9.5 24.6-9.5 34-.1z"
-          />
-        </svg>
-      </span>
     </button>
-  </div>
-</DocumentFragment>
-`;
-
-exports[`BackToTop verify custom class 1`] = `
-<DocumentFragment>
-  <div
-    class="pf-c-back-to-top pf-m-hidden custom-css"
-  >
-    <button
-      aria-disabled="false"
-      class="pf-c-button pf-m-primary"
-      data-ouia-component-id="OUIA-Generated-Button-primary-2"
-      data-ouia-component-type="PF4/Button"
-      data-ouia-safe="true"
-      type="button"
+    <p>
+      primary
+    </p>
+    <p>
+      right
+    </p>
+    <div
+      data-testid="icon"
     >
-      Back to top
-      <span
-        class="pf-c-button__icon pf-m-end"
+      <svg
+        aria-hidden="true"
+        fill="currentColor"
+        height="1em"
+        role="img"
+        style="vertical-align: -0.125em;"
+        viewBox="0 0 320 512"
+        width="1em"
       >
-        <svg
-          aria-hidden="true"
-          fill="currentColor"
-          height="1em"
-          role="img"
-          style="vertical-align: -0.125em;"
-          viewBox="0 0 320 512"
-          width="1em"
-        >
-          <path
-            d="M177 159.7l136 136c9.4 9.4 9.4 24.6 0 33.9l-22.6 22.6c-9.4 9.4-24.6 9.4-33.9 0L160 255.9l-96.4 96.4c-9.4 9.4-24.6 9.4-33.9 0L7 329.7c-9.4-9.4-9.4-24.6 0-33.9l136-136c9.4-9.5 24.6-9.5 34-.1z"
-          />
-        </svg>
-      </span>
-    </button>
+        <path
+          d="M177 159.7l136 136c9.4 9.4 9.4 24.6 0 33.9l-22.6 22.6c-9.4 9.4-24.6 9.4-33.9 0L160 255.9l-96.4 96.4c-9.4 9.4-24.6 9.4-33.9 0L7 329.7c-9.4-9.4-9.4-24.6 0-33.9l136-136c9.4-9.5 24.6-9.5 34-.1z"
+        />
+      </svg>
+    </div>
   </div>
 </DocumentFragment>
 `;

package/src/demos/examples/DashboardHeader.js

@@ -28,6 +28,7 @@ import HelpIcon from '@patternfly/react-icons/dist/esm/icons/help-icon';
 import QuestionCircleIcon from '@patternfly/react-icons/dist/esm/icons/question-circle-icon';
 import BellIcon from '@patternfly/react-icons/dist/esm/icons/bell-icon';
 import imgAvatar from '@patternfly/react-core/src/components/Avatar/examples/avatarImg.svg';
+import pfColorLogo from '@patternfly/react-core/src/demos/examples/pfColorLogo.svg';
 
 export default class DashboardHeader extends React.Component {
   constructor(props) {
@@ -185,11 +186,11 @@ export default class DashboardHeader extends React.Component {
           <MastheadBrand>
             <Brand
               widths={{ default: '180px', md: '180px', '2xl': '220px' }}
-              src="/assets/images/logo__pf--reverse--base.png"
+              src={pfColorLogo}
               alt="Fallback patternFly default logo"
             >
-              <source media="(min-width: 768px)" srcSet="/assets/images/logo__pf--reverse-on-md.svg" />
-              <source srcSet="/assets/images/logo__pf--reverse--base.svg" />
+              <source media="(min-width: 768px)" srcSet={pfColorLogo} />
+              <source srcSet={pfColorLogo} />
             </Brand>
           </MastheadBrand>
         </MastheadMain>