forked from CopilotKit/CopilotKit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPopup.tsx
More file actions
79 lines (77 loc) · 2.26 KB
/
Copy pathPopup.tsx
File metadata and controls
79 lines (77 loc) · 2.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
* <br/>
* <img src="https://cdn.copilotkit.ai/docs/copilotkit/images/CopilotPopup.gif" width="500" />
*
* A chatbot popup component for the CopilotKit framework. The component allows for a high degree
* of customization through various props and custom CSS.
*
* See [CopilotSidebar](/reference/v1/components/chat/CopilotSidebar) for a sidebar version of this component.
*
* ## Install Dependencies
*
* This component is part of the [@copilotkit/react-ui](https://npmjs.com/package/@copilotkit/react-ui) package.
*
* ```shell npm2yarn \"@copilotkit/react-ui"\
* npm install @copilotkit/react-core @copilotkit/react-ui
* ```
* ## Usage
*
* ```tsx
* import { CopilotPopup } from "@copilotkit/react-ui";
* import "@copilotkit/react-ui/styles.css";
*
* <CopilotPopup
* labels={{
* title: "Your Assistant",
* initial: "Hi! 👋 How can I assist you today?",
* }}
* />
* ```
*
* ### With Observability Hooks
*
* To monitor user interactions, provide the `observabilityHooks` prop.
* **Note:** This requires a `publicApiKey` in the `<CopilotKit>` provider.
*
* ```tsx
* <CopilotKit publicApiKey="YOUR_PUBLIC_API_KEY">
* <CopilotPopup
* observabilityHooks={{
* onChatExpanded: () => {
* console.log("Popup opened");
* },
* onChatMinimized: () => {
* console.log("Popup closed");
* },
* }}
* />
* </CopilotKit>
* ```
*
* ### Look & Feel
*
* By default, CopilotKit components do not have any styles. You can import CopilotKit's stylesheet at the root of your project:
* ```tsx title="YourRootComponent.tsx"
* ...
* import "@copilotkit/react-ui/styles.css"; // [!code highlight]
*
* export function YourRootComponent() {
* return (
* <CopilotKit>
* ...
* </CopilotKit>
* );
* }
* ```
* For more information about how to customize the styles, check out the [Customize Look & Feel](/guides/custom-look-and-feel/customize-built-in-ui-components) guide.
*/
import { CopilotModal, CopilotModalProps } from "./Modal";
export function CopilotPopup(props: CopilotModalProps) {
props = {
...props,
className: props.className
? props.className + " copilotKitPopup"
: "copilotKitPopup",
};
return <CopilotModal {...props}>{props.children}</CopilotModal>;
}