@patternfly/react-core 4.238.0 → 4.239.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patternfly/react-core",
-  "version": "4.238.0",
+  "version": "4.239.0",
   "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.89.0",
-    "@patternfly/react-styles": "^4.88.0",
-    "@patternfly/react-tokens": "^4.90.0",
+    "@patternfly/react-icons": "^4.90.0",
+    "@patternfly/react-styles": "^4.89.0",
+    "@patternfly/react-tokens": "^4.91.0",
     "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": "844856ede5d24e9c60242140404ef95c4acc50b1"
+  "gitHead": "d5b77ee797de7d6babd7f2add1fb238812282d64"
 }

package/src/next/components/Dropdown/Dropdown.tsx

@@ -0,0 +1,115 @@
+import React from 'react';
+import { css } from '@patternfly/react-styles';
+import { Menu, MenuContent, MenuProps } from '../../../components/Menu';
+import { Popper } from '../../../helpers/Popper/Popper';
+
+export interface DropdownProps extends MenuProps {
+  /** Anything which can be rendered in a dropdown. */
+  children?: React.ReactNode;
+  /** Classes applied to root element of dropdown. */
+  className?: string;
+  /** Renderer for a custom dropdown toggle. Forwards a ref to the toggle. */
+  toggle: (toggleRef: React.RefObject<any>) => React.ReactNode;
+  /** Flag to indicate if menu is opened.*/
+  isOpen?: boolean;
+  /** Function callback called when user selects item. */
+  onSelect?: (event?: React.MouseEvent<Element, MouseEvent>, itemId?: string | number) => void;
+  /** Callback to allow the dropdown component to change the open state of the menu.
+   * Triggered by clicking outside of the menu, or by pressing either tab or escape. */
+  onOpenChange?: (isOpen: boolean) => void;
+  /** Indicates if the menu should be without the outer box-shadow. */
+  isPlain?: boolean;
+  /** Indicates if the menu should be scrollable. */
+  isScrollable?: boolean;
+  /** Min width of the menu. */
+  minWidth?: string;
+}
+
+export const Dropdown: React.FunctionComponent<DropdownProps> = ({
+  children,
+  className,
+  onSelect,
+  isOpen,
+  toggle,
+  onOpenChange,
+  isPlain,
+  isScrollable,
+  minWidth,
+  ...props
+}: DropdownProps) => {
+  const localMenuRef = React.useRef<HTMLDivElement>();
+  const toggleRef = React.useRef<HTMLButtonElement>();
+  const containerRef = React.useRef<HTMLDivElement>();
+
+  const menuRef = (props.innerRef as React.RefObject<HTMLDivElement>) || localMenuRef;
+  React.useEffect(() => {
+    const handleMenuKeys = (event: KeyboardEvent) => {
+      if (!isOpen && toggleRef.current?.contains(event.target as Node)) {
+        // toggle was clicked open, focus on first menu item
+        if (event.key === 'Enter') {
+          setTimeout(() => {
+            const firstElement = menuRef.current.querySelector('li > button:not(:disabled)');
+            firstElement && (firstElement as HTMLElement).focus();
+          }, 0);
+        }
+      }
+      // Close the menu on tab or escape if onOpenChange is provided
+      if (
+        (isOpen && onOpenChange && menuRef.current?.contains(event.target as Node)) ||
+        toggleRef.current?.contains(event.target as Node)
+      ) {
+        if (event.key === 'Escape' || event.key === 'Tab') {
+          onOpenChange(!isOpen);
+          toggleRef.current?.focus();
+        }
+      }
+    };
+
+    const handleClickOutside = (event: MouseEvent) => {
+      // If the event is not on the toggle and onOpenChange callback is provided, close the menu
+      if (isOpen && onOpenChange && !toggleRef?.current?.contains(event.target as Node)) {
+        if (isOpen && !menuRef.current?.contains(event.target as Node)) {
+          onOpenChange(false);
+        }
+      }
+    };
+
+    window.addEventListener('keydown', handleMenuKeys);
+    window.addEventListener('click', handleClickOutside);
+
+    return () => {
+      window.removeEventListener('keydown', handleMenuKeys);
+      window.removeEventListener('click', handleClickOutside);
+    };
+  }, [isOpen, menuRef, onOpenChange]);
+
+  const menu = (
+    <Menu
+      className={css(className)}
+      ref={menuRef}
+      onSelect={(event, itemId) => onSelect(event, itemId)}
+      isPlain={isPlain}
+      isScrollable={isScrollable}
+      {...(minWidth && {
+        style: {
+          '--pf-c-menu--MinWidth': minWidth
+        } as React.CSSProperties
+      })}
+      {...props}
+    >
+      <MenuContent>{children}</MenuContent>
+    </Menu>
+  );
+  return (
+    <div ref={containerRef}>
+      <Popper
+        trigger={toggle(toggleRef)}
+        removeFindDomNode
+        popper={menu}
+        appendTo={containerRef.current || undefined}
+        isVisible={isOpen}
+      />
+    </div>
+  );
+};
+Dropdown.displayName = 'Dropdown';

