@patternfly/react-core 4.241.1 → 4.241.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patternfly/react-core",
-  "version": "4.241.1",
+  "version": "4.241.3",
   "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.92.1",
-    "@patternfly/react-styles": "^4.91.1",
-    "@patternfly/react-tokens": "^4.93.1",
+    "@patternfly/react-icons": "^4.92.3",
+    "@patternfly/react-styles": "^4.91.3",
+    "@patternfly/react-tokens": "^4.93.3",
     "focus-trap": "6.9.2",
     "react-dropzone": "9.0.0",
     "tippy.js": "5.1.2",
@@ -70,5 +70,5 @@
     "react": "^16.8 || ^17 || ^18",
     "react-dom": "^16.8 || ^17 || ^18"
   },
-  "gitHead": "447aaa1f6cad3927b263c7eb737f16a4c3dde438"
+  "gitHead": "0a76fbdba0aabc4636f2e27a87c7bcc8b6e0939c"
 }

package/src/demos/AlertGroup.md

@@ -0,0 +1,19 @@
+---
+id: Alert group
+section: components
+---
+
+import { useEffect } from 'react';
+import SearchIcon from '@patternfly/react-icons/dist/js/icons/search-icon';
+import DashboardWrapper from './examples/DashboardWrapper';
+import DashboardHeader from './examples/DashboardHeader';
+
+
+## Demos
+
+This demonstrates how you can assemble a full page view including the use of alert group toast notifications with timeout that are also displayed inside the notification drawer.
+
+### Alert group toast with notification drawer
+
+```js file='./examples/AlertGroup/AlertGroupToastWithNotificationDrawer.tsx' isFullscreen
+```

package/src/demos/examples/AlertGroup/AlertGroupToastWithNotificationDrawer.tsx

