Skip to content

Commit d16385a

Browse files
committed
docs: Minor updates
1 parent b1a5d9b commit d16385a

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/api/hooks.md

+1
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,7 @@ The `useTextArea` hook allows you to track and manage the chatbot's text area fi
428428
| getTextAreaValue | `function` | Retrieves the string value inside the text area. |
429429
| setTextAreaValue | `async function` | Sets the value inside the text area, identical to `params.setTextAreaValue` detailed [**here**](/docs/api/params#settextareavalue). |
430430
| focusTextArea | `function` | Focuses on the text area. |
431+
| blurTextArea | `function` | Blurs (lose focus of) the text area. |
431432

432433
#### Code Example
433434
```jsx

docs/api/settings.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ const DefaultSettings: Settings = {
9191
},
9292
chatWindow: {
9393
showScrollbar: false,
94+
showTypingIndicator: true,
9495
autoJumpToBottom: false,
9596
showMessagePrompt: true,
9697
messagePromptText: "New Messages ↓",
@@ -314,6 +315,7 @@ Properties here handle the UI/UX in the chat window. Note that it is recommended
314315
| Name | Type | Default | Description |
315316
| -------------------------- | ------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
316317
| showScrollbar | `boolean` | false | Specifies whether scrollbar will be shown when chat messages overflow the window. |
318+
| showTypingIndicator | `boolean` | true | Specifies whether typing indicator will be shown when a block is being processed. |
317319
| autoJumpToBottom | `boolean` | false | Specifies whether new messages will always send the user to the bottom of the chat window (recommended to keep `false` as this can be disruptive). |
318320
| showMessagePrompt | `boolean` | true | Specifies whether to show a message prompt when new messages are received while a user is scrolling the window. |
319321
| messagePromptText | `string` | "New Messages ↓" | The text to be displayed on the message prompt shown. |
@@ -515,7 +517,7 @@ Properties here handle the voice to text feature (**feature is available only on
515517
| disabled | `boolean` | false | Specifies whether chatbot voice is disabled. |
516518
| defaultToggledOn | `boolean` | false | Specifies whether chatbot voice is toggled on by default. |
517519
| language | `string` | "en-US" | The expected language from the user, set by a string representing a [**BCP 47 language tag**](https://www.techonthenet.com/js/language_tags.php). |
518-
| timeoutPeriod | `number` | 10000 | The timeout period in milliseconds for chatbot voice before it automatically toggles off. |
520+
| timeoutPeriod | `number` | 10000 | The timeout period in milliseconds for chatbot voice before it automatically toggles off (set to `0` to disable automatic toggle off). |
519521
| autoSendDisabled | `boolean` | false | Specifies whether auto-sending of voice messages into the chat is disabled. |
520522
| autoSendPeriod | `number` | 1000 | The period in milliseconds after which voice messages are automatically sent. |
521523
| sendAsAudio | `boolean` | false | Specifies whether voice input will be sent as an audio file instead (note that `autoSend` features will not work if this is `true`). |

0 commit comments

Comments
 (0)