package/src/next/components/Dropdown/DropdownGroup.tsx

@@ -0,0 +1,25 @@
+import React from 'react';
+import { css } from '@patternfly/react-styles';
+import { MenuGroupProps, MenuGroup } from '../../../components/Menu';
+
+export interface DropdownGroupProps extends Omit<MenuGroupProps, 'ref'> {
+  /** Anything which can be rendered in a dropdown group. */
+  children: React.ReactNode;
+  /** Classes applied to root element of dropdown group */
+  className?: string;
+  /** Label of the dropdown group */
+  label?: string;
+}
+
+export const DropdownGroup: React.FunctionComponent<DropdownGroupProps> = ({
+  children,
+  className,
+  label,
+  labelHeadingLevel = 'h1',
+  ...props
+}: DropdownGroupProps) => (
+  <MenuGroup className={css(className)} label={label} labelHeadingLevel={labelHeadingLevel} {...props}>
+    {children}
+  </MenuGroup>
+);
+DropdownGroup.displayName = 'DropdownGroup';

package/src/next/components/Dropdown/DropdownItem.tsx

@@ -0,0 +1,24 @@
+import React from 'react';
+import { css } from '@patternfly/react-styles';
+import { MenuItemProps, MenuItem } from '../../../components/Menu';
+
+export interface DropdownItemProps extends Omit<MenuItemProps, 'ref'> {
+  /** Anything which can be rendered in a dropdown item */
+  children?: React.ReactNode;
+  /** Classes applied to root element of dropdown item */
+  className?: string;
+  /** Description of the dropdown item */
+  description?: React.ReactNode;
+}
+
+export const DropdownItem: React.FunctionComponent<MenuItemProps> = ({
+  children,
+  className,
+  description,
+  ...props
+}: DropdownItemProps) => (
+  <MenuItem className={css(className)} description={description} {...props}>
+    {children}
+  </MenuItem>
+);
+DropdownItem.displayName = 'DropdownItem';

package/src/next/components/Dropdown/DropdownList.tsx

@@ -0,0 +1,21 @@
+import React from 'react';
+import { css } from '@patternfly/react-styles';
+import { MenuListProps, MenuList } from '../../../components/Menu';
+
+export interface DropdownListProps extends MenuListProps {
+  /** Anything which can be rendered in a dropdown list */
+  children: React.ReactNode;
+  /** Classes applied to root element of dropdown list */
+  className?: string;
+}
+
+export const DropdownList: React.FunctionComponent<MenuListProps> = ({
+  children,
+  className,
+  ...props
+}: DropdownListProps) => (
+  <MenuList className={css(className)} {...props}>
+    {children}
+  </MenuList>
+);
+DropdownList.displayName = 'DropdownList';

package/src/next/components/Dropdown/examples/Dropdown.md

@@ -0,0 +1,31 @@
+---
+id: Dropdown
+section: components
+cssPrefix: pf-c-dropdown
+propComponents: ['Dropdown', DropdownGroup, 'DropdownItem', 'DropdownList']
+beta: true
+---
+
+import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon';
+
+## Examples
+
+### Basic
+
+```ts file="./DropdownBasic.tsx"
+```
+
+### With kebab toggle
+
+```ts file="./DropdownWithKebabToggle.tsx"
+```
+
+### With groups
+
+```ts file="./DropdownWithGroups.tsx"
+```
+
+### With descriptions
+
+```ts file="./DropdownWithDescriptions.tsx"
+```

package/src/next/components/Dropdown/examples/DropdownBasic.tsx

