fix(StaleDataWarning): rename CullingInfo to StaleDataWarning; fix wording

Author: InsaneZein

packages/module/patternfly-docs/content/extensions/component-groups/examples/CullingInfo/CullingInfo.md

@@ -0,0 +1,37 @@
+---
+# Sidenav top-level section
+# should be the same for all markdown files
+section: Component groups
+subsection: Status and state indicators
+# Sidenav secondary level section
+# should be the same for all markdown files
+id: Stale Data Warning
+# Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
+source: react
+# If you use typescript, the name of the interface to display props for
+# These are found through the sourceProps function provided in patternfly-docs.source.js
+propComponents: ['StaleDataWarning']
+sourceLink: https://github.com/patternfly/react-component-groups/blob/main/packages/module/patternfly-docs/content/extensions/component-groups/examples/StaleDataWarning/StaleDataWarning.md
+---
+
+import StaleDataWarning from '@patternfly/react-component-groups/dist/dynamic/StaleDataWarning';
+
+A **Stale Data Warning** component displays a warning status when an object is stale and planned for removal. Additional warning details can be displayed as a tooltip or text label. 
+
+## Examples
+
+### Basic stale data warning example
+
+A basic stale data warning component displays a warning icon with additional details in a tooltip, including a timeline for data removal. 
+
+```js file="./StaleDataWarningExample.tsx"
+
+```
+
+### Stale data warning with customized props
+
+Instead of sharing details in a tooltip, you can place a short message beside the icon. You can still utilize all properties of the [Tooltip component](/components/tooltip), with the exception of `content`.
+
+```js file="./StaleDataWarningCustomExample.tsx"
+
+```

packages/module/patternfly-docs/content/extensions/component-groups/examples/StaleDataWarning/StaleDataWarning.md

@@ -1,5 +1,5 @@
 import React from 'react';
-import CullingInformation from '@patternfly/react-component-groups/dist/dynamic/CullingInfo';
+import StaleDataWarning from '@patternfly/react-component-groups/dist/dynamic/StaleDataWarning';
 import { Stack, StackItem } from '@patternfly/react-core';
 
 
