feat(Data list): Add isNoPlainOnGlass prop to add pf-m-no-plain modifier to the data list

Author: tlabaj

packages/react-core/src/components/DataList/DataList.tsx

@@ -19,27 +19,29 @@ export enum DataListWrapModifier {
 }
 
 export interface DataListProps extends React.HTMLProps<HTMLUListElement> {
-  /** Content rendered inside the DataList list */
+  /** Content rendered inside the data list list */
   children?: React.ReactNode;
-  /** Additional classes added to the DataList list */
+  /** Additional classes added to the data list list */
   className?: string;
-  /** Adds accessible text to the DataList list */
+  /** Adds accessible text to the data list list */
   'aria-label': string;
-  /** Optional callback to make DataList selectable, fired when DataListItem selected */
+  /** Optional callback to make data list selectable, fired when data list item selected */
   onSelectDataListItem?: (event: React.MouseEvent | React.KeyboardEvent, id: string) => void;
-  /** Id of DataList item currently selected */
+  /** Id of data list item currently selected */
   selectedDataListItemId?: string;
-  /** Flag indicating if DataList should have compact styling */
+  /** Flag indicating if data list should have compact styling */
   isCompact?: boolean;
-  /** @beta Flag indicating if DataList should have plain styling with a transparent background */
+  /** @beta Flag indicating if data list should have plain styling with a transparent background */
   isPlain?: boolean;
+  /** @beta Flag to prevent the data list from automatically applying plain styling when glass theme is enabled. When both this and isPlain are true, isPlain takes precedence. */
+  isNoPlainOnGlass?: boolean;
   /** Specifies the grid breakpoints  */
   gridBreakpoint?: 'none' | 'always' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
-  /** Determines which wrapping modifier to apply to the DataList */
+  /** Determines which wrapping modifier to apply to the data list */
   wrapModifier?: DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord';
   /** Object that causes the data list to render hidden inputs which improve selectable item a11y */
   onSelectableRowChange?: (event: React.FormEvent<HTMLInputElement>, id: string) => void;
-  /** @hide custom ref of the DataList */
+  /** @hide custom ref of the data list */
   innerRef?: React.RefObject<HTMLUListElement | null>;
 }
 