@@ -0,0 +1,54 @@
+import React from 'react';
+import { Dropdown, DropdownItem, DropdownList } from '@patternfly/react-core/next';
+import { Divider, MenuToggle } from '@patternfly/react-core';
+
+export const DropdownBasic: React.FunctionComponent = () => {
+  const [isOpen, setIsOpen] = React.useState(false);
+  const menuRef = React.useRef<HTMLDivElement>(null);
+
+  const onToggleClick = () => {
+    setIsOpen(!isOpen);
+  };
+
+  const onSelect = (_event: React.MouseEvent<Element, MouseEvent> | undefined, itemId: string | number | undefined) => {
+    // eslint-disable-next-line no-console
+    console.log('selected', itemId);
+    setIsOpen(false);
+  };
+
+  return (
+    <Dropdown
+      innerRef={menuRef}
+      isOpen={isOpen}
+      onSelect={onSelect}
+      onOpenChange={isOpen => setIsOpen(isOpen)}
+      toggle={toggleRef => (
+        <MenuToggle ref={toggleRef} onClick={onToggleClick} isExpanded={isOpen}>
+          Dropdown
+        </MenuToggle>
+      )}
+    >
+      <DropdownList>
+        <DropdownItem itemId={0} key="link">
+          Link
+        </DropdownItem>
+        <DropdownItem itemId={1} key="action" to="#default-link2" onClick={ev => ev.preventDefault()}>
+          Action
+        </DropdownItem>
+        <DropdownItem itemId={2} isDisabled key="disabled link">
+          Disabled link
+        </DropdownItem>
+        <DropdownItem itemId={3} isDisabled key="disabled action" to="#default-link4">
+          Disabled action
+        </DropdownItem>
+        <Divider key="separator" />
+        <DropdownItem itemId={4} key="separated link">
+          Separated link
+        </DropdownItem>
+        <DropdownItem itemId={5} key="separated action">
+          Separated action
+        </DropdownItem>
+      </DropdownList>
+    </Dropdown>
+  );
+};

package/src/next/components/Dropdown/examples/DropdownWithDescriptions.tsx

@@ -0,0 +1,60 @@
+import React from 'react';
+import { Dropdown, DropdownItem, DropdownList } from '@patternfly/react-core/next';
+import { MenuToggle } from '@patternfly/react-core';
+
+export const DropdownWithDescriptions: React.FunctionComponent = () => {
+  const [isOpen, setIsOpen] = React.useState(false);
+  const menuRef = React.useRef<HTMLDivElement>(null);
+
+  const onToggleClick = () => {
+    setIsOpen(!isOpen);
+  };
+
+  const onSelect = (_event: React.MouseEvent<Element, MouseEvent> | undefined, itemId: string | number | undefined) => {
+    // eslint-disable-next-line no-console
+    console.log('selected', itemId);
+    setIsOpen(false);
+  };
+
+  return (
+    <Dropdown
+      innerRef={menuRef}
+      isOpen={isOpen}
+      onSelect={onSelect}
+      minWidth="150px"
+      onOpenChange={isOpen => setIsOpen(isOpen)}
+      toggle={toggleRef => (
+        <MenuToggle ref={toggleRef} isFullWidth onClick={onToggleClick} isExpanded={isOpen}>
+          Dropdown
+        </MenuToggle>
+      )}
+    >
+      <DropdownList>
+        <DropdownItem itemId={0} key="link" description="This is a description">
+          Link
+        </DropdownItem>
+        <DropdownItem
+          itemId={1}
+          key="action"
+          description="This is a very long description that describes the menu item"
+          to="#default-link2"
+          onClick={ev => ev.preventDefault()}
+        >
+          Action
+        </DropdownItem>
+        <DropdownItem itemId={2} isDisabled description="Disabled link description" key="disabled link">
+          Disabled link
+        </DropdownItem>
+        <DropdownItem
+          itemId={3}
+          isDisabled
+          description="This is a description"
+          key="disabled action"
+          to="#default-link4"
+        >
+          Disabled action
+        </DropdownItem>
+      </DropdownList>
+    </Dropdown>
+  );
+};

package/src/next/components/Dropdown/examples/DropdownWithGroups.tsx

