|
| 1 | +--- |
| 2 | +id: Overview |
| 3 | +title: ChatBot overview |
| 4 | +section: extensions |
| 5 | +subsection: ChatBot |
| 6 | +sortValue: 1 |
| 7 | +source: ChatBot |
| 8 | +--- |
| 9 | + |
| 10 | +**Note:** The PatternFly ChatBot extension lives in its own package [`@patternfly/chatbot`](https://www.npmjs.com/package/@patternfly/chatbot). |
| 11 | + |
| 12 | +The PatternFly **ChatBot** extension contains a React implementation of an AI-focused chatbot, providing users with access to convenient and persistent help. This extension is intended to remain in alignment with our [AI principles and design guidelines](/ai/overview). |
| 13 | + |
| 14 | +*Only use this ChatBot when it adds value to your users' experiences.* Don't use it simply for the sake of novelty—it must directly help users reach their goals. |
| 15 | + |
| 16 | +--- |
| 17 | + |
| 18 | +## How do I use ChatBot? |
| 19 | + |
| 20 | +To get started: |
| 21 | +1. Install the `@patternfly/chatbot` package by following [the README instructions](https://github.com/patternfly/chatbot). |
| 22 | +2. To use a ChatBot component in your project, import the ChatBot and the component you need. For example: `import ChatbotWelcomePrompt from '@patternfly/chatbot/dist/dynamic/ChatbotWelcomePrompt';` |
| 23 | +3. To build out and customize your ChatBot experience, refer to our extensive documentation on PatternFly.org. |
| 24 | + |
| 25 | +## What does a built-out ChatBot look like? |
| 26 | + |
| 27 | +To illustrate holistic ChatBot solutions, we offer these interactive demos: |
| 28 | +- [Basic ChatBot](/extensions/chatbot/overview/demo#basic-chatbot): A standard ChatBot that can swap between display modes. |
| 29 | +- [Compact ChatBot](/extensions/chatbot/overview/demo#compact-chatbot): A compact version of a standard ChatBot that allows for more information density. |
| 30 | +- [Embedded ChatBot](/extensions/chatbot/overview/demo#embedded-chatbot): A ChatBot experience that can be embedded into a page within an application. |
| 31 | +- [Inline drawer ChatBot](/extensions/chatbot/overview/demo#inline-drawer-chatbot): A ChatBot placed within a drawer that is inline with page content, rather than one that overlays the page. |
| 32 | + |
| 33 | +## How do I build a ChatBot for my product? |
| 34 | + |
| 35 | +To learn how to design ChatBot experiences, refer to [the design guidelines](/extensions/chatbot/overview/design-guidelines) and our [conversation design guidelines](/ai/conversation-design/). |
| 36 | + |
| 37 | +Explore our documentation, which covers both the components you'll need to build your ChatBot and the guidance to follow for different functionality: |
| 38 | +- UI: Structural, core components |
| 39 | + - [Structural elements](/extensions/chatbot/ui#structure) |
| 40 | + - [Toggle](/extensions/chatbot/ui#toggle) |
| 41 | + - [Header](/extensions/chatbot/ui#header) |
| 42 | + - [Footer](/extensions/chatbot/ui#footer) |
| 43 | + - [Navigation](/extensions/chatbot/ui#navigation) |
| 44 | + - [Modals](/extensions/chatbot/ui#modals) |
| 45 | +- Messages: Components that customize features related to the conversation |
| 46 | + - [Bot and user messages](/extensions/chatbot/messages) |
| 47 | + - [File attachments](/extensions/chatbot/messages#file-attachments) |
| 48 | +- Patterns: More opinionated implementation solutions for common use cases |
| 49 | + - [Primary color background](/extensions/chatbot/overview/demo#primary-color-background) |
| 50 | + - [Display mode switcher](/extensions/chatbot/overview/demo#display-mode-switcher) |
| 51 | + - [Chat transcripts](/extensions/chatbot/overview/demo#chat-transcripts) |
| 52 | +- [Analytics](/extensions/chatbot/analytics): Tracking for ChatBot interactions |
| 53 | +- [Customizing messages](/extensions/chatbot/customizing-messages): Details for the implementation of custom messages |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +We will continue to grow and evolve our ChatBot. If you notice a bug or have any suggestions, feel free to file an issue in our [GitHub repository!](https://github.com/patternfly/chatbot/issues) Make sure to check if there is already a pre-existing issue before creating a new one. |
0 commit comments