forked from CopilotKit/CopilotKit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCopilotSidebarView.tsx
More file actions
269 lines (239 loc) · 7.86 KB
/
Copy pathCopilotSidebarView.tsx
File metadata and controls
269 lines (239 loc) · 7.86 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
import React, { useEffect, useLayoutEffect, useRef, useState } from "react";
import CopilotChatView, {
CopilotChatViewProps,
WelcomeScreenProps,
} from "./CopilotChatView";
import {
CopilotChatConfigurationProvider,
useCopilotChatConfiguration,
} from "../../providers/CopilotChatConfigurationProvider";
import CopilotChatToggleButton from "./CopilotChatToggleButton";
import { cn } from "../../lib/utils";
import { CopilotModalHeader } from "./CopilotModalHeader";
import { renderSlot, SlotValue } from "../../lib/slots";
const DEFAULT_SIDEBAR_WIDTH = 480;
const SIDEBAR_TRANSITION_MS = 260;
export type CopilotSidebarViewProps = CopilotChatViewProps & {
header?: SlotValue<typeof CopilotModalHeader>;
toggleButton?: SlotValue<typeof CopilotChatToggleButton>;
width?: number | string;
defaultOpen?: boolean;
position?: "left" | "right";
};
export function CopilotSidebarView({
header,
toggleButton,
width,
defaultOpen = true,
position = "right",
...props
}: CopilotSidebarViewProps) {
return (
<CopilotChatConfigurationProvider isModalDefaultOpen={defaultOpen}>
<CopilotSidebarViewInternal
header={header}
toggleButton={toggleButton}
width={width}
position={position}
{...props}
/>
</CopilotChatConfigurationProvider>
);
}
function CopilotSidebarViewInternal({
header,
toggleButton,
width,
position = "right",
...props
}: Omit<CopilotSidebarViewProps, "defaultOpen">) {
const configuration = useCopilotChatConfiguration();
const isSidebarOpen = configuration?.isModalOpen ?? false;
const sidebarRef = useRef<HTMLDivElement | null>(null);
const [sidebarWidth, setSidebarWidth] = useState<number | string>(
width ?? DEFAULT_SIDEBAR_WIDTH,
);
// Helper to convert width to CSS value
const widthToCss = (w: number | string): string => {
return typeof w === "number" ? `${w}px` : w;
};
// Helper to extract numeric value for body margin (only works with px values)
const widthToMargin = (w: number | string): string => {
if (typeof w === "number") {
return `${w}px`;
}
// For string values, use as-is (assumes valid CSS unit)
return w;
};
useEffect(() => {
// If width is explicitly provided, don't measure
if (width !== undefined) {
return;
}
if (typeof window === "undefined") {
return;
}
const element = sidebarRef.current;
if (!element) {
return;
}
const updateWidth = () => {
const rect = element.getBoundingClientRect();
if (rect.width > 0) {
setSidebarWidth(rect.width);
}
};
updateWidth();
if (typeof ResizeObserver !== "undefined") {
const observer = new ResizeObserver(() => updateWidth());
observer.observe(element);
return () => observer.disconnect();
}
window.addEventListener("resize", updateWidth);
return () => window.removeEventListener("resize", updateWidth);
}, [width]);
// Manage body margin for sidebar docking (desktop only).
// useLayoutEffect runs before paint, so defaultOpen={true} never causes a
// visible layout shift — the margin is already applied on the first frame.
const hasMounted = useRef(false);
useLayoutEffect(() => {
if (
typeof window === "undefined" ||
typeof window.matchMedia !== "function"
)
return;
if (!window.matchMedia("(min-width: 768px)").matches) return;
const marginStyleProp =
position === "left" ? "marginInlineStart" : "marginInlineEnd";
const transitionCssProp =
position === "left" ? "margin-inline-start" : "margin-inline-end";
if (isSidebarOpen) {
if (hasMounted.current) {
document.body.style.transition = `${transitionCssProp} ${SIDEBAR_TRANSITION_MS}ms ease`;
}
document.body.style[marginStyleProp] = widthToMargin(sidebarWidth);
} else if (hasMounted.current) {
document.body.style.transition = `${transitionCssProp} ${SIDEBAR_TRANSITION_MS}ms ease`;
document.body.style[marginStyleProp] = "";
}
hasMounted.current = true;
return () => {
document.body.style[marginStyleProp] = "";
document.body.style.transition = "";
};
}, [isSidebarOpen, sidebarWidth, position]);
const headerElement = renderSlot(header, CopilotModalHeader, {});
const toggleButtonElement = renderSlot(
toggleButton,
CopilotChatToggleButton,
position === "left" ? { className: "cpk:left-6 cpk:right-auto" } : {},
);
return (
<>
{toggleButtonElement}
<aside
ref={sidebarRef}
data-copilotkit
data-testid="copilot-sidebar"
data-copilot-sidebar
data-position={position}
className={cn(
"copilotKitSidebar copilotKitWindow",
"cpk:fixed cpk:top-0 cpk:z-[1200] cpk:flex",
position === "left" ? "cpk:left-0" : "cpk:right-0",
// Height with dvh fallback and safe area support
"cpk:h-[100vh] cpk:h-[100dvh] cpk:max-h-screen",
// Responsive width: full on mobile, custom on desktop
"cpk:w-full",
position === "left" ? "cpk:border-r" : "cpk:border-l",
"cpk:border-border cpk:bg-background cpk:text-foreground cpk:shadow-xl",
"cpk:transition-transform cpk:duration-300 cpk:ease-out",
isSidebarOpen
? "cpk:translate-x-0"
: position === "left"
? "cpk:-translate-x-full cpk:pointer-events-none"
: "cpk:translate-x-full cpk:pointer-events-none",
)}
style={
{
// Use CSS custom property for responsive width
["--sidebar-width" as string]: widthToCss(sidebarWidth),
// Safe area insets for iOS
paddingTop: "env(safe-area-inset-top)",
paddingBottom: "env(safe-area-inset-bottom)",
} as React.CSSProperties
}
aria-hidden={!isSidebarOpen}
aria-label="Copilot chat sidebar"
role="complementary"
>
<div className="cpk:flex cpk:h-full cpk:w-full cpk:flex-col cpk:overflow-hidden">
{headerElement}
<div className="cpk:flex-1 cpk:overflow-hidden" data-sidebar-chat>
<CopilotChatView {...props} />
</div>
</div>
</aside>
</>
);
}
CopilotSidebarView.displayName = "CopilotSidebarView";
// eslint-disable-next-line @typescript-eslint/no-namespace
export namespace CopilotSidebarView {
/**
* Sidebar-specific welcome screen layout:
* - Suggestions at the top
* - Welcome message in the middle
* - Input fixed at the bottom (like normal chat)
*/
export const WelcomeScreen: React.FC<WelcomeScreenProps> = ({
welcomeMessage,
input,
suggestionView,
className,
children,
...props
}) => {
// Render the welcomeMessage slot internally
const BoundWelcomeMessage = renderSlot(
welcomeMessage,
CopilotChatView.WelcomeMessage,
{},
);
if (children) {
return (
<div data-copilotkit style={{ display: "contents" }}>
{children({
welcomeMessage: BoundWelcomeMessage,
input,
suggestionView,
className,
...props,
})}
</div>
);
}
return (
<div
className={cn("cpk:h-full cpk:flex cpk:flex-col", className)}
{...props}
>
{/* Welcome message - centered vertically */}
<div className="cpk:flex-1 cpk:flex cpk:flex-col cpk:items-center cpk:justify-center cpk:px-4">
{BoundWelcomeMessage}
</div>
{/* Suggestions and input at bottom */}
<div className="cpk:px-8 cpk:pb-4">
<div className="cpk:max-w-3xl cpk:mx-auto">
{/* Suggestions above input */}
<div className="cpk:mb-4 cpk:flex cpk:justify-center">
{suggestionView}
</div>
{input}
</div>
</div>
</div>
);
};
}
export default CopilotSidebarView;