@patternfly/chatbot 2.2.1 → 6.3.0-prerelease.10

package/src/ChatbotModal/ChatbotModal.test.tsx

@@ -0,0 +1,59 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import ChatbotModal from './ChatbotModal';
+import '@testing-library/jest-dom';
+import { ModalBody, ModalHeader } from '@patternfly/react-core';
+
+describe('ChatbotModal', () => {
+  it('should render compact modal', () => {
+    render(
+      <ChatbotModal data-testid="modal" isCompact isOpen>
+        <ModalHeader
+          title="Modal with description"
+          labelId="modal-with-description-title"
+          description="A description is used when you want to provide more info about the modal than the title is able to describe. The content in the description is static and will not scroll with the rest of the modal body."
+        />
+        <ModalBody tabIndex={0} id="modal-box-body-with-description">
+          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+          magna aliqua. Quis eleifend quam adipiscing vitae proin sagittis nisl rhoncus. Semper auctor neque vitae
+          tempus. Diam donec adipiscing tristique risus. Augue eget arcu dictum varius duis. Ut enim blandit volutpat
+          maecenas volutpat blandit aliquam. Sit amet mauris commodo quis imperdiet massa tincidunt. Habitant morbi
+          tristique senectus et netus. Fames ac turpis egestas sed tempus urna. Neque laoreet suspendisse interdum
+          consectetur libero id. Volutpat lacus laoreet non curabitur gravida arcu ac tortor. Porta nibh venenatis cras
+          sed felis eget velit. Nullam non nisi est sit amet facilisis. Nunc mi ipsum faucibus vitae. Lorem sed risus
+          ultricies tristique nulla aliquet enim tortor at. Egestas sed tempus urna et pharetra pharetra massa massa
+          ultricies. Lacinia quis vel eros donec ac odio tempor orci. Malesuada fames ac turpis egestas integer eget
+          aliquet.
+          <br />
+          <br />
+          Neque aliquam vestibulum morbi blandit cursus risus at ultrices. Molestie at elementum eu facilisis sed odio
+          morbi. Elit pellentesque habitant morbi tristique. Consequat nisl vel pretium lectus quam id leo in vitae.
+          Quis varius quam quisque id diam vel quam elementum. Viverra nam libero justo laoreet sit amet cursus.
+          Sollicitudin tempor id eu nisl nunc. Orci nulla pellentesque dignissim enim sit amet venenatis. Dignissim enim
+          sit amet venenatis urna cursus eget. Iaculis at erat pellentesque adipiscing commodo elit. Faucibus pulvinar
+          elementum integer enim neque volutpat. Nullam vehicula ipsum a arcu cursus vitae congue mauris. Nunc mattis
+          enim ut tellus elementum sagittis vitae. Blandit cursus risus at ultrices. Tellus mauris a diam maecenas sed
+          enim. Non diam phasellus vestibulum lorem sed risus ultricies tristique nulla.
+          <br />
+          <br />
+          Nulla pharetra diam sit amet nisl suscipit adipiscing. Ac tortor vitae purus faucibus ornare suspendisse sed
+          nisi. Sed felis eget velit aliquet sagittis id consectetur purus. Tincidunt tortor aliquam nulla facilisi cras
+          fermentum. Volutpat est velit egestas dui id ornare arcu odio. Pharetra magna ac placerat vestibulum. Ultrices
+          sagittis orci a scelerisque purus semper eget duis at. Nisi est sit amet facilisis magna etiam tempor orci eu.
+          Convallis tellus id interdum velit. Facilisis sed odio morbi quis commodo odio aenean sed.
+          <br />
+          <br />
+          Eu scelerisque felis imperdiet proin fermentum leo vel orci porta. Facilisi etiam dignissim diam quis enim
+          lobortis scelerisque fermentum. Eleifend donec pretium vulputate sapien nec sagittis aliquam malesuada. Magna
+          etiam tempor orci eu lobortis elementum. Quis auctor elit sed vulputate mi sit. Eleifend quam adipiscing vitae
+          proin sagittis nisl rhoncus mattis rhoncus. Erat velit scelerisque in dictum non. Sit amet nulla facilisi
+          morbi tempus iaculis urna. Enim ut tellus elementum sagittis vitae et leo duis ut. Lectus arcu bibendum at
+          varius vel pharetra vel turpis. Morbi tristique senectus et netus et. Eget aliquet nibh praesent tristique
+          magna sit amet purus gravida. Nisl purus in mollis nunc sed id semper risus. Id neque aliquam vestibulum
+          morbi. Mauris a diam maecenas sed enim ut sem. Egestas tellus rutrum tellus pellentesque.
+        </ModalBody>
+      </ChatbotModal>
+    );
+    expect(screen.getByTestId('modal')).toHaveClass('pf-m-compact');
+  });
+});