@@ -0,0 +1,65 @@
+import React from 'react';
+import { Dropdown, DropdownGroup, DropdownItem, DropdownList } from '@patternfly/react-core/next';
+import { MenuToggle, Divider } from '@patternfly/react-core';
+
+export const DropdownWithGroups: React.FunctionComponent = () => {
+  const [isOpen, setIsOpen] = React.useState(false);
+  const menuRef = React.useRef<HTMLDivElement>(null);
+
+  const onToggleClick = () => {
+    setIsOpen(!isOpen);
+  };
+
+  const onSelect = (_event: React.MouseEvent<Element, MouseEvent> | undefined, itemId: string | number | undefined) => {
+    // eslint-disable-next-line no-console
+    console.log('selected', itemId);
+    setIsOpen(false);
+  };
+
+  return (
+    <Dropdown
+      innerRef={menuRef}
+      isOpen={isOpen}
+      onSelect={onSelect}
+      onOpenChange={isOpen => setIsOpen(isOpen)}
+      toggle={toggleRef => (
+        <MenuToggle ref={toggleRef} onClick={onToggleClick} isExpanded={isOpen}>
+          Dropdown
+        </MenuToggle>
+      )}
+    >
+      <DropdownGroup>
+        <DropdownList>
+          <DropdownItem itemId={0} key="link">
+            Link
+          </DropdownItem>
+          <DropdownItem itemId={1} key="action" to="#default-link2" onClick={ev => ev.preventDefault()}>
+            Action
+          </DropdownItem>
+        </DropdownList>
+      </DropdownGroup>
+      <Divider />
+      <DropdownGroup label="Group 2" labelHeadingLevel="h3">
+        <DropdownList>
+          <DropdownItem itemId={2} key="group2 link">
+            Group 2 link
+          </DropdownItem>
+          <DropdownItem itemId={3} key="group2 action" to="#default-link4">
+            group 2 action
+          </DropdownItem>
+        </DropdownList>
+      </DropdownGroup>
+      <Divider />
+      <DropdownGroup label="Group 3" labelHeadingLevel="h3">
+        <DropdownList>
+          <DropdownItem itemId={4} key="group3 link">
+            Group 3 link
+          </DropdownItem>
+          <DropdownItem itemId={5} key="group3 action">
+            Group 3 action
+          </DropdownItem>
+        </DropdownList>
+      </DropdownGroup>
+    </Dropdown>
+  );
+};

package/src/next/components/Dropdown/examples/DropdownWithKebabToggle.tsx

@@ -0,0 +1,62 @@
+import React from 'react';
+import { Dropdown, DropdownItem, DropdownList } from '@patternfly/react-core/next';
+import { Divider, MenuToggle } from '@patternfly/react-core';
+import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon';
+
+export const DropdownWithKebab: React.FunctionComponent = () => {
+  const [isOpen, setIsOpen] = React.useState(false);
+  const menuRef = React.useRef<HTMLDivElement>(null);
+
+  const onToggleClick = () => {
+    setIsOpen(!isOpen);
+  };
+
+  const onSelect = (_event: React.MouseEvent<Element, MouseEvent> | undefined, itemId: string | number | undefined) => {
+    // eslint-disable-next-line no-console
+    console.log('selected', itemId);
+    setIsOpen(false);
+  };
+
+  return (
+    <Dropdown
+      innerRef={menuRef}
+      isOpen={isOpen}
+      onSelect={onSelect}
+      minWidth="150px"
+      onOpenChange={isOpen => setIsOpen(isOpen)}
+      toggle={toggleRef => (
+        <MenuToggle
+          ref={toggleRef}
+          aria-label="kebab dropdown toggle"
+          variant="plain"
+          onClick={onToggleClick}
+          isExpanded={isOpen}
+        >
+          <EllipsisVIcon />
+        </MenuToggle>
+      )}
+    >
+      <DropdownList>
+        <DropdownItem itemId={0} key="link">
+          Link
+        </DropdownItem>
+        <DropdownItem itemId={1} key="action" to="#default-link2" onClick={ev => ev.preventDefault()}>
+          Action
+        </DropdownItem>
+        <DropdownItem itemId={2} isDisabled key="disabled link">
+          Disabled link
+        </DropdownItem>
+        <DropdownItem itemId={3} isDisabled key="disabled action" to="#default-link4">
+          Disabled action
+        </DropdownItem>
+        <Divider key="separator" />,
+        <DropdownItem itemId={4} key="separated link">
+          Separated link
+        </DropdownItem>
+        <DropdownItem itemId={5} key="separated action">
+          Separated action
+        </DropdownItem>
+      </DropdownList>
+    </Dropdown>
+  );
+};

package/src/next/components/Dropdown/index.ts

@@ -0,0 +1,4 @@
+export * from './Dropdown';
+export * from './DropdownGroup';
+export * from './DropdownItem';
+export * from './DropdownList';

package/src/next/components/index.ts

@@ -1 +1,2 @@
 export * from './Wizard';
+export * from './Dropdown';