Skip to content

The Open Standard for Generative UI

Advanced customization docs (#104)

Hrijul Bhatnagar682e5fd34307
diff --git a/docs/docs/guides/customization/007-response-templates.mdx b/docs/docs/guides/customization/007-response-templates.mdx
index fbaafabe8..155670c3c 100644
--- a/docs/docs/guides/customization/007-response-templates.mdx
+++ b/docs/docs/guides/customization/007-response-templates.mdx
@@ -1,3 +1,7 @@
+---
+description: Creating and using response templates in Crayon
+---
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git a/docs/docs/guides/customization/008-connecting-to-backend.mdx b/docs/docs/guides/customization/008-connecting-to-backend.mdx
index 27110957f..588036118 100644
--- a/docs/docs/guides/customization/008-connecting-to-backend.mdx
+++ b/docs/docs/guides/customization/008-connecting-to-backend.mdx
@@ -1,3 +1,7 @@
+---
+description: Connecting your backend with Crayon to fetch and persist data
+---
+
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
diff --git a/docs/docs/guides/customization/009-customizing-ui.mdx b/docs/docs/guides/customization/009-customizing-ui.mdx
index 857acdd45..e8863a0aa 100644
--- a/docs/docs/guides/customization/009-customizing-ui.mdx
+++ b/docs/docs/guides/customization/009-customizing-ui.mdx
@@ -1,3 +1,7 @@
+---
+description: Using individual Crayon components and styling them
+---
+
# Customizing Crayon UI
For simple use cases, the `CrayonChat` component is sufficient and gives you a ready-to-use UI. However, for more complex use cases, you might want to customize the UI.
diff --git a/docs/docs/guides/customization/advanced-customization/001-integrating-custom-components.md b/docs/docs/guides/customization/advanced-customization/001-integrating-custom-components.md
new file mode 100644
index 000000000..8f504f098
--- /dev/null
+++ b/docs/docs/guides/customization/advanced-customization/001-integrating-custom-components.md
@@ -0,0 +1,339 @@
+---
+description: How to integrate with Crayon's state in your own components
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Integrating Custom Components
+
+In addition to customizing the existing components, you can also access and modify Crayon's state in your own custom components. This allows you
+to mix your components with Crayon's components, or build a fully customized UI according to your needs. This guide presents an example of how you can build a custom
+sidebar and a custom composer by integrating with Crayon's state management.
+
+![Advanced UI Customization Image](./assets/advanced-ui-customization.png)
+
+## Building a custom sidebar
+
+The sidebar generally contains a CTA to start a new conversation and a list of existing conversations with the agent. This means that you will need to read and modify the
+[`ThreadListState`](../../../reference/js/react-core/type-aliases/ThreadListState.md).
+
+Crayon provides an easy way to do this through the [`useThreadListState`](../../../reference/js/react-core/functions/useThreadListState.md) and
+[`useThreadListActions`](../../../reference/js/react-core/functions/useThreadListActions.md) hooks. The following code snippet demonstrates how you can create a custom sidebar
+by accessing and modifying this state. For the sake of simplicity, this example uses tailwindcss for styling.
+
+<Tabs groupId='frontend-lang'>
+
+<TabItem value="ts" label="TypeScript">
+
+```tsx
+import { useThreadListActions, useThreadListState } from "@crayonai/react-core";
+import { Button } from "@crayonai/react-ui";
+import { BrainCircuit, PlusIcon, TrashIcon } from "lucide-react";
+
+export const CustomSidebar = () => {
+ const { threads, selectedThreadId } = useThreadListState();
+ const { switchToNewThread, selectThread, deleteThread } =
+ useThreadListActions();
+
+ const newChatHandler = () => {
+ // Clear thread state and unselect the selected thread so that the user can start a new chat
+ switchToNewThread();
+ };
+
+ const deleteThreadHandler = (threadId: string) => {
+ deleteThread(threadId);
+ };
+
+ return (
+ <div className="w-[300px] h-full bg-opacity-5 filter bg-white rounded-2xl flex flex-col gap-8 p-4 text-gray-400">
+ {/* Agent logo and name */}
+ <div className="flex items-center gap-2">
+ <BrainCircuit />
+ <h1>Crayon AI</h1>
+ </div>
+
+ {/* New chat button */}
+ <Button
+ variant="primary"
+ onClick={newChatHandler}
+ iconRight={<PlusIcon />}
+ className="justify-between"
+ >
+ New chat
+ </Button>
+
+ {/* Conversations section */}
+ <section className="flex flex-col gap-2 flex-1">
+ {/* Section header */}
+ <div className="flex items-center flex-nowrap gap-2">
+ <p className="text-xs">Your conversations</p>
+ <div className="flex-1 border-y-[0.5px] border-gray-400" />
+ </div>
+
+ {/* Threads list container */}
+ <div className="flex flex-col gap-2 flex-1">
+ {threads.map((thread) => (
+ // Thread
+ <div
+ key={thread.threadId}
+ className={`px-2 py-1 filter hover:bg-white hover:bg-opacity-10 rounded-xl cursor-pointer flex items-center justify-between ${
+ selectedThreadId === thread.threadId
+ ? "bg-white/20 text-white"
+ : "text-gray-300 hover:text-white"
+ }`}
+ onClick={() => selectThread(thread.threadId)}
+ >
+ <p className="line-clamp-1 text-sm">{thread.title}</p>
+
+ {/* Delete thread button */}
+ <Button
+ variant="tertiary"
+ iconRight={<TrashIcon className="text-red-400" />}
+ size="small"
+ onClick={() => deleteThreadHandler(thread.threadId)}
+ />
+ </div>
+ ))}
+ </div>
+ </section>
+ </div>
+ );
+};
+```
+
+</TabItem>
+
+<TabItem value="js" label="JavaScript">
+
+```jsx
+import { useThreadListActions, useThreadListState } from "@crayonai/react-core";
+import { Button } from "@crayonai/react-ui";
+import { BrainCircuit, PlusIcon, TrashIcon } from "lucide-react";
+
+export const CustomSidebar = () => {
+ const { threads, selectedThreadId } = useThreadListState();
+ const { switchToNewThread, selectThread, deleteThread } =
+ useThreadListActions();
+
+ const newChatHandler = () => {
+ // Clear thread state and unselect the selected thread so that the user can start a new chat
+ switchToNewThread();
+ };
+
+ const deleteThreadHandler = (threadId) => {
+ deleteThread(threadId);
+ };
+
+ return (
+ <div className="w-[300px] h-full bg-opacity-5 filter bg-white rounded-2xl flex flex-col gap-8 p-4 text-gray-400">
+ {/* Agent logo and name */}
+ <div className="flex items-center gap-2">
+ <BrainCircuit />
+ <h1>Crayon AI</h1>
+ </div>
+
+ {/* New chat button */}
+ <Button
+ variant="primary"
+ onClick={newChatHandler}
+ iconRight={<PlusIcon />}
+ className="justify-between"
+ >
+ New chat
+ </Button>
+
+ {/* Conversations section */}
+ <section className="flex flex-col gap-2 flex-1">
+ {/* Section header */}
+ <div className="flex items-center flex-nowrap gap-2">
+ <p className="text-xs">Your conversations</p>
+ <div className="flex-1 border-y-[0.5px] border-gray-400" />
+ </div>
+
+ {/* Threads list container */}
+ <div className="flex flex-col gap-2 flex-1">
+ {threads.map((thread) => (
+ // Thread
+ <div
+ key={thread.threadId}
+ className={`px-2 py-1 filter hover:bg-white hover:bg-opacity-10 rounded-xl cursor-pointer flex items-center justify-between ${
+ selectedThreadId === thread.threadId
+ ? "bg-white/20 text-white"
+ : "text-gray-300 hover:text-white"
+ }`}
+ onClick={() => selectThread(thread.threadId)}
+ >
+ <p className="line-clamp-1 text-sm">{thread.title}</p>
+
+ {/* Delete thread button */}
+ <Button
+ variant="tertiary"
+ iconRight={<TrashIcon className="text-red-400" />}
+ size="small"
+ onClick={() => deleteThreadHandler(thread.threadId)}
+ />
+ </div>
+ ))}
+ </div>
+ </section>
+ </div>
+ );
+};
+```
+
+</TabItem>
+
+</Tabs>
+
+The hooks provide more state information and utilities that you can use for further customization. Detailed information about their API can be found in the
+<ins>[API Reference](../../../reference/js/react-core/)</ins>
+
+## Building a custom composer
+
+Building a custom composer would be very similar to building a custom sidebar. The state that a composer modifies is the
+[`ThreadState`](../../../reference/js/react-core/type-aliases/ThreadState.md) since you are adding and modifying messages in the
+[`Thread`](../../../reference/js/react-core/type-aliases/Thread.md). To accomplish this, Crayon provides the
+[`useThreadState`](../../../reference/js/react-core/functions/useThreadState.md) and [`useThreadActions`](../../../reference/js/react-core/functions/useThreadActions.md) hooks.
+
+The following code snippet demonstrates an example of how you might use these hooks to build a custom composer:
+
+<Tabs groupId='frontend-lang'>
+
+<TabItem value="ts" label="TypeScript">
+
+```tsx
+import { useThreadActions, useThreadState } from "@crayonai/react-core";
+import { Button } from "@crayonai/react-ui";
+import { CircleX, SendIcon } from "lucide-react";
+import { useState } from "react";
+
+export const CustomComposer = () => {
+ const [message, setMessage] = useState("");
+ const { isRunning } = useThreadState();
+ const { onCancel, processMessage } = useThreadActions();
+
+ const handleMessageButton = (e: React.FormEvent<HTMLFormElement>) => {
+ e.preventDefault();
+ if (isRunning) {
+ onCancel();
+ return;
+ }
+
+ if (!message) return;
+
+ processMessage({ role: "user", type: "prompt", message });
+ setMessage("");
+ };
+
+ return (
+ <div className="bg-opacity-5 bg-white rounded-2xl p-4 w-1/2 mx-auto">
+ <form onSubmit={handleMessageButton} className="w-full flex items-center">
+ <input
+ className="w-full h-full bg-transparent outline-none text-white"
+ placeholder="Type your message here..."
+ value={message}
+ onChange={(e) => setMessage(e.target.value)}
+ />
+ <Button
+ variant="primary"
+ iconRight={isRunning ? <CircleX /> : <SendIcon />}
+ type="submit"
+ />
+ </form>
+ </div>
+ );
+};
+```
+
+</TabItem>
+
+<TabItem value="js" label="JavaScript">
+
+```jsx
+import { useThreadActions, useThreadState } from "@crayonai/react-core";
+import { Button } from "@crayonai/react-ui";
+import { CircleX, SendIcon } from "lucide-react";
+import { useState } from "react";
+
+export const CustomComposer = () => {
+ const [message, setMessage] = useState("");
+ const { isRunning } = useThreadState();
+ const { onCancel, processMessage } = useThreadActions();
+
+ const handleMessageButton = (e) => {
+ e.preventDefault();
+ if (isRunning) {
+ onCancel();
+ return;
+ }
+
+ if (!message) return;
+
+ processMessage({ role: "user", type: "prompt", message });
+ setMessage("");
+ };
+
+ return (
+ <div className="bg-opacity-5 bg-white rounded-2xl p-4 w-1/2 mx-auto">
+ <form onSubmit={handleMessageButton} className="w-full flex items-center">
+ <input
+ className="w-full h-full bg-transparent outline-none text-white"
+ placeholder="Type your message here..."
+ value={message}
+ onChange={(e) => setMessage(e.target.value)}
+ />
+ <Button
+ variant="primary"
+ iconRight={isRunning ? <CircleX /> : <SendIcon />}
+ type="submit"
+ />
+ </form>
+ </div>
+ );
+};
+```
+
+</TabItem>
+
+</Tabs>
+
+## Putting it all together
+
+You can then use the custom components along with Crayon's components (or create a custom version of all components) in your root component as follows:
+
+```tsx
+return (
+ <ThemeProvider mode="dark">
+ <ChatProvider
+ threadListManager={threadListManager}
+ threadManager={threadManager}
+ >
+ <Container logoUrl={logoUrl} agentName="Crayon">
+ {/* Custom sidebar */}
+ <CustomSidebar />
+ <ThreadContainer>
+ <MobileHeader />
+ <ScrollArea>
+ <Messages />
+ </ScrollArea>
+ {/* Custom composer */}
+ <CustomComposer />
+ </ThreadContainer>
+ </Container>
+ </ChatProvider>
+ </ThemeProvider>
+);
+```
+
+## Summary
+
+1. **Custom Sidebar Integration**
+ - The thread list can be managed using the `useThreadListState` and `useThreadListActions` hooks
+
+2. **Custom Composer Integration**
+ - The thread can be managed using the `useThreadState` and `useThreadActions` hooks
+
+These customization options allow you to build a fully personalized chat interface while maintaining the core functionality of Crayon's state management system.
+
+By following these patterns, you can create your own custom components that seamlessly integrate with Crayon's ecosystem while maintaining full control over the user interface and experience. Additionally, you can use the `useThreadState` and `useThreadActions` hooks to create custom components for displaying message lists, enabling a fully customized UI.
diff --git a/docs/docs/guides/customization/advanced-customization/assets/advanced-ui-customization.png b/docs/docs/guides/customization/advanced-customization/assets/advanced-ui-customization.png
new file mode 100644
index 000000000..3e7a849fb
Binary files /dev/null and b/docs/docs/guides/customization/advanced-customization/assets/advanced-ui-customization.png differ
diff --git a/docs/docs/guides/customization/advanced-customization/index.mdx b/docs/docs/guides/customization/advanced-customization/index.mdx
new file mode 100644
index 000000000..91499e97c
--- /dev/null
+++ b/docs/docs/guides/customization/advanced-customization/index.mdx
@@ -0,0 +1,5 @@
+import DocCardList from "@theme/DocCardList";
+
+# Advanced Customization
+
+<DocCardList />
diff --git a/docs/docs/guides/customization/index.md b/docs/docs/guides/customization/index.md
deleted file mode 100644
index 90570e953..000000000
--- a/docs/docs/guides/customization/index.md
+++ /dev/null
@@ -1 +0,0 @@
-# Customization
diff --git a/docs/docs/guides/customization/index.mdx b/docs/docs/guides/customization/index.mdx
new file mode 100644
index 000000000..a593ea6a7
--- /dev/null
+++ b/docs/docs/guides/customization/index.mdx
@@ -0,0 +1,5 @@
+import DocCardList from "@theme/DocCardList";
+
+# Customization
+
+<DocCardList />
diff --git a/docs/docs/reference/js/react-core/functions/ChatProvider.md b/docs/docs/reference/js/react-core/functions/ChatProvider.md
index d4282af5e..4d197661d 100644
--- a/docs/docs/reference/js/react-core/functions/ChatProvider.md
+++ b/docs/docs/reference/js/react-core/functions/ChatProvider.md
@@ -4,7 +4,7 @@ function ChatProvider(
): ReactNode | Promise<ReactNode>;
```
-Defined in: [packages/react-core/src/ChatProvider.tsx:30](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/ChatProvider.tsx#L30)
+Defined in: [packages/react-core/src/ChatProvider.tsx:30](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/ChatProvider.tsx#L30)
## Parameters
diff --git a/docs/docs/reference/js/react-core/functions/MessageContext.md b/docs/docs/reference/js/react-core/functions/MessageContext.md
index 0cb44ad7c..44135e5e9 100644
--- a/docs/docs/reference/js/react-core/functions/MessageContext.md
+++ b/docs/docs/reference/js/react-core/functions/MessageContext.md
@@ -6,7 +6,7 @@ function MessageContext(
): ReactNode;
```
-Defined in: [packages/react-core/src/hooks/useMessage.tsx:8](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useMessage.tsx#L8)
+Defined in: [packages/react-core/src/hooks/useMessage.tsx:8](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useMessage.tsx#L8)
## Parameters
diff --git a/docs/docs/reference/js/react-core/functions/MessageProvider.md b/docs/docs/reference/js/react-core/functions/MessageProvider.md
index 49036a14f..7b9d323fe 100644
--- a/docs/docs/reference/js/react-core/functions/MessageProvider.md
+++ b/docs/docs/reference/js/react-core/functions/MessageProvider.md
@@ -5,7 +5,7 @@ function MessageProvider(__namedParameters: {
}): Element;
```
-Defined in: [packages/react-core/src/hooks/useMessage.tsx:25](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useMessage.tsx#L25)
+Defined in: [packages/react-core/src/hooks/useMessage.tsx:25](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useMessage.tsx#L25)
## Parameters
diff --git a/docs/docs/reference/js/react-core/functions/processStreamedMessage.md b/docs/docs/reference/js/react-core/functions/processStreamedMessage.md
index 02307b49d..34d0840dd 100644
--- a/docs/docs/reference/js/react-core/functions/processStreamedMessage.md
+++ b/docs/docs/reference/js/react-core/functions/processStreamedMessage.md
@@ -7,7 +7,7 @@ function processStreamedMessage(__namedParameters: {
}): Promise<void>;
```
-Defined in: [packages/react-core/src/stream/processStreamedMessage.ts:16](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/stream/processStreamedMessage.ts#L16)
+Defined in: [packages/react-core/src/stream/processStreamedMessage.ts:16](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/stream/processStreamedMessage.ts#L16)
## Parameters
diff --git a/docs/docs/reference/js/react-core/functions/useMessage.md b/docs/docs/reference/js/react-core/functions/useMessage.md
index 99df22a8b..45ea1284d 100644
--- a/docs/docs/reference/js/react-core/functions/useMessage.md
+++ b/docs/docs/reference/js/react-core/functions/useMessage.md
@@ -4,7 +4,7 @@ function useMessage(): {
};
```
-Defined in: [packages/react-core/src/hooks/useMessage.tsx:14](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useMessage.tsx#L14)
+Defined in: [packages/react-core/src/hooks/useMessage.tsx:14](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useMessage.tsx#L14)
## Returns
diff --git a/docs/docs/reference/js/react-core/functions/useThreadActions.md b/docs/docs/reference/js/react-core/functions/useThreadActions.md
index 434c53f41..88058989c 100644
--- a/docs/docs/reference/js/react-core/functions/useThreadActions.md
+++ b/docs/docs/reference/js/react-core/functions/useThreadActions.md
@@ -2,7 +2,7 @@
function useThreadActions(): ThreadActions;
```
-Defined in: [packages/react-core/src/hooks/useThreadActions.ts:8](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useThreadActions.ts#L8)
+Defined in: [packages/react-core/src/hooks/useThreadActions.ts:8](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useThreadActions.ts#L8)
## Returns
diff --git a/docs/docs/reference/js/react-core/functions/useThreadListActions.md b/docs/docs/reference/js/react-core/functions/useThreadListActions.md
index e42058bf4..3e3d35bf4 100644
--- a/docs/docs/reference/js/react-core/functions/useThreadListActions.md
+++ b/docs/docs/reference/js/react-core/functions/useThreadListActions.md
@@ -2,7 +2,7 @@
function useThreadListActions(): ThreadListActions;
```
-Defined in: [packages/react-core/src/hooks/useThreadListActions.ts:11](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useThreadListActions.ts#L11)
+Defined in: [packages/react-core/src/hooks/useThreadListActions.ts:11](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useThreadListActions.ts#L11)
## Returns
diff --git a/docs/docs/reference/js/react-core/functions/useThreadListManager.md b/docs/docs/reference/js/react-core/functions/useThreadListManager.md
index a046da68b..eb0b5eb03 100644
--- a/docs/docs/reference/js/react-core/functions/useThreadListManager.md
+++ b/docs/docs/reference/js/react-core/functions/useThreadListManager.md
@@ -9,7 +9,7 @@ function useThreadListManager(params: {
}): ThreadListManager;
```
-Defined in: [packages/react-core/src/useThreadListManager.ts:28](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/useThreadListManager.ts#L28)
+Defined in: [packages/react-core/src/useThreadListManager.ts:28](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/useThreadListManager.ts#L28)
## Parameters
diff --git a/docs/docs/reference/js/react-core/functions/useThreadListState.md b/docs/docs/reference/js/react-core/functions/useThreadListState.md
index 693445aad..e08a17029 100644
--- a/docs/docs/reference/js/react-core/functions/useThreadListState.md
+++ b/docs/docs/reference/js/react-core/functions/useThreadListState.md
@@ -2,7 +2,7 @@
function useThreadListState(): ThreadListState;
```
-Defined in: [packages/react-core/src/hooks/useThreadListState.ts:11](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useThreadListState.ts#L11)
+Defined in: [packages/react-core/src/hooks/useThreadListState.ts:11](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useThreadListState.ts#L11)
## Returns
diff --git a/docs/docs/reference/js/react-core/functions/useThreadManager.md b/docs/docs/reference/js/react-core/functions/useThreadManager.md
index 44c6debce..38daefda9 100644
--- a/docs/docs/reference/js/react-core/functions/useThreadManager.md
+++ b/docs/docs/reference/js/react-core/functions/useThreadManager.md
@@ -2,7 +2,7 @@
function useThreadManager(params: UseThreadManagerParams): ThreadManager;
```
-Defined in: [packages/react-core/src/useThreadManager.ts:26](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/useThreadManager.ts#L26)
+Defined in: [packages/react-core/src/useThreadManager.ts:27](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/useThreadManager.ts#L27)
## Parameters
diff --git a/docs/docs/reference/js/react-core/functions/useThreadManagerSelector.md b/docs/docs/reference/js/react-core/functions/useThreadManagerSelector.md
index dd78f1688..13d489963 100644
--- a/docs/docs/reference/js/react-core/functions/useThreadManagerSelector.md
+++ b/docs/docs/reference/js/react-core/functions/useThreadManagerSelector.md
@@ -2,7 +2,7 @@
function useThreadManagerSelector<R>(accessor: AtomicAccessor<R>): R;
```
-Defined in: [packages/react-core/src/hooks/useThreadManagerSelector.ts:13](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useThreadManagerSelector.ts#L13)
+Defined in: [packages/react-core/src/hooks/useThreadManagerSelector.ts:13](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useThreadManagerSelector.ts#L13)
## Type Parameters
diff --git a/docs/docs/reference/js/react-core/functions/useThreadState.md b/docs/docs/reference/js/react-core/functions/useThreadState.md
index 6d80b477b..d45d8fb95 100644
--- a/docs/docs/reference/js/react-core/functions/useThreadState.md
+++ b/docs/docs/reference/js/react-core/functions/useThreadState.md
@@ -2,7 +2,7 @@
function useThreadState(): ThreadState;
```
-Defined in: [packages/react-core/src/hooks/useThreadState.ts:11](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/hooks/useThreadState.ts#L11)
+Defined in: [packages/react-core/src/hooks/useThreadState.ts:11](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/hooks/useThreadState.ts#L11)
## Returns
diff --git a/docs/docs/reference/js/react-core/interfaces/ResponseTemplate.md b/docs/docs/reference/js/react-core/interfaces/ResponseTemplate.md
index b5423ce70..ead9c3a35 100644
--- a/docs/docs/reference/js/react-core/interfaces/ResponseTemplate.md
+++ b/docs/docs/reference/js/react-core/interfaces/ResponseTemplate.md
@@ -1,8 +1,8 @@
-Defined in: [packages/react-core/src/types/responseTemplate.ts:4](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/responseTemplate.ts#L4)
+Defined in: [packages/react-core/src/types/responseTemplate.ts:4](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/responseTemplate.ts#L4)
## Properties
| Property | Type | Defined in |
| ---------------------------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="component"></a> `Component` | `ComponentType`\<`any`\> | [packages/react-core/src/types/responseTemplate.ts:6](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/responseTemplate.ts#L6) |
-| <a id="name"></a> `name` | `string` | [packages/react-core/src/types/responseTemplate.ts:5](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/responseTemplate.ts#L5) |
+| <a id="component"></a> `Component` | `ComponentType`\<`any`\> | [packages/react-core/src/types/responseTemplate.ts:6](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/responseTemplate.ts#L6) |
+| <a id="name"></a> `name` | `string` | [packages/react-core/src/types/responseTemplate.ts:5](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/responseTemplate.ts#L5) |
diff --git a/docs/docs/reference/js/react-core/type-aliases/AssistantMessage.md b/docs/docs/reference/js/react-core/type-aliases/AssistantMessage.md
index 6357d1abb..ec3849880 100644
--- a/docs/docs/reference/js/react-core/type-aliases/AssistantMessage.md
+++ b/docs/docs/reference/js/react-core/type-aliases/AssistantMessage.md
@@ -19,7 +19,7 @@ type AssistantMessage = {
};
```
-Defined in: [packages/react-core/src/types/message.ts:25](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/message.ts#L25)
+Defined in: [packages/react-core/src/types/message.ts:25](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/message.ts#L25)
## Type declaration
diff --git a/docs/docs/reference/js/react-core/type-aliases/ChatManager.md b/docs/docs/reference/js/react-core/type-aliases/ChatManager.md
index a88d13af9..419ce883c 100644
--- a/docs/docs/reference/js/react-core/type-aliases/ChatManager.md
+++ b/docs/docs/reference/js/react-core/type-aliases/ChatManager.md
@@ -5,7 +5,7 @@ type ChatManager = {
};
```
-Defined in: [packages/react-core/src/types/chatManager.ts:98](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L98)
+Defined in: [packages/react-core/src/types/chatManager.ts:99](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L99)
Main chat manager combining thread and thread list management
diff --git a/docs/docs/reference/js/react-core/type-aliases/CreateMessage.md b/docs/docs/reference/js/react-core/type-aliases/CreateMessage.md
index 25525f555..aadff024d 100644
--- a/docs/docs/reference/js/react-core/type-aliases/CreateMessage.md
+++ b/docs/docs/reference/js/react-core/type-aliases/CreateMessage.md
@@ -2,6 +2,6 @@
type CreateMessage = Omit<UserMessage, "id">;
```
-Defined in: [packages/react-core/src/types/message.ts:54](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/message.ts#L54)
+Defined in: [packages/react-core/src/types/message.ts:54](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/message.ts#L54)
Represents a message being created, with an optional ID
diff --git a/docs/docs/reference/js/react-core/type-aliases/Message.md b/docs/docs/reference/js/react-core/type-aliases/Message.md
index e051bb4b1..197b6da40 100644
--- a/docs/docs/reference/js/react-core/type-aliases/Message.md
+++ b/docs/docs/reference/js/react-core/type-aliases/Message.md
@@ -2,6 +2,6 @@
type Message = UserMessage | AssistantMessage;
```
-Defined in: [packages/react-core/src/types/message.ts:46](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/message.ts#L46)
+Defined in: [packages/react-core/src/types/message.ts:46](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/message.ts#L46)
See [UserMessage](UserMessage.md) and [AssistantMessage](AssistantMessage.md) for more information.
diff --git a/docs/docs/reference/js/react-core/type-aliases/Thread.md b/docs/docs/reference/js/react-core/type-aliases/Thread.md
index 02ce35472..004b1df0f 100644
--- a/docs/docs/reference/js/react-core/type-aliases/Thread.md
+++ b/docs/docs/reference/js/react-core/type-aliases/Thread.md
@@ -7,7 +7,7 @@ type Thread = {
};
```
-Defined in: [packages/react-core/src/types/chatManager.ts:9](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L9)
+Defined in: [packages/react-core/src/types/chatManager.ts:9](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L9)
Represents a chat thread
diff --git a/docs/docs/reference/js/react-core/type-aliases/ThreadActions.md b/docs/docs/reference/js/react-core/type-aliases/ThreadActions.md
index 1bd1fcc33..7d23b233a 100644
--- a/docs/docs/reference/js/react-core/type-aliases/ThreadActions.md
+++ b/docs/docs/reference/js/react-core/type-aliases/ThreadActions.md
@@ -1,14 +1,15 @@
```ts
type ThreadActions = {
appendMessages: (...messages: Message[]) => void;
+ deleteMessage: (messageId: string) => void;
onCancel: () => void;
processMessage: (message: CreateMessage) => Promise<void>;
setMessages: (messages: Message[]) => void;
- updateMessage: (message: Message) => void;
+ updateMessage: (message: Message, shouldTriggerCallback?: boolean) => void;
};
```
-Defined in: [packages/react-core/src/types/chatManager.ts:26](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L26)
+Defined in: [packages/react-core/src/types/chatManager.ts:26](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L26)
Actions available for managing a thread
diff --git a/docs/docs/reference/js/react-core/type-aliases/ThreadListActions.md b/docs/docs/reference/js/react-core/type-aliases/ThreadListActions.md
index dc5b5b0f0..6c8b5fbe7 100644
--- a/docs/docs/reference/js/react-core/type-aliases/ThreadListActions.md
+++ b/docs/docs/reference/js/react-core/type-aliases/ThreadListActions.md
@@ -9,7 +9,7 @@ type ThreadListActions = {
};
```
-Defined in: [packages/react-core/src/types/chatManager.ts:77](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L77)
+Defined in: [packages/react-core/src/types/chatManager.ts:78](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L78)
Actions available for managing the thread list
diff --git a/docs/docs/reference/js/react-core/type-aliases/ThreadListManager.md b/docs/docs/reference/js/react-core/type-aliases/ThreadListManager.md
index 11cb9e81c..8853d1aca 100644
--- a/docs/docs/reference/js/react-core/type-aliases/ThreadListManager.md
+++ b/docs/docs/reference/js/react-core/type-aliases/ThreadListManager.md
@@ -2,6 +2,6 @@
type ThreadListManager = ThreadListState & ThreadListActions;
```
-Defined in: [packages/react-core/src/types/chatManager.ts:91](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L91)
+Defined in: [packages/react-core/src/types/chatManager.ts:92](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L92)
Combines thread list state and actions
diff --git a/docs/docs/reference/js/react-core/type-aliases/ThreadListState.md b/docs/docs/reference/js/react-core/type-aliases/ThreadListState.md
index 53a136f44..4ceff8385 100644
--- a/docs/docs/reference/js/react-core/type-aliases/ThreadListState.md
+++ b/docs/docs/reference/js/react-core/type-aliases/ThreadListState.md
@@ -8,7 +8,7 @@ type ThreadListState = {
};
```
-Defined in: [packages/react-core/src/types/chatManager.ts:64](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L64)
+Defined in: [packages/react-core/src/types/chatManager.ts:65](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L65)
Represents the state of the thread list
diff --git a/docs/docs/reference/js/react-core/type-aliases/ThreadManager.md b/docs/docs/reference/js/react-core/type-aliases/ThreadManager.md
index f31b5b2a6..0a3ee8c07 100644
--- a/docs/docs/reference/js/react-core/type-aliases/ThreadManager.md
+++ b/docs/docs/reference/js/react-core/type-aliases/ThreadManager.md
@@ -2,7 +2,7 @@
type ThreadManager = ThreadState & ThreadActions;
```
-Defined in: [packages/react-core/src/types/chatManager.ts:57](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L57)
+Defined in: [packages/react-core/src/types/chatManager.ts:58](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L58)
Combines thread state and actions
diff --git a/docs/docs/reference/js/react-core/type-aliases/ThreadState.md b/docs/docs/reference/js/react-core/type-aliases/ThreadState.md
index ae89924c9..d475fe945 100644
--- a/docs/docs/reference/js/react-core/type-aliases/ThreadState.md
+++ b/docs/docs/reference/js/react-core/type-aliases/ThreadState.md
@@ -8,7 +8,7 @@ type ThreadState = {
};
```
-Defined in: [packages/react-core/src/types/chatManager.ts:39](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/chatManager.ts#L39)
+Defined in: [packages/react-core/src/types/chatManager.ts:40](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/chatManager.ts#L40)
Represents the state of a thread
diff --git a/docs/docs/reference/js/react-core/type-aliases/UseThreadListManagerParams.md b/docs/docs/reference/js/react-core/type-aliases/UseThreadListManagerParams.md
index 70656afa7..889238cbd 100644
--- a/docs/docs/reference/js/react-core/type-aliases/UseThreadListManagerParams.md
+++ b/docs/docs/reference/js/react-core/type-aliases/UseThreadListManagerParams.md
@@ -9,7 +9,7 @@ type UseThreadListManagerParams = {
};
```
-Defined in: [packages/react-core/src/useThreadListManager.ts:11](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/useThreadListManager.ts#L11)
+Defined in: [packages/react-core/src/useThreadListManager.ts:11](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/useThreadListManager.ts#L11)
Parameters to be passed to the [useThreadListManager](../functions/useThreadListManager.md) hook
diff --git a/docs/docs/reference/js/react-core/type-aliases/UseThreadManagerParams.md b/docs/docs/reference/js/react-core/type-aliases/UseThreadManagerParams.md
index 57079e58d..f6f365b93 100644
--- a/docs/docs/reference/js/react-core/type-aliases/UseThreadManagerParams.md
+++ b/docs/docs/reference/js/react-core/type-aliases/UseThreadManagerParams.md
@@ -6,13 +6,14 @@ type UseThreadManagerParams = {
message: CreateMessage;
threadManager: ThreadManager;
}) => Promise<Message[]>;
+ onUpdateMessage: (props: { message: Message }) => void;
responseTemplates: ResponseTemplate[];
shouldResetThreadState: boolean;
threadId: string | null;
};
```
-Defined in: [packages/react-core/src/useThreadManager.ts:10](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/useThreadManager.ts#L10)
+Defined in: [packages/react-core/src/useThreadManager.ts:10](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/useThreadManager.ts#L10)
Parameters to be passed to the [useThreadManager](../functions/useThreadManager.md) hook
diff --git a/docs/docs/reference/js/react-core/type-aliases/UserMessage.md b/docs/docs/reference/js/react-core/type-aliases/UserMessage.md
index 561d9df1e..4a5888550 100644
--- a/docs/docs/reference/js/react-core/type-aliases/UserMessage.md
+++ b/docs/docs/reference/js/react-core/type-aliases/UserMessage.md
@@ -11,7 +11,7 @@ type UserMessage = {
};
```
-Defined in: [packages/react-core/src/types/message.ts:14](https://github.com/thesysdev/crayon/blob/98ce97833eb11214d1a262c86636536d46fccc04/js/packages/react-core/src/types/message.ts#L14)
+Defined in: [packages/react-core/src/types/message.ts:14](https://github.com/thesysdev/crayon/blob/cbecbe8e16fae54d735cb8e1fe31b72f51300d52/js/packages/react-core/src/types/message.ts#L14)
## Type declaration
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
index 880e4acff..7cde66270 100644
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -12,8 +12,10 @@ const typeDocConfig = {
interfacePropertiesFormat: "htmlTable",
classPropertiesFormat: "htmlTable",
propertyMembersFormat: "htmlTable",
- typeDeclarationFormat: "list",
+ typeDeclarationFormat: "htmlTable",
typeDeclarationVisibility: "compact",
+ sourceLinkTemplate:
+ "https://github.com/thesysdev/crayon/blob/main/{path}#L{line}",
useCodeBlocks: true,
hidePageHeader: true,
hidePageTitle: true,