@@ -62,12 +64,20 @@ export const DataListBase: React.FunctionComponent<DataListProps> = ({
   selectedDataListItemId = '',
   isCompact = false,
   isPlain = false,
+  isNoPlainOnGlass = false,
   gridBreakpoint = 'md',
   wrapModifier = null,
   onSelectableRowChange,
   innerRef,
   ...props
 }: DataListProps) => {
+  if (isPlain && isNoPlainOnGlass) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      `DataList: When both isPlain and isNoPlainOnGlass are true, isPlain will take precedence and isNoPlainOnGlass will have no effect. It's recommended to pass only one prop according to the current theme.`
+    );
+  }
+
   const isSelectable = onSelectDataListItem !== undefined;
 
   const updateSelectedDataListItem = (event: React.MouseEvent | React.KeyboardEvent, id: string) => {
@@ -88,6 +98,7 @@ export const DataListBase: React.FunctionComponent<DataListProps> = ({
           styles.dataList,
           isCompact && styles.modifiers.compact,
           isPlain && styles.modifiers.plain,
+          isNoPlainOnGlass && styles.modifiers.noPlain,
           gridBreakpointClasses[gridBreakpoint],
           wrapModifier && styles.modifiers[wrapModifier],
           className

packages/react-core/src/components/DataList/DataListAction.tsx

@@ -3,15 +3,15 @@ import styles from '@patternfly/react-styles/css/components/DataList/data-list';
 import { formatBreakpointMods } from '../../helpers/util';
 
 export interface DataListActionProps extends Omit<React.HTMLProps<HTMLDivElement>, 'children'> {
-  /** Content rendered as DataList Action  (e.g <Button> or <Dropdown>) */
+  /** Content rendered as data list action  (e.g <Button> or <Dropdown>) */
   children: React.ReactNode;
-  /** Additional classes added to the DataList Action */
+  /** Additional classes added to the data list action */
   className?: string;
-  /** Identify the DataList toggle number */
+  /** Identify the data list toggle number */
   id: string;
-  /** Adds accessible text to the DataList Action */
+  /** Adds accessible text to the data list action */
   'aria-labelledby': string;
-  /** Adds accessible text to the DataList Action */
+  /** Adds accessible text to the data list action */
   'aria-label': string;
   /** What breakpoints to hide/show the data list action */
   visibility?: {

packages/react-core/src/components/DataList/DataListCell.tsx

@@ -5,19 +5,19 @@ import { DataListWrapModifier } from './DataList';
 import { Tooltip } from '../Tooltip';
 
 export interface DataListCellProps extends Omit<React.HTMLProps<HTMLDivElement>, 'width'> {
-  /** Content rendered inside the DataList cell */
+  /** Content rendered inside the data list cell */
   children?: React.ReactNode;
-  /** Additional classes added to the DataList cell */
+  /** Additional classes added to the data list cell */
   className?: string;
-  /** Width (from 1-5) to the DataList cell */
+  /** Width (from 1-5) to the data list cell */
   width?: 1 | 2 | 3 | 4 | 5;
-  /** Enables the body Content to fill the height of the card */
+  /** Enables the body content to fill the height of the card */
   isFilled?: boolean;
   /**  Aligns the cell content to the right of its parent. */
   alignRight?: boolean;
-  /** Set to true if the cell content is an Icon */
+  /** Set to true if the cell content is an icon */
   isIcon?: boolean;
-  /** Determines which wrapping modifier to apply to the DataListCell */
+  /** Determines which wrapping modifier to apply to the data list cell */
   wrapModifier?: DataListWrapModifier | 'nowrap' | 'truncate' | 'breakWord';
 }
 

packages/react-core/src/components/DataList/DataListItemCells.tsx

@@ -2,7 +2,7 @@ import { css } from '@patternfly/react-styles';
 import styles from '@patternfly/react-styles/css/components/DataList/data-list';
 
 export interface DataListItemCellsProps extends React.HTMLProps<HTMLDivElement> {
-  /** Additional classes added to the DataList item Content Wrapper.  Children should be one ore more <DataListCell> nodes */
+  /** Additional classes added to the data list item content wrapper.  Children should be one ore more <DataListCell> nodes */
   className?: string;
   /** Array of <DataListCell> nodes that are rendered one after the other. */
   dataListCells?: React.ReactNode;

packages/react-core/src/components/DataList/DataListToggle.tsx

@@ -4,17 +4,17 @@ import styles from '@patternfly/react-styles/css/components/DataList/data-list';
 import { Button, ButtonProps, ButtonVariant } from '../Button';
 
 export interface DataListToggleProps extends React.HTMLProps<HTMLDivElement> {
-  /** Additional classes added to the DataList cell */
+  /** Additional classes added to the data list cell */
   className?: string;
-  /** Flag to show if the expanded content of the DataList item is visible */
+  /** Flag to show if the expanded content of the data list item is visible */
   isExpanded?: boolean;
-  /** Identify the DataList toggle number */
+  /** Identify the data list toggle number */
   id: string;
   /** Id for the row */
   rowid?: string;
-  /** Adds accessible text to the DataList toggle */
+  /** Adds accessible text to the data list toggle */
   'aria-labelledby'?: string;
-  /** Adds accessible text to the DataList toggle */
+  /** Adds accessible text to the data list toggle */
   'aria-label'?: string;
   /** Allows users of some screen readers to shift focus to the controlled element. Should be used when the controlled contents are not adjacent to the toggle that controls them. */
   'aria-controls'?: string;

packages/react-core/src/components/DataList/__tests__/DataList.test.tsx

@@ -1,3 +1,4 @@
+import '@testing-library/jest-dom';
 import { render, screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 
@@ -77,6 +78,43 @@ test(`Renders with class ${styles.modifiers.plain} when isPlain is true`, () =>
   expect(screen.getByLabelText('list')).toHaveClass(styles.modifiers.plain);
 });
 
+test(`Renders with ${styles.modifiers.noPlain} when isNoPlainOnGlass is true`, () => {
+  render(<DataList aria-label="list" isNoPlainOnGlass />);
+  expect(screen.getByLabelText('list')).toHaveClass(styles.modifiers.noPlain);
+});
+
+test('Warns when both isPlain and isNoPlainOnGlass are true', () => {
+  const warnSpy = jest.spyOn(global.console, 'warn').mockImplementation(() => {});
+
+  render(<DataList aria-label="list" isPlain isNoPlainOnGlass />);
+
+  expect(warnSpy).toHaveBeenCalledWith(
+    `DataList: When both isPlain and isNoPlainOnGlass are true, isPlain will take precedence and isNoPlainOnGlass will have no effect. It's recommended to pass only one prop according to the current theme.`
+  );
+
+  warnSpy.mockRestore();
+});
+
+test('Does not warn when only isPlain is true', () => {
+  const warnSpy = jest.spyOn(global.console, 'warn').mockImplementation(() => {});
+
+  render(<DataList aria-label="list" isPlain />);
+
+  expect(warnSpy).not.toHaveBeenCalled();
+
+  warnSpy.mockRestore();
+});
+
+test('Does not warn when only isNoPlainOnGlass is true', () => {
+  const warnSpy = jest.spyOn(global.console, 'warn').mockImplementation(() => {});
+
+  render(<DataList aria-label="list" isNoPlainOnGlass />);
+
+  expect(warnSpy).not.toHaveBeenCalled();
+
+  warnSpy.mockRestore();
+});
+
 test('Renders with a hidden input to improve a11y when onSelectableRowChange is passed', () => {
   render(
     <DataList aria-label="this is a simple list" onSelectableRowChange={() => {}}>