docs(PromptBox): add promptbox docs#3495
Conversation
ikoevska
left a comment
ikoevska
left a comment
There was a problem hiding this comment.
Reviewed. I recommend taking a look at the comments and revisiting some of the content.
|
|
||
| File attachment functionality is controlled through the `EnableFileSelect` parameter and configured using the [`PromptBoxFileSelectButtonSettings`](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.PromptBoxFileSelectButtonSettings) within the `PromptBoxSettings` section. | ||
|
|
||
| To enable file attachment functionality, set the `EnableFileSelect` parameter to `true`: |
There was a problem hiding this comment.
| To enable file attachment functionality, set the `EnableFileSelect` parameter to `true`: | |
| To enable file attachment functionality, set the `EnableFileSelect` parameter to `true`. |
|
|
||
| The Blazor PromptBox component provides flexible adornment templates that allow you to add custom elements such as buttons, icons, or components around the input area. Adornments adapt intelligently to the current input mode, ensuring optimal layout and user experience. | ||
|
|
||
| You can also control the order of action buttons by arranging them within the templates. |
There was a problem hiding this comment.
This sentence seems a bit disjointed from the logical flow of the section. Either move it elsewhere or consider how to integrate it in the section.
| @@ -0,0 +1,72 @@ | |||
| --- | |||
| title: Modes | |||
|
|
||
| * The user clicks the action button | ||
| * The user presses **Enter** (when content is available and not loading) | ||
| * The button state changes between Send and Stop modes |
There was a problem hiding this comment.
I haven't seen any documentation about send and stop modes till this point? What are these?
|
|
||
| ### OnChange | ||
|
|
||
| The `OnChange` event represents a user confirmation of the current value. It is triggered when the input loses focus after the value has been changed during that focus session. |
There was a problem hiding this comment.
While correct, this entire paragraph is very hard to read. I strongly recommend rewriting it to make it less vague and more readable. Also, explain what is this current value that changes - is it the value of the input, is it some other value?
|
|
||
| When speech-to-text functionality is enabled, the PromptBox provides events through the [`PromptBoxSpeechToTextButtonSettings`](https://docs.telerik.com/blazor-ui/api/Telerik.Blazor.Components.PromptBoxSpeechToTextButtonSettings): | ||
|
|
||
| * OnStart: Fires when speech recognition begins. |
There was a problem hiding this comment.
Can we get code formatting for the event names, please?
Also, the inconsistency between the docs here and the earlier docs is very noticeable. Earlier we had a section per event, now we have a bulleted list with no formatting.
| } | ||
| ```` | ||
|
|
||
| ## File Selection Events |
There was a problem hiding this comment.
Do we expect to have multiple file selection events? Because right now we have only one.
| @@ -0,0 +1,270 @@ | |||
| --- | |||
| title: Events | |||
There was a problem hiding this comment.
Was AI heavily involved in the creation of this page?
4 participants
Closes: https://github.com/telerik/blazor/issues/12721