@patternfly/react-core 4.202.0 → 4.202.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patternfly/react-core",
-  "version": "4.202.0",
+  "version": "4.202.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",
@@ -34,9 +34,9 @@
     "generate": "node scripts/copyStyles.js"
   },
   "dependencies": {
-    "@patternfly/react-icons": "^4.53.0",
-    "@patternfly/react-styles": "^4.52.0",
-    "@patternfly/react-tokens": "^4.54.0",
+    "@patternfly/react-icons": "^4.53.3",
+    "@patternfly/react-styles": "^4.52.3",
+    "@patternfly/react-tokens": "^4.54.3",
     "focus-trap": "6.2.2",
     "react-dropzone": "9.0.0",
     "tippy.js": "5.1.2",
@@ -60,5 +60,5 @@
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },
-  "gitHead": "a328f46967c052f0d72d77dff763ecbb3318bc4e"
+  "gitHead": "c12101227ce64e1f7920cebfba4404d81d403b93"
 }

package/src/components/DescriptionList/DescriptionList.tsx

@@ -3,7 +3,7 @@ import { css } from '@patternfly/react-styles';
 import styles from '@patternfly/react-styles/css/components/DescriptionList/description-list';
 import { formatBreakpointMods } from '../../helpers';
 
-export interface AutoFitModifiers {
+export interface BreakpointModifiers {
   default?: string;
   md?: string;
   lg?: string;
@@ -30,7 +30,7 @@ export interface DescriptionListProps extends Omit<React.HTMLProps<HTMLDListElem
   isFluid?: boolean;
   /** Sets the the default placement of description list groups to fill from top to bottom. */
   isFillColumns?: boolean;
-  /** Sets the number of columns on the description list */
+  /** Sets the number of columns on the description list at various breakpoints */
   columnModifier?: {
     default?: '1Col' | '2Col' | '3Col';
     sm?: '1Col' | '2Col' | '3Col';
@@ -39,7 +39,7 @@ export interface DescriptionListProps extends Omit<React.HTMLProps<HTMLDListElem
     xl?: '1Col' | '2Col' | '3Col';
     '2xl'?: '1Col' | '2Col' | '3Col';
   };
-  /** Indicates how the menu will align at screen size breakpoints. Default alignment is set via the position property. */
+  /** Indicates how the menu will align at various breakpoints. */
   orientation?: {
     sm?: 'vertical' | 'horizontal';
     md?: 'vertical' | 'horizontal';
@@ -47,6 +47,7 @@ export interface DescriptionListProps extends Omit<React.HTMLProps<HTMLDListElem
     xl?: 'vertical' | 'horizontal';
     '2xl'?: 'vertical' | 'horizontal';
   };
+  /** Sets the minimum column size for the auto-fit (isAutoFit) layout at various breakpoints. */
   autoFitMinModifier?: {
     default?: string;
     sm?: string;
@@ -55,11 +56,19 @@ export interface DescriptionListProps extends Omit<React.HTMLProps<HTMLDListElem
     xl?: string;
     '2xl'?: string;
   };
+  /** Sets the horizontal description list's term column width at various breakpoints. */
+  horizontalTermWidthModifier?: {
+    default?: string;
+    sm?: string;
+    md?: string;
+    lg?: string;
+    xl?: string;
+    '2xl'?: string;
+  };
 }
 
-const setAutoFitMinModifiers = (autoFitMinModifier: AutoFitModifiers) => {
-  const prefix = '--pf-c-description-list--GridTemplateColumns--min';
-  const mods = autoFitMinModifier as Partial<{ [k: string]: string }>;
+const setBreakpointModifiers = (prefix: string, modifiers: BreakpointModifiers) => {
+  const mods = modifiers as Partial<{ [k: string]: string }>;
   return Object.keys(mods || {}).reduce(
     (acc, curr) =>
       curr === 'default' ? { ...acc, [prefix]: mods[curr] } : { ...acc, [`${prefix}-on-${curr}`]: mods[curr] },
@@ -79,33 +88,45 @@ export const DescriptionList: React.FunctionComponent<DescriptionListProps> = ({
   isFillColumns,
   columnModifier,
   autoFitMinModifier,
+  horizontalTermWidthModifier,
   orientation,
   style,
   ...props
-}: DescriptionListProps) => (
-  <dl
-    className={css(
-      styles.descriptionList,
-      (isHorizontal || isFluid) && styles.modifiers.horizontal,
-      isAutoColumnWidths && styles.modifiers.autoColumnWidths,
-      isAutoFit && styles.modifiers.autoFit,
-      formatBreakpointMods(columnModifier, styles),
-      formatBreakpointMods(orientation, styles),
-      isInlineGrid && styles.modifiers.inlineGrid,
-      isCompact && styles.modifiers.compact,
-      isFluid && styles.modifiers.fluid,
-      isFillColumns && styles.modifiers.fillColumns,
-      className
-    )}
-    style={
-      autoFitMinModifier || style
-        ? { ...(isAutoFit ? setAutoFitMinModifiers(autoFitMinModifier) : {}), ...style }
-        : undefined
-    }
-    {...props}
-  >
-    {children}
-  </dl>
-);
+}: DescriptionListProps) => {
+  if (isAutoFit && autoFitMinModifier) {
+    style = {
+      ...style,
+      ...setBreakpointModifiers('--pf-c-description-list--GridTemplateColumns--min', autoFitMinModifier)
+    };
+  }
+  if (isHorizontal && horizontalTermWidthModifier) {
+    style = {
+      ...style,
+      ...setBreakpointModifiers('--pf-c-description-list--m-horizontal__term--width', horizontalTermWidthModifier)
+    };
+  }
+
+  return (
+    <dl
+      className={css(
+        styles.descriptionList,
+        (isHorizontal || isFluid) && styles.modifiers.horizontal,
+        isAutoColumnWidths && styles.modifiers.autoColumnWidths,
+        isAutoFit && styles.modifiers.autoFit,
+        formatBreakpointMods(columnModifier, styles),
+        formatBreakpointMods(orientation, styles),
+        isInlineGrid && styles.modifiers.inlineGrid,
+        isCompact && styles.modifiers.compact,
+        isFluid && styles.modifiers.fluid,
+        isFillColumns && styles.modifiers.fillColumns,
+        className
+      )}
+      style={style}
+      {...props}
+    >
+      {children}
+    </dl>
+  );
+};
 
 DescriptionList.displayName = 'DescriptionList';

package/src/components/DescriptionList/examples/DescriptionList.md

@@ -239,34 +239,93 @@ import {
 } from '@patternfly/react-core';
 import PlusCircleIcon from '@patternfly/react-icons/dist/esm/icons/plus-circle-icon';
 
-<DescriptionList isHorizontal>
-  <DescriptionListGroup>
-    <DescriptionListTerm>Name</DescriptionListTerm>
-    <DescriptionListDescription>Example</DescriptionListDescription>
-  </DescriptionListGroup>
-  <DescriptionListGroup>
-    <DescriptionListTerm>Namespace</DescriptionListTerm>
-    <DescriptionListDescription>
-      <a href="#">mary-test</a>
-    </DescriptionListDescription>
-  </DescriptionListGroup>
-  <DescriptionListGroup>
-    <DescriptionListTerm>Labels</DescriptionListTerm>
-    <DescriptionListDescription>example</DescriptionListDescription>
-  </DescriptionListGroup>
-  <DescriptionListGroup>
-    <DescriptionListTerm>Pod selector</DescriptionListTerm>
-    <DescriptionListDescription>
-      <Button variant="link" isInline icon={<PlusCircleIcon />}>
-        app=MyApp
-      </Button>
-    </DescriptionListDescription>
-  </DescriptionListGroup>
-  <DescriptionListGroup>
-    <DescriptionListTerm>Annotation</DescriptionListTerm>
-    <DescriptionListDescription>2 Annotations</DescriptionListDescription>
-  </DescriptionListGroup>
-</DescriptionList>;
+const DescriptionListHorizontal = () => {
+  return (
+    <DescriptionList isHorizontal>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Name</DescriptionListTerm>
+        <DescriptionListDescription>Example</DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Namespace</DescriptionListTerm>
+        <DescriptionListDescription>
+          <a href="#">mary-test</a>
+        </DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Labels</DescriptionListTerm>
+        <DescriptionListDescription>example</DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Pod selector</DescriptionListTerm>
+        <DescriptionListDescription>
+          <Button variant="link" isInline icon={<PlusCircleIcon />}>
+            app=MyApp
+          </Button>
+        </DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Annotation</DescriptionListTerm>
+        <DescriptionListDescription>2 Annotations</DescriptionListDescription>
+      </DescriptionListGroup>
+    </DescriptionList>
+  )
+}
+```
+
+### Horizontal using custom term width modifier
+
+```js
+import React from 'react';
+import {
+  Button,
+  DescriptionList,
+  DescriptionListTerm,
+  DescriptionListText,
+  DescriptionListGroup,
+  DescriptionListDescription,
+} from '@patternfly/react-core';
+import PlusCircleIcon from '@patternfly/react-icons/dist/esm/icons/plus-circle-icon';
+
+const DescriptionListHorizontalTermWidthModifier = () => {
+  return (
+    <DescriptionList isHorizontal horizontalTermWidthModifier={{
+      default: '12ch',
+      sm: '15ch',
+      md: '20ch',
+      lg: '28ch',
+      xl: '30ch',
+      '2xl': '35ch'
+      }}>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Name longer than the default term width</DescriptionListTerm>
+        <DescriptionListDescription>Example</DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Namespace</DescriptionListTerm>
+        <DescriptionListDescription>
+          <a href="#">mary-test</a>
+        </DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Labels</DescriptionListTerm>
+        <DescriptionListDescription>example</DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Pod selector</DescriptionListTerm>
+        <DescriptionListDescription>
+          <Button variant="link" isInline icon={<PlusCircleIcon />}>
+            app=MyApp
+          </Button>
+        </DescriptionListDescription>
+      </DescriptionListGroup>
+      <DescriptionListGroup>
+        <DescriptionListTerm>Annotation</DescriptionListTerm>
+        <DescriptionListDescription>2 Annotations</DescriptionListDescription>
+      </DescriptionListGroup>
+    </DescriptionList>
+  )
+}
 ```
 
 ### Horizontal 2 col

package/src/components/MenuToggle/MenuToggle.tsx

@@ -17,7 +17,7 @@ export interface MenuToggleProps
   /** Flag indicating the toggle is full height */
   isFullHeight?: boolean;
   /** Variant styles of the menu toggle */
-  variant?: 'default' | 'plain' | 'primary' | 'plainText';
+  variant?: 'default' | 'plain' | 'primary' | 'plainText' | 'secondary';
   /** Optional icon rendered inside the toggle, before the children content */
   icon?: React.ReactNode;
   /** Optional badge rendered inside the toggle, after the children content */
@@ -71,6 +71,7 @@ export class MenuToggleBase extends React.Component<MenuToggleProps> {
           styles.menuToggle,
           isExpanded && styles.modifiers.expanded,
           variant === 'primary' && styles.modifiers.primary,
+          variant === 'secondary' && styles.modifiers.secondary,
           (isPlain || isPlainText) && styles.modifiers.plain,
           isPlainText && styles.modifiers.text,
           isFullHeight && styles.modifiers.fullHeight,

package/src/components/MenuToggle/examples/MenuToggle.css

@@ -0,0 +1,3 @@
+#ws-react-c-menu-toggle-primary .pf-c-menu-toggle, #ws-react-c-menu-toggle-secondary .pf-c-menu-toggle {
+    vertical-align: bottom;
+}

package/src/components/MenuToggle/examples/MenuToggle.md

@@ -6,8 +6,11 @@ propComponents: ['MenuToggle']
 beta: true
 ---
 
+import './MenuToggle.css'
+
 import CogIcon from '@patternfly/react-icons/dist/esm/icons/cog-icon';
 import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon';
+import imgAvatar from '@patternfly/react-core/src/components/Avatar/examples/avatarImg.svg';
 
 ## Examples
 
@@ -41,17 +44,6 @@ import { MenuToggle } from '@patternfly/react-core';
 
 ```
 
-### Icon
-
-```ts
-import React from 'react';
-import { MenuToggle } from '@patternfly/react-core';
-import CogIcon from '@patternfly/react-icons/dist/esm/icons/cog-icon';
-
-<MenuToggle icon={<CogIcon />}>Icon</MenuToggle>;
-
-```
-
 ### Count
 
 ```ts
@@ -84,6 +76,28 @@ import CogIcon from '@patternfly/react-icons/dist/esm/icons/cog-icon';
 
 ```
 
+### Secondary
+
+```ts
+import React from 'react';
+import { MenuToggle } from '@patternfly/react-core';
+import CogIcon from '@patternfly/react-icons/dist/esm/icons/cog-icon';
+
+<React.Fragment>
+  <MenuToggle variant="secondary">Collapsed</MenuToggle>{' '}
+    <MenuToggle variant="secondary" icon={<CogIcon />}>
+    Icon
+  </MenuToggle>{' '}
+  <MenuToggle variant="secondary" isExpanded>
+    Expanded
+  </MenuToggle>{' '}
+  <MenuToggle variant="secondary" isDisabled>
+    Disabled
+  </MenuToggle>
+</React.Fragment>
+
+```
+
 ### Plain
 
 ```ts
@@ -123,6 +137,34 @@ import { MenuToggle } from '@patternfly/react-core';
 </React.Fragment>
 ```
 
+
+### With icon/image and text
+
+```ts
+import React from 'react';
+import { MenuToggle, Avatar } from '@patternfly/react-core';
+import CogIcon from '@patternfly/react-icons/dist/esm/icons/cog-icon';
+
+<React.Fragment>
+  <MenuToggle icon={<CogIcon />} variant="secondary">Icon</MenuToggle>{' '}
+  <MenuToggle icon={<CogIcon />} variant="secondary" isDisabled>Icon</MenuToggle>
+</React.Fragment>
+```
+
+### With avatar and text
+
+```ts
+import React from 'react';
+import { MenuToggle, Avatar } from '@patternfly/react-core';
+import imgAvatar from '@patternfly/react-core/src/components/Avatar/examples/avatarImg.svg';
+
+<React.Fragment>
+  <MenuToggle icon={<Avatar src={imgAvatar} alt="avatar" />}>Ned Username</MenuToggle>{' '}
+  <MenuToggle icon={<Avatar src={imgAvatar} alt="avatar" />} isExpanded>Ned Username</MenuToggle>{' '}
+  <MenuToggle icon={<Avatar src={imgAvatar} alt="avatar" />} isDisabled>Ned Username</MenuToggle>
+</React.Fragment>
+```
+
 ### Full height
 
 ```ts

package/src/components/Popover/Popover.tsx

@@ -67,7 +67,7 @@ export interface PopoverProps {
   /** Distance of the popover to its target, defaults to 25 */
   distance?: number;
   /**
-   * If true, tries to keep the popover in view by flipping it if necessary
+   * If true, tries to keep the popover in view by flipping it if necessary.
    * If the position is set to 'auto', this prop is ignored
    */
   enableFlip?: boolean;