package/src/ChatbotModal/ChatbotModal.tsx

@@ -10,7 +10,10 @@ import { ChatbotDisplayMode } from '../Chatbot';
 export interface ChatbotModalProps extends Omit<ModalProps, 'ref'> {
   /** Display mode for the Chatbot parent; this influences the styles applied */
   displayMode?: ChatbotDisplayMode;
+  /** Additional className applied to modal */
   className?: string;
+  /** Sets modal to compact styling. */
+  isCompact?: boolean;
 }
 
 export const ChatbotModal: React.FunctionComponent<ChatbotModalProps> = ({
@@ -18,6 +21,7 @@ export const ChatbotModal: React.FunctionComponent<ChatbotModalProps> = ({
   displayMode = ChatbotDisplayMode.default,
   className,
   isOpen,
+  isCompact,
   ...props
 }: ChatbotModalProps) => {
   const modal = (
@@ -26,7 +30,7 @@ export const ChatbotModal: React.FunctionComponent<ChatbotModalProps> = ({
       ouiaId="ChatbotModal"
       aria-labelledby="chatbot-modal-title"
       aria-describedby="chatbot-modal"
-      className={`pf-chatbot__chatbot-modal pf-chatbot__chatbot-modal--${displayMode} ${className}`}
+      className={`pf-chatbot__chatbot-modal pf-chatbot__chatbot-modal--${displayMode} ${isCompact ? 'pf-m-compact' : ''} ${className}`}
       backdropClassName="pf-chatbot__chatbot-modal-backdrop"
       {...props}
     >

package/src/ChatbotPopover/ChatbotPopover.scss

@@ -2,14 +2,19 @@
 // Chatbot Popover
 // ============================================================================
 .pf-chatbot__popover {
-  .pf-v6-c-popover__arrow { display: none; }
+  .pf-v6-c-popover__arrow {
+    display: none;
+  }
 
   // Footnote popover
   &--footnote.pf-chatbot__popover {
-
     // Contents
-    img { border-radius: var(--pf-t--global--border--radius--small); }
-    .pf-v6-c-content--h3 { font-weight: var(--pf-t--global--font--weight--body--bold); }
+    img {
+      border-radius: var(--pf-t--global--border--radius--small);
+    }
+    .pf-v6-c-content--h3 {
+      font-weight: var(--pf-t--global--font--weight--body--bold);
+    }
     .pf-v6-c-content--p {
       font-size: var(--pf-t--global--font--size--body--lg);
     }
@@ -23,5 +28,4 @@
       font-size: var(--pf-t--global--font--size--body--lg);
     }
   }
-
 }

package/src/ChatbotPopover/ChatbotPopover.tsx

@@ -7,7 +7,7 @@ import React from 'react';
 import { Popover, PopoverProps } from '@patternfly/react-core';
 
 export const ChatbotPopover: React.FunctionComponent<PopoverProps> = ({ children, className, ...props }) => (
-  <Popover className={`pf-chatbot__popover ${className ?? ''}`} showClose={false} {...props}>
+  <Popover className={`pf-chatbot__popover  ${className ?? ''}`} showClose={false} {...props}>
     {children}
   </Popover>
 );

package/src/ChatbotWelcomePrompt/ChatbotWelcomePrompt.scss

@@ -8,7 +8,6 @@
   gap: var(--pf-t--global--spacer--lg);
 
   .pf-v6-c-content--h1 {
-    --pf-v6-c-content--h1--FontSize: var(--pf-t--global--font--size--3xl); // larger than any of our semantic tokens
     --pf-v6-c-content--h1--FontWeight: var(--pf-t--global--font--weight--400);
     --pf-v6-c-content--h1--MarginBlockEnd: 0;
   }
@@ -34,6 +33,15 @@
   }
 }
 
+.pf-chatbot--layout--welcome.pf-m-compact {
+  gap: var(--pf-t--global--spacer--md);
+  padding-block-end: var(--pf-t--global--spacer--md);
+
+  .pf-chatbot__prompt-suggestions {
+    gap: var(--pf-t--global--spacer--md);
+  }
+}
+
 // ============================================================================
 // Chatbot Display Mode - Fullscreen and Embedded
 // ============================================================================

package/src/ChatbotWelcomePrompt/ChatbotWelcomePrompt.test.tsx

@@ -69,4 +69,17 @@ describe('ChatbotWelcomePrompt', () => {
     const element = screen.getByTestId('welcome-prompt');
     expect(element).toHaveClass('test');
   });
+
+  it('should handle isCompact', () => {
+    render(
+      <ChatbotWelcomePrompt
+        title="Hi, ChatBot User!"
+        description="How can I help you today?"
+        className="test"
+        testId="welcome-prompt"
+        isCompact
+      />
+    );
+    expect(screen.getByTestId('welcome-prompt')).toHaveClass('pf-m-compact');
+  });
 });

package/src/ChatbotWelcomePrompt/ChatbotWelcomePrompt.tsx

@@ -16,6 +16,7 @@ export interface ChatbotWelcomePromptProps extends React.HTMLProps<HTMLDivElemen
   className?: string;
   /** Custom test id for the WelcomePrompt component */
   testId?: string;
+  isCompact?: boolean;
 }
 
 export interface WelcomePrompt {
@@ -33,9 +34,14 @@ export const ChatbotWelcomePrompt: React.FunctionComponent<ChatbotWelcomePromptP
   prompts,
   className,
   testId,
+  isCompact = false,
   ...props
 }: ChatbotWelcomePromptProps) => (
-  <div data-testid={testId} className={`pf-chatbot--layout--welcome ${className ?? ''}`} {...props}>
+  <div
+    data-testid={testId}
+    className={`pf-chatbot--layout--welcome ${isCompact ? 'pf-m-compact' : ''} ${className ?? ''}`}
+    {...props}
+  >
     <Content component={ContentVariants.h1}>
       <span className="pf-chatbot__hello">{title}</span>
       <br />
@@ -45,7 +51,12 @@ export const ChatbotWelcomePrompt: React.FunctionComponent<ChatbotWelcomePromptP
     {prompts && (
       <div className="pf-chatbot__prompt-suggestions">
         {prompts?.map((prompt, index) => (
-          <Card key={`welcome-prompt-${index}`} className="pf-chatbot__prompt-suggestion" isClickable>
+          <Card
+            key={`welcome-prompt-${index}`}
+            className="pf-chatbot__prompt-suggestion"
+            isClickable
+            isCompact={isCompact}
+          >
             <CardHeader
               selectableActions={{
                 onClickAction: prompt.onClick,

package/src/ChatbotWelcomePrompt/__snapshots__/ChatbotWelcomePrompt.test.tsx.snap

@@ -3,7 +3,7 @@
 exports[`ChatbotWelcomePrompt should render welcome prompt 1`] = `
 <div>
   <div
-    class="pf-chatbot--layout--welcome "
+    class="pf-chatbot--layout--welcome  "
   >
     <h1
       class="pf-v6-c-content--h1"

package/src/CodeModal/CodeModal.scss

@@ -61,8 +61,10 @@
   .pf-v6-c-code-editor__header-main {
     display: none;
   }
-  .pf-chatbot__code-modal-file-details {
-    padding-inline-start: var(--pf-t--global--spacer--md);
+  .pf-v6-c-modal-box__close {
+    .pf-v6-c-button.pf-m-plain {
+      --pf-v6-c-button__icon--Color: var(--pf-t--global--icon--color--subtle);
+    }
   }
 }
 
@@ -78,10 +80,16 @@
   }
 }
 
-.pf-chatbot__code-modal-body {
+.pf-chatbot__code-modal-editor {
   flex: 1;
 }
 
 .pf-chatbot__code-modal--fullscreen {
   height: inherit !important; // override shared modal so code editor works in full screen
 }
+
+.pf-chatbot__code-modal.pf-m-compact {
+  .pf-chatbot__code-modal-body {
+    gap: var(--pf-t--global--spacer--md);
+  }
+}

package/src/CodeModal/CodeModal.test.tsx

@@ -0,0 +1,24 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import CodeModal from './CodeModal';
+
+describe('ChatbotModal', () => {
+  it('should render compact modal', () => {
+    render(
+      <CodeModal
+        isCompact
+        code="Hello world"
+        fileName="greetings.txt"
+        isModalOpen={true}
+        handleModalToggle={jest.fn()}
+        onPrimaryAction={jest.fn()}
+        onSecondaryAction={jest.fn()}
+        title="Preview attachment"
+        primaryActionBtn="Submit"
+        secondaryActionBtn="Cancel"
+      ></CodeModal>
+    );
+    expect(screen.getByRole('dialog')).toHaveClass('pf-m-compact');
+  });
+});

package/src/CodeModal/CodeModal.tsx

@@ -40,6 +40,8 @@ export interface CodeModalProps {
   title: string;
   /** Display mode for the Chatbot parent; this influences the styles applied */
   displayMode?: ChatbotDisplayMode;
+  /** Sets modal to compact styling. */
+  isCompact?: boolean;
 }
 
 export const CodeModal: React.FunctionComponent<CodeModalProps> = ({
@@ -57,6 +59,7 @@ export const CodeModal: React.FunctionComponent<CodeModalProps> = ({
   secondaryActionBtn,
   title,
   displayMode = ChatbotDisplayMode.default,
+  isCompact,
   ...props
 }: CodeModalProps) => {
   const [newCode, setNewCode] = React.useState(code);
@@ -94,8 +97,9 @@ export const CodeModal: React.FunctionComponent<CodeModalProps> = ({
       ouiaId="CodeModal"
       aria-labelledby="code-modal-title"
       aria-describedby="code-modal"
-      className={`pf-chatbot__code-modal pf-chatbot__code-modal--${displayMode}`}
+      className={`pf-chatbot__code-modal ${isCompact ? 'pf-m-compact' : ''} pf-chatbot__code-modal--${displayMode}`}
       displayMode={displayMode}
+      isCompact={isCompact}
     >
       <ModalHeader title={title} labelId="code-modal-title" />
       <ModalBody id="code-modal-body">
@@ -103,7 +107,7 @@ export const CodeModal: React.FunctionComponent<CodeModalProps> = ({
           <StackItem className="pf-chatbot__code-modal-file-details">
             <FileDetails fileName={fileName} />
           </StackItem>
-          <StackItem className="pf-chatbot__code-modal-body">
+          <StackItem className="pf-chatbot__code-modal-editor">
             <CodeEditor
               isDarkTheme
               isLineNumbersVisible={isLineNumbersVisible}

package/src/FileDetails/FileDetails.tsx

@@ -946,7 +946,7 @@ export const FileDetails = ({
 }: PropsWithChildren<FileDetailsProps>) => {
   const language = extensionToLanguage[path.extname(fileName).slice(1)]?.toUpperCase();
   return (
-    <Flex className={`pf-chatbot__file-details ${className}`} gap={{ default: 'gapSm' }}>
+    <Flex className={`pf-chatbot__file-details ${className ? className : ''}`} gap={{ default: 'gapSm' }}>
       <Flex
         className="pf-chatbot__code-icon"
         justifyContent={{ default: 'justifyContentCenter' }}

package/src/FileDetails/__snapshots__/FileDetails.test.tsx.snap

@@ -3,7 +3,7 @@
 exports[`FileDetails should render file details 1`] = `
 <div>
   <div
-    class="pf-v6-l-flex pf-m-gap-sm pf-chatbot__file-details undefined"
+    class="pf-v6-l-flex pf-m-gap-sm pf-chatbot__file-details "
   >
     <div
       class="pf-v6-l-flex pf-m-align-items-center pf-m-align-self-center pf-m-justify-content-center pf-chatbot__code-icon"

package/src/FileDetailsLabel/__snapshots__/FileDetailsLabel.test.tsx.snap

@@ -15,7 +15,7 @@ exports[`FileDetailsLabel should render file details label 1`] = `
           class="pf-chatbot__file-label-contents"
         >
           <div
-            class="pf-v6-l-flex pf-m-gap-sm pf-chatbot__file-details undefined"
+            class="pf-v6-l-flex pf-m-gap-sm pf-chatbot__file-details "
           >
             <div
               class="pf-v6-l-flex pf-m-align-items-center pf-m-align-self-center pf-m-justify-content-center pf-chatbot__code-icon"

package/src/Message/Message.scss

@@ -97,6 +97,37 @@
   flex-wrap: wrap;
 }
 
+.pf-chatbot__message-edit-buttons {
+  --pf-v6-c-form__group--m-action--MarginBlockStart: 0;
+}
+
 @import './MessageLoading';
 @import './CodeBlockMessage/CodeBlockMessage';
 @import './TextMessage/TextMessage';
+
+// ============================================================================
+// Information density styles
+// ============================================================================
+.pf-chatbot.pf-m-compact {
+  .pf-chatbot__message {
+    gap: var(--pf-t--global--spacer--md);
+    padding-bottom: var(--pf-t--global--spacer--sm);
+
+    .pf-chatbot__message-contents  {
+      gap: var(--pf-t--global--spacer--xs);
+    }
+  }
+
+  .pf-chatbot__message-name {
+    font-size: var(--pf-t--global--font--size--xs);
+  }
+
+  .pf-chatbot__message-avatar.pf-chatbot__message-avatar--round.pf-v6-c-avatar {
+    --pf-v6-c-avatar--Width: 2rem;
+    --pf-v6-c-avatar--Height: 2rem;
+  }
+
+  .pf-chatbot__message-contents {
+    gap: var(--pf-t--global--spacer--xs);
+  }
+}

package/src/Message/Message.test.tsx

@@ -334,6 +334,27 @@ describe('Message', () => {
     await userEvent.click(quickResponse);
     expect(spy).toHaveBeenCalledTimes(1);
   });
+  it('should be able to handle isCompact', async () => {
+    render(
+      <Message
+        avatar="./img"
+        role="bot"
+        name="Bot"
+        content="Hi"
+        quickResponses={[
+          {
+            id: '1',
+            content: 'Yes',
+            onClick: jest.fn(),
+            className: 'test'
+          }
+        ]}
+        isCompact
+      />
+    );
+    const parent = screen.getByRole('button', { name: /Yes/i }).parentNode;
+    expect(parent).toHaveClass('pf-m-compact');
+  });
   it('should be able to show more than 1 quick response', async () => {
     const spy = jest.fn();
     render(
@@ -784,6 +805,20 @@ describe('Message', () => {
     // we are mocking rehype libraries, so we can't test target _blank addition on links directly with RTL
     expect(rehypeExternalLinks).not.toHaveBeenCalled();
   });
+  it('should handle extra link props correctly', async () => {
+    const spy = jest.fn();
+    render(
+      <Message
+        avatar="./img"
+        role="user"
+        name="User"
+        content={`[PatternFly](https://www.patternfly.org/)`}
+        linkProps={{ onClick: spy }}
+      />
+    );
+    await userEvent.click(screen.getByRole('link', { name: /PatternFly/i }));
+    expect(spy).toHaveBeenCalledTimes(1);
+  });
   it('should handle error correctly', () => {
     render(<Message avatar="./img" role="user" name="User" error={ERROR} />);
     expect(screen.getByRole('heading', { name: /Could not load chat/i })).toBeTruthy();
@@ -801,4 +836,52 @@ describe('Message', () => {
     expect(screen.getByRole('heading', { name: /Could not load chat/i })).toBeTruthy();
     expect(screen.queryByText('Test')).toBeFalsy();
   });
+  it('should handle isEditable when there is message content', () => {
+    render(<Message avatar="./img" role="user" name="User" isEditable content="Test" />);
+    expect(screen.getByRole('textbox')).toBeTruthy();
+    expect(screen.getByRole('textbox')).toHaveValue('Test');
+    expect(screen.getByRole('button', { name: /Update/i })).toBeTruthy();
+    expect(screen.getByRole('button', { name: /Cancel/i })).toBeTruthy();
+  });
+  it('should handle isEditable when there is no message content', () => {
+    render(<Message avatar="./img" role="user" name="User" isEditable />);
+    expect(screen.getByRole('textbox')).toBeTruthy();
+    expect(screen.getByRole('textbox')).toHaveValue('');
+    expect(screen.getByRole('textbox')).toHaveAttribute('placeholder', 'Edit prompt message...');
+    expect(screen.getByRole('button', { name: /Update/i })).toBeTruthy();
+    expect(screen.getByRole('button', { name: /Cancel/i })).toBeTruthy();
+  });
+  it('should be able to change edit placeholder', () => {
+    render(<Message avatar="./img" role="user" name="User" isEditable editPlaceholder="I am a placeholder" />);
+    expect(screen.getByRole('textbox')).toBeTruthy();
+    expect(screen.getByRole('textbox')).toHaveValue('');
+    expect(screen.getByRole('textbox')).toHaveAttribute('placeholder', 'I am a placeholder');
+  });
+  it('should be able to change updateWord', () => {
+    render(<Message avatar="./img" role="user" name="User" isEditable updateWord="Submit" />);
+    expect(screen.getByRole('button', { name: /Submit/i })).toBeTruthy();
+  });
+  it('should be able to change cancelWord', () => {
+    render(<Message avatar="./img" role="user" name="User" isEditable cancelWord="Don't submit" />);
+    expect(screen.getByRole('button', { name: /Don't submit/i })).toBeTruthy();
+  });
+  it('should be able to add onEditUpdate', async () => {
+    const spy = jest.fn();
+    render(<Message avatar="./img" role="user" name="User" isEditable onEditUpdate={spy} />);
+    await userEvent.click(screen.getByRole('button', { name: /Update/i }));
+    expect(spy).toHaveBeenCalledTimes(1);
+  });
+  it('should be able to add onEditCancel', async () => {
+    const spy = jest.fn();
+    render(<Message avatar="./img" role="user" name="User" isEditable onEditCancel={spy} />);
+    await userEvent.click(screen.getByRole('button', { name: /Cancel/i }));
+    expect(spy).toHaveBeenCalledTimes(1);
+  });
+  it('should be able to add  editFormProps', () => {
+    const { container } = render(
+      <Message avatar="./img" role="user" name="User" isEditable editFormProps={{ className: 'test' }} />
+    );
+    const form = container.querySelector('form');
+    expect(form).toHaveClass('test');
+  });
 });