Skip to content
Merged
2 changes: 1 addition & 1 deletion agents-docs/_snippets/chat-components/ai-chat-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### AI Chat Settings
### InkeepAIChatSettings

<AutoTypeTable name="default" type="export { InkeepAIChatSettings as default } from '@inkeep/agents-ui/types'" />

Expand Down
2 changes: 1 addition & 1 deletion agents-docs/_snippets/chat-components/base-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Base Settings
### InkeepBaseSettings

<AutoTypeTable name="default" type="export { InkeepBaseSettings as default } from '@inkeep/agents-ui/types'" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,18 @@ The chat button component is a simple way to trigger the Inkeep chat bubble in y

## Config

<AutoTypeTable name="default" type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

### Open Settings
### OpenSettingsChatButton

<AutoTypeTable name="default" type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'"
/>

<Snippet file="chat-components/ai-chat-settings.mdx" />
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Custom triggers give you complete control over how users open Inkeep modals in y
defer
></script>
```

</Step>
<Step>
Insert the ModalChat widget by using the `Inkeep.ModalChat()` function.
Expand Down Expand Up @@ -53,17 +54,24 @@ Custom triggers give you complete control over how users open Inkeep modals in y
// Access chat methods
modalChat.clearChat();
```

</Step>
</Steps>

## Config

<AutoTypeTable name="default" type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

<Snippet file="chat-components/ai-chat-settings.mdx" />

### Open Settings
### OpenSettingsModal

<AutoTypeTable name="default" type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The EmbeddedChat widget provides a fully embedded chat interface that you can in
defer

> </script>

```

</Step>
Expand Down Expand Up @@ -56,7 +57,10 @@ The EmbeddedChat widget provides a fully embedded chat interface that you can in

## Config

<AutoTypeTable name="default" type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,18 @@ The SidebarChat widget provides a slide-out panel interface for conversing with

## Config

<AutoTypeTable name="default" type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

<Snippet file="chat-components/ai-chat-settings.mdx" />

### Open Settings
### OpenSettingsSidebar

<AutoTypeTable name="default" type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ icon: LuMessageCircle
---

<Note>
For Next.js apps that use App Router, use the `"use client"` directive at the top of the file to load the widget client-side.
For Next.js apps that use App Router, use the `"use client"` directive at the
top of the file to load the widget client-side.
</Note>

The chat button component is a simple way to trigger the Inkeep chat bubble. In Next.js, load it with `next/dynamic` and `ssr: false`.
Expand Down Expand Up @@ -103,12 +104,18 @@ pnpm add @inkeep/agents-ui

## Props

<AutoTypeTable name="default" type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

### Open Settings
### OpenSettingsChatButton

<AutoTypeTable name="default" type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'"
/>

<Snippet file="chat-components/ai-chat-settings.mdx" />
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ icon: LuMousePointerClick
---

<Note>
For Next.js apps that use App Router, use the `"use client"` directive at the top of the file to load the widget client-side.
For Next.js apps that use App Router, use the `"use client"` directive at the
top of the file to load the widget client-side.
</Note>

Custom triggers give you complete control over how users open Inkeep modals in your Next.js application. Load `InkeepModalChat` with `next/dynamic` and `ssr: false`.
Expand Down Expand Up @@ -131,12 +132,18 @@ pnpm add @inkeep/agents-ui

## Props

<AutoTypeTable name="default" type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

<Snippet file="chat-components/ai-chat-settings.mdx" />

### Open Settings
### OpenSettingsModal

<AutoTypeTable name="default" type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ icon: LuMonitor
---

<Note>
For Next.js apps that use App Router, use the `"use client"` directive at the top of the file to load the widget client-side.
For Next.js apps that use App Router, use the `"use client"` directive at the
top of the file to load the widget client-side.
</Note>

The InkeepEmbeddedChat component provides a fully embedded chat interface. In Next.js, load it with `next/dynamic` and `ssr: false`. It fits dedicated support pages, dashboards, or help centers.
Expand Down Expand Up @@ -103,7 +104,10 @@ pnpm add @inkeep/agents-ui

## Props

<AutoTypeTable name="default" type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ icon: LuPanelLeft
---

<Note>
For Next.js apps that use App Router, use the `"use client"` directive at the top of the file to load the widget client-side.
For Next.js apps that use App Router, use the `"use client"` directive at the
top of the file to load the widget client-side.
</Note>

The InkeepSidebarChat component provides a slide-out panel for conversing with your agents. In Next.js, load it with `next/dynamic` and `ssr: false`. It can be positioned on either side and supports state or data-attribute triggers.
Expand Down Expand Up @@ -210,20 +211,26 @@ pnpm add @inkeep/agents-ui

### Required Props

| Property | Type | Description |
| -------------------------- | ------ | ---------------------------------------- |
| `aiChatSettings` | object | Configuration for the AI chat connection |
| `aiChatSettings.agentUrl` | string | The URL of your agent endpoint |
| `aiChatSettings.headers` | object | Headers for authentication (dev) |
| Property | Type | Description |
| ------------------------- | ------ | ---------------------------------------- |
| `aiChatSettings` | object | Configuration for the AI chat connection |
| `aiChatSettings.agentUrl` | string | The URL of your agent endpoint |
| `aiChatSettings.headers` | object | Headers for authentication (dev) |

## Props

<AutoTypeTable name="default" type="export { InkeepSidebarChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepSidebarChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

<Snippet file="chat-components/ai-chat-settings.mdx" />

### Open Settings
### OpenSettingsSidebar

<AutoTypeTable name="default" type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,18 @@ pnpm add @inkeep/agents-ui

## Props

<AutoTypeTable name="default" type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepChatButtonProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

### Open Settings
### OpenSettingsChatButton

<AutoTypeTable name="default" type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsChatButton as default } from '@inkeep/agents-ui/types'"
/>

<Snippet file="chat-components/ai-chat-settings.mdx" />
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,18 @@ pnpm add @inkeep/agents-ui

## Props

<AutoTypeTable name="default" type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepModalChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

<Snippet file="chat-components/ai-chat-settings.mdx" />

### Open Settings
### OpenSettingsModal

<AutoTypeTable name="default" type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsModal as default } from '@inkeep/agents-ui/types'"
/>
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,10 @@ pnpm add @inkeep/agents-ui

## Props

<AutoTypeTable name="default" type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepEmbeddedChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,18 @@ pnpm add @inkeep/agents-ui

## Props

<AutoTypeTable name="default" type="export { InkeepSidebarChatProps as default } from '@inkeep/agents-ui'" />
<AutoTypeTable
name="default"
type="export { InkeepSidebarChatProps as default } from '@inkeep/agents-ui'"
/>

<Snippet file="chat-components/base-settings.mdx" />

<Snippet file="chat-components/ai-chat-settings.mdx" />

### Open Settings
### OpenSettingsSidebar

<AutoTypeTable name="default" type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui/types'" />
<AutoTypeTable
name="default"
type="export { OpenSettingsSidebar as default } from '@inkeep/agents-ui/types'"
/>
Loading
Loading