Skip to content

Commit

Permalink
updating introMessage documentation to allow arrays
Browse files Browse the repository at this point in the history
  • Loading branch information
OvidijusParsiunas committed Jan 8, 2025
1 parent 1da4fb0 commit 600cc59
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions website/docs/docs/messages/messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,14 @@ import Tabs from '@theme/Tabs';

### `introMessage` {#introMessage}

- Type: \{`text?: string`, `html?: string`\}
- Type: \{`text?: string`, `html?: string`\} | `Array`

Initial `ai` message that is displayed when the chat is loaded. It is different to [`history`](#history) as it will not trigger
the [`onMessage`](/docs/events#onMessage) listener, will not be part of the returned messages when [`getMessages`](/docs/methods#getMessages) is called and
is not taken into consideration when calculating [`requestBodyLimits`](/docs/connect#requestBodyLimits). <br />
`html` is used to render [custom code](/docs/messages/HTML) and can be coupled with a [`deep-chat-temporary-message`](/docs/messages/HTML#deepChatClasses)
class to make this message disappear after a new one is added.
class to make this message disappear after a new one is added. <br />
This can either be defined as an object for one message, or as an array for multiple ones.

#### Example

Expand Down

0 comments on commit 600cc59

Please sign in to comment.