@@ -0,0 +1,356 @@
+import React, { useEffect } from 'react';
+import {
+  Button,
+  Dropdown,
+  DropdownItem,
+  EmptyState,
+  EmptyStateBody,
+  EmptyStateIcon,
+  KebabToggle,
+  NotificationBadge,
+  NotificationBadgeVariant,
+  NotificationDrawer,
+  NotificationDrawerBody,
+  NotificationDrawerHeader,
+  NotificationDrawerList,
+  NotificationDrawerListItem,
+  NotificationDrawerListItemBody,
+  NotificationDrawerListItemHeader,
+  PageSection,
+  PageSectionVariants,
+  TextContent,
+  Text,
+  Title,
+  DropdownPosition,
+  EmptyStateVariant,
+  NumberInput,
+  Alert,
+  AlertProps,
+  AlertGroup,
+  AlertActionCloseButton
+} from '@patternfly/react-core';
+
+import SearchIcon from '@patternfly/react-icons/dist/js/icons/search-icon';
+import DashboardWrapper from '../DashboardWrapper';
+import DashboardHeader from '../DashboardHeader';
+
+interface NotificationProps {
+  title: string;
+  srTitle: string;
+  variant: 'default' | 'success' | 'danger' | 'warning' | 'info';
+  key: React.Key;
+  timestamp: string;
+  description: string;
+  isNotificationRead: boolean;
+}
+
+export const AlertGroupToastWithNotificationDrawer: React.FunctionComponent = () => {
+  const maxDisplayedAlerts = 3;
+  const minAlerts = 0;
+  const maxAlerts = 100;
+  const alertTimeout = 8000;
+
+  const [isDrawerExpanded, setDrawerExpanded] = React.useState(false);
+  const [openDropdownKey, setOpenDropdownKey] = React.useState<React.Key | null>(null);
+  const [overflowMessage, setOverflowMessage] = React.useState<string>('');
+  const [maxDisplayed, setMaxDisplayed] = React.useState(maxDisplayedAlerts);
+  const [alerts, setAlerts] = React.useState<React.ReactElement<AlertProps>[]>([]);
+  const [notifications, setNotifications] = React.useState<NotificationProps[]>([]);
+
+  useEffect(() => {
+    setOverflowMessage(buildOverflowMessage());
+  }, [maxDisplayed, notifications, alerts]);
+
+  const addNewNotification = (variant: NotificationProps['variant']) => {
+    const variantFormatted = variant.charAt(0).toUpperCase() + variant.slice(1);
+    const title = variantFormatted + ' alert notification';
+    const srTitle = variantFormatted + ' alert';
+    const description = variantFormatted + ' alert notification description';
+    const key = getUniqueId();
+    const timestamp = getTimeCreated();
+
+    setNotifications(prevNotifications => [
+      { title, srTitle, variant, key, timestamp, description, isNotificationRead: false },
+      ...prevNotifications
+    ]);
+
+    if (!isDrawerExpanded) {
+      setAlerts(prevAlerts => [
+        <Alert
+          variant={variant}
+          title={title}
+          timeout={alertTimeout}
+          onTimeout={() => removeAlert(key)}
+          isLiveRegion
+          actionClose={
+            <AlertActionCloseButton title={title} variantLabel={`${variant} alert`} onClose={() => removeAlert(key)} />
+          }
+          key={key}
+          id={key.toString()}
+        >
+          <p>{description}</p>
+        </Alert>,
+        ...prevAlerts
+      ]);
+    }
+  };
+
+  const removeNotification = (key: React.Key) => {
+    setNotifications(prevNotifications => prevNotifications.filter(notification => notification.key !== key));
+  };
+
+  const removeAllNotifications = () => {
+    setNotifications([]);
+  };
+
+  const isNotificationRead = (key: React.Key) =>
+    notifications.find(notification => notification.key === key)?.isNotificationRead;
+
+  const markNotificationRead = (key: React.Key) => {
+    setNotifications(prevNotifications =>
+      prevNotifications.map(notification =>
+        notification.key === key ? { ...notification, isNotificationRead: true } : notification
+      )
+    );
+  };
+
+  const markAllNotificationsRead = () => {
+    setNotifications(prevNotifications =>
+      prevNotifications.map(notification => ({ ...notification, isNotificationRead: true }))
+    );
+  };
+
+  const getUnreadNotificationsNumber = () =>
+    notifications.filter(notification => notification.isNotificationRead === false).length;
+
+  const containsUnreadAlertNotification = () =>
+    notifications.filter(notification => notification.isNotificationRead === false && notification.variant === 'danger')
+      .length > 0;
+
+  const getNotificationBadgeVariant = () => {
+    if (getUnreadNotificationsNumber() === 0) {
+      return NotificationBadgeVariant.read;
+    }
+    if (containsUnreadAlertNotification()) {
+      return NotificationBadgeVariant.attention;
+    }
+    return NotificationBadgeVariant.unread;
+  };
+
+  const onNotificationBadgeClick = () => {
+    removeAllAlerts();
+    setDrawerExpanded(!isDrawerExpanded);
+  };
+
+  const onDropdownToggle = (id: React.Key, isActive: boolean) => {
+    if (isActive) {
+      setOpenDropdownKey(id);
+      return;
+    }
+    setOpenDropdownKey(null);
+  };
+
+  const onDropdownSelect = () => {
+    setOpenDropdownKey(null);
+  };
+
+  const buildOverflowMessage = () => {
+    const overflow = alerts.length - maxDisplayed;
+    if (overflow > 0 && maxDisplayed > 0) {
+      return `View ${overflow} more notification(s) in notification drawer`;
+    }
+    return '';
+  };
+
+  const getUniqueId = () => new Date().getTime();
+
+  const getTimeCreated = () => {
+    const dateCreated = new Date();
+    return (
+      dateCreated.toDateString() +
+      ' at ' +
+      ('00' + dateCreated.getHours().toString()).slice(-2) +
+      ':' +
+      ('00' + dateCreated.getMinutes().toString()).slice(-2)
+    );
+  };
+
+  const removeAlert = (key: React.Key) => {
+    setAlerts(prevAlerts => prevAlerts.filter(alert => alert.props.id !== key.toString()));
+  };
+
+  const removeAllAlerts = () => {
+    setAlerts([]);
+  };
+
+  const onAlertGroupOverflowClick = () => {
+    removeAllAlerts();
+    setDrawerExpanded(true);
+  };
+
+  const onMaxDisplayedAlertsMinus = () => {
+    setMaxDisplayed(normalizeAlertsNumber(maxDisplayed - 1));
+  };
+
+  const onMaxDisplayedAlertsChange = (event: any) => {
+    setMaxDisplayed(normalizeAlertsNumber(Number(event.target.value)));
+  };
+
+  const onMaxDisplayedAlertsPlus = () => {
+    setMaxDisplayed(normalizeAlertsNumber(maxDisplayed + 1));
+  };
+
+  const normalizeAlertsNumber = (value: number) => Math.max(Math.min(value, maxAlerts), minAlerts);
+
+  const alertButtonStyle = { marginRight: '8px', marginTop: '8px' };
+
+  const notificationBadge = (
+    <NotificationBadge
+      variant={getNotificationBadgeVariant()}
+      onClick={onNotificationBadgeClick}
+      aria-label="Notifications"
+    ></NotificationBadge>
+  );
+
+  const notificationDrawerActions = [
+    <DropdownItem key="markAllRead" onClick={markAllNotificationsRead} component="button">
+      Mark all read
+    </DropdownItem>,
+    <DropdownItem key="clearAll" onClick={removeAllNotifications} component="button">
+      Clear all
+    </DropdownItem>
+  ];
+
+  const notificationDrawerDropdownItems = (key: React.Key) => [
+    <DropdownItem key="markRead" component="button" onClick={() => markNotificationRead(key)}>
+      Mark as read
+    </DropdownItem>,
+    <DropdownItem key="action" component="button" onClick={() => removeNotification(key)}>
+      Clear
+    </DropdownItem>
+  ];
+
+  const notificationDrawer = (
+    <NotificationDrawer>
+      <NotificationDrawerHeader count={getUnreadNotificationsNumber()} onClose={() => setDrawerExpanded(false)}>
+        <Dropdown
+          onSelect={onDropdownSelect}
+          toggle={
+            <KebabToggle
+              onToggle={isActive => onDropdownToggle('dropdown-toggle-id-0', isActive)}
+              id="dropdown-toggle-id-0"
+            />
+          }
+          isOpen={openDropdownKey === 'dropdown-toggle-id-0'}
+          isPlain
+          dropdownItems={notificationDrawerActions}
+          id="notification-drawer-0"
+          position={DropdownPosition.right}
+        />
+      </NotificationDrawerHeader>
+      <NotificationDrawerBody>
+        {notifications.length !== 0 && (
+          <NotificationDrawerList>
+            {notifications.map(({ key, variant, title, srTitle, description, timestamp }) => (
+              <NotificationDrawerListItem
+                key={key}
+                variant={variant}
+                isRead={isNotificationRead(key)}
+                onClick={() => markNotificationRead(key)}
+              >
+                <NotificationDrawerListItemHeader variant={variant} title={title} srTitle={srTitle}>
+                  <Dropdown
+                    position={DropdownPosition.right}
+                    onSelect={onDropdownSelect}
+                    toggle={<KebabToggle onToggle={isActive => onDropdownToggle(key, isActive)} id={key.toString()} />}
+                    isOpen={openDropdownKey === key}
+                    isPlain
+                    dropdownItems={notificationDrawerDropdownItems(key)}
+                    id={key.toString()}
+                  />
+                </NotificationDrawerListItemHeader>
+                <NotificationDrawerListItemBody timestamp={timestamp}> {description} </NotificationDrawerListItemBody>
+              </NotificationDrawerListItem>
+            ))}
+          </NotificationDrawerList>
+        )}
+        {notifications.length === 0 && (
+          <EmptyState variant={EmptyStateVariant.full}>
+            <EmptyStateIcon icon={SearchIcon} />
+            <Title headingLevel="h2" size="lg">
+              No notifications found
+            </Title>
+            <EmptyStateBody>There are currently no notifications.</EmptyStateBody>
+          </EmptyState>
+        )}
+      </NotificationDrawerBody>
+    </NotificationDrawer>
+  );
+
+  return (
+    <DashboardWrapper
+      header={<DashboardHeader notificationBadge={notificationBadge} />}
+      mainContainerId="main-content-page-layout-default-nav"
+      notificationDrawer={notificationDrawer}
+      isNotificationDrawerExpanded={isDrawerExpanded}
+    >
+      <PageSection variant={PageSectionVariants.light}>
+        <TextContent>
+          <Text component="h1">Alert Group with Notification Drawer demo</Text>
+          <Text component="p">
+            New alerts can be added with buttons below. Each alert has a timeout of 7 seconds, however, even after the
+            timeout expires, all alerts are still visible in the notification drawer. By default, only 3 alerts are
+            displayed. The rest can be accessed in the notification drawer after clicking on the bell icon in the header
+            or by clicking on the overflow message.
+          </Text>
+        </TextContent>
+      </PageSection>
+
+      <PageSection variant={PageSectionVariants.light}>
+        <Button variant="secondary" onClick={() => addNewNotification('success')} style={alertButtonStyle}>
+          Add toast success alert
+        </Button>
+        <Button variant="secondary" onClick={() => addNewNotification('danger')} style={alertButtonStyle}>
+          Add toast danger alert
+        </Button>
+        <Button variant="secondary" onClick={() => addNewNotification('info')} style={alertButtonStyle}>
+          Add toast info alert
+        </Button>
+        <br />
+        <br />
+        <Button variant="secondary" onClick={() => addNewNotification('warning')} style={alertButtonStyle}>
+          Add toast warning alert
+        </Button>
+        <Button variant="secondary" onClick={() => addNewNotification('default')} style={alertButtonStyle}>
+          Add toast default alert
+        </Button>
+      </PageSection>
+
+      <PageSection variant={PageSectionVariants.light}>
+        <TextContent>
+          <br />
+          <Text component="h2">Max displayed alerts</Text>
+          <Text component="p">The maximum number of displayed alerts can be set below.</Text>
+        </TextContent>
+        <NumberInput
+          value={maxDisplayed}
+          min={minAlerts}
+          max={maxAlerts}
+          onMinus={onMaxDisplayedAlertsMinus}
+          onChange={onMaxDisplayedAlertsChange}
+          onPlus={onMaxDisplayedAlertsPlus}
+          inputName="input"
+          inputAriaLabel="max diplayed alerts number input"
+          minusBtnAriaLabel="minus"
+          plusBtnAriaLabel="plus"
+          style={{ margin: '12px 0' }}
+        />
+      </PageSection>
+      <PageSection variant={PageSectionVariants.light}>
+        <AlertGroup isToast isLiveRegion onOverflowClick={onAlertGroupOverflowClick} overflowMessage={overflowMessage}>
+          {alerts.slice(0, maxDisplayed)}
+        </AlertGroup>
+      </PageSection>
+    </DashboardWrapper>
+  );
+};