@@ -10,23 +10,23 @@ export const CustomizedRenderExample: React.FunctionComponent = () => {
   return <>
     <Stack>
       <StackItem>
-        <CullingInformation
+        <StaleDataWarning
           stale={staleDate}
           currDate={new Date()}
           culled={cullingDate}
           staleWarning={warningDate}
           render={({ msg }) => (<React.Fragment>{msg}</React.Fragment>)}>
-        </CullingInformation>
+        </StaleDataWarning>
       </StackItem>
 
       <StackItem>
-        <CullingInformation
+        <StaleDataWarning
           stale={staleDate}
           currDate={new Date()}
           culled={new Date('Fri Feb 07 2024')}
           staleWarning={new Date('Mon Feb 03 2024')}
-          render={() => (<React.Fragment>This is an error message. Item is past due</React.Fragment>)}>
-        </CullingInformation>
+          render={() => (<React.Fragment>This is an error message where the item is overdue</React.Fragment>)}>
+        </StaleDataWarning>
       </StackItem>
     </Stack>
 

packages/module/patternfly-docs/content/extensions/component-groups/examples/CullingInfo/CullingInfoCustomExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/StaleDataWarning/StaleDataWarningCustomExample.tsx

@@ -1,5 +1,5 @@
 import React from 'react';
-import CullingInformation from '@patternfly/react-component-groups/dist/dynamic/CullingInfo';
+import StaleDataWarning from '@patternfly/react-component-groups/dist/dynamic/StaleDataWarning';
 import { Stack, StackItem } from '@patternfly/react-core';
 
 export const BasicExample: React.FunctionComponent = () => {
@@ -9,22 +9,22 @@ export const BasicExample: React.FunctionComponent = () => {
   return <>
     <Stack>
       <StackItem>
-        <CullingInformation
+        <StaleDataWarning
           stale={staleDate}
           currDate={new Date()}
           culled={cullingDate}
           staleWarning={warningDate}>
-        </CullingInformation>
+        </StaleDataWarning>
       </StackItem>
 
       <StackItem>
-        <CullingInformation
+        <StaleDataWarning
           stale={staleDate}
           currDate={new Date()}
           culled={new Date('Fri Feb 17 2024')}
           staleWarning={new Date('Mon Feb 5 2024')}
         >
-        </CullingInformation>
+        </StaleDataWarning>
       </StackItem>
     </Stack>
 

packages/module/patternfly-docs/content/extensions/component-groups/examples/CullingInfo/CullingInfoExample.tsx renamed to packages/module/patternfly-docs/content/extensions/component-groups/examples/StaleDataWarning/StaleDataWarningExample.tsx

@@ -7,7 +7,7 @@ import { createUseStyles } from 'react-jss';
 type Render = (config: { msg: string }) => React.ReactElement<any, any> | null;
 type CullingDate = string | number | Date;
 
-interface CullingInfo {
+interface StaleDataInfo {
   isWarn?: boolean;
   isError?: boolean;
   msg: string;
@@ -18,7 +18,7 @@ const minutes: number = seconds * 60;
 const hours: number = minutes * 60;
 const days: number = hours * 24;
 
-type CalculateTooltip = (culled: CullingDate, warning: CullingDate, currDate: CullingDate) => CullingInfo;
+type CalculateTooltip = (culled: CullingDate, warning: CullingDate, currDate: CullingDate) => StaleDataInfo;
 
 const useStyles = createUseStyles({
   inventoryCullingWarning: {
@@ -36,7 +36,7 @@ const useStyles = createUseStyles({
 });
 
 /** extends TooltipProps */
-export interface CullingInformation extends Omit<TooltipProps, 'content'> {
+export interface StaleDataWarningProps extends Omit<TooltipProps, 'content'> {
   /** Option to add custom css classes */
   className?: string;
   /** Warning date for when object becomes stale */
@@ -57,7 +57,7 @@ export interface CullingInformation extends Omit<TooltipProps, 'content'> {
   "aria-label"?: string;
 }
 
-const CullingInformation: React.FunctionComponent<CullingInformation> = ({
+const StaleDataWarning: React.FunctionComponent<StaleDataWarningProps> = ({
   culled = new Date(0),
   className,
   staleWarning = new Date(0),
@@ -98,7 +98,7 @@ const CullingInformation: React.FunctionComponent<CullingInformation> = ({
       : children || null;
   }
 
-  const { isWarn, isError, msg }: CullingInfo = calculateTooltip(culled, staleWarning, currDate);
+  const { isWarn, isError, msg }: StaleDataInfo = calculateTooltip(culled, staleWarning, currDate);
   if (render) {
     return (
       <span
@@ -119,12 +119,12 @@ const CullingInformation: React.FunctionComponent<CullingInformation> = ({
 
   return (
     <>
-        {isError && <Tooltip {...props} content={<div>{msg}</div>}><Button variant="plain" icon={<Icon status="warning"><ExclamationTriangleIcon/></Icon>} aria-label={ariaLabel || "Warning"} /></Tooltip>}
-        {isWarn && <Tooltip {...props} content={<div>{msg}</div>}><Button variant="plain" icon={<Icon status="danger"><ExclamationCircleIcon/></Icon>} aria-label={ariaLabel || "Danger"} /></Tooltip>}
-        {children}
+      {isError && <Tooltip {...props} content={<div>{msg}</div>}><Button variant="plain" icon={<Icon status="warning"><ExclamationTriangleIcon/></Icon>} aria-label={ariaLabel || "Warning"} /></Tooltip>}
+      {isWarn && <Tooltip {...props} content={<div>{msg}</div>}><Button variant="plain" icon={<Icon status="danger"><ExclamationCircleIcon/></Icon>} aria-label={ariaLabel || "Danger"} /></Tooltip>}
+      {children}
     </>
   );
 };
 
-export default CullingInformation;
+export default StaleDataWarning;
 

packages/module/src/CullingInfo/index.ts

@@ -0,0 +1,2 @@
+export { default } from './StaleDataWarning';
+export * from './StaleDataWarning';

packages/module/src/CullingInfo/CullingInfo.tsx renamed to packages/module/src/StaleDataWarning/StaleDataWarning.tsx

@@ -12,6 +12,9 @@ export * from './UnauthorizedAccess';
 export { default as TagCount } from './TagCount';
 export * from './TagCount';
 
+export { default as StaleDataWarning } from './StaleDataWarning';
+export * from './StaleDataWarning';
+
 export { default as SkeletonTableHead } from './SkeletonTableHead';
 export * from './SkeletonTableHead';
 
@@ -66,9 +69,6 @@ export * from './ErrorStack';
 export { default as ErrorBoundary } from './ErrorBoundary';
 export * from './ErrorBoundary';
 
-export { default as CullingInfo } from './CullingInfo';
-export * from './CullingInfo';
-
 export { default as ColumnManagementModal } from './ColumnManagementModal';
 export * from './ColumnManagementModal';