package/src/demos/examples/DashboardHeader.js

@@ -92,6 +92,7 @@ export default class DashboardHeader extends React.Component {
 
   render() {
     const { isDropdownOpen, isKebabDropdownOpen, isAppLauncherOpen } = this.state;
+    const { notificationBadge } = this.props;
 
     const kebabDropdownItems = [
       <DropdownItem key="kebab-1">
@@ -128,9 +129,18 @@ export default class DashboardHeader extends React.Component {
             alignment={{ default: 'alignRight' }}
             spacer={{ default: 'spacerNone', md: 'spacerMd' }}
           >
-            <ToolbarItem>
-              <Button aria-label="Notifications" variant={ButtonVariant.plain} icon={<BellIcon />} />
-            </ToolbarItem>
+            {notificationBadge ? (
+              notificationBadge
+            ) : (
+              <ToolbarItem>
+                <Button
+                  aria-label="Notifications"
+                  variant={ButtonVariant.plain}
+                  icon={<BellIcon />}
+                  onClick={() => {}}
+                />
+              </ToolbarItem>
+            )}
             <ToolbarGroup variant="icon-button-group" visibility={{ default: 'hidden', lg: 'visible' }}>
               <ToolbarItem visibility={{ default: 'hidden', sm: 'hidden', lg: 'visible' }}>
                 <ApplicationLauncher

package/src/demos/examples/DashboardWrapper.js

@@ -58,6 +58,8 @@ export default class DashboardWrapper extends React.Component {
       sidebarNavOpen,
       onPageResize,
       hasNoBreadcrumb,
+      notificationDrawer,
+      isNotificationDrawerExpanded,
       hasPageTemplateTitle
     } = this.props;
 
@@ -103,6 +105,8 @@ export default class DashboardWrapper extends React.Component {
         skipToContent={PageSkipToContent}
         breadcrumb={renderedBreadcrumb}
         mainContainerId={mainContainerId ? mainContainerId : 'main-content-page-layout-default-nav'}
+        notificationDrawer={notificationDrawer}
+        isNotificationDrawerExpanded={isNotificationDrawerExpanded}
         onPageResize={onPageResize}
       >
         {hasPageTemplateTitle && PageTemplateTitle}