-
Notifications
You must be signed in to change notification settings - Fork 81
docs: add info about chat new features #12450 #3328
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
Hello @IvanDanchev, Check the below option if you would like to automatically generate PR to production. The automation uses the branch for the cherry-pick, and then will delete the branch. Please, do not delete it manually.
|
|
|
||
| The `MessageFilesLayoutMode` parameter controls how file attachments are displayed within chat messages. Choose from three layout options to best fit your application's design: | ||
|
|
||
| * `ChatMessageFilesLayoutMode.Vertical` - Files are displayed in a vertical stack (default) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * `ChatMessageFilesLayoutMode.Vertical` - Files are displayed in a vertical stack (default) | |
| * `ChatMessageFilesLayoutMode.Vertical`—Files are displayed in a vertical stack (default) |
| The `MessageFilesLayoutMode` parameter controls how file attachments are displayed within chat messages. Choose from three layout options to best fit your application's design: | ||
|
|
||
| * `ChatMessageFilesLayoutMode.Vertical` - Files are displayed in a vertical stack (default) | ||
| * `ChatMessageFilesLayoutMode.Horizontal` - Files are displayed in a horizontal row |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * `ChatMessageFilesLayoutMode.Horizontal` - Files are displayed in a horizontal row | |
| * `ChatMessageFilesLayoutMode.Horizontal`—Files are displayed in a horizontal row |
|
|
||
| * `ChatMessageFilesLayoutMode.Vertical` - Files are displayed in a vertical stack (default) | ||
| * `ChatMessageFilesLayoutMode.Horizontal` - Files are displayed in a horizontal row | ||
| * `ChatMessageFilesLayoutMode.Wrap` - Files wrap to the next line when they exceed the message width |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| * `ChatMessageFilesLayoutMode.Wrap` - Files wrap to the next line when they exceed the message width | |
| * `ChatMessageFilesLayoutMode.Wrap`—Files wrap to the next line when they exceed the message width |
|
|
||
| ## Typing Indicator | ||
|
|
||
| The Chat component supports displaying a typing indicator to show when another user is composing a message. Set the `IsTypingField` parameter to specify which field in your data model indicates typing status, and set that field to `true` on a message to display the typing indicator instead of message content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| The Chat component supports displaying a typing indicator to show when another user is composing a message. Set the `IsTypingField` parameter to specify which field in your data model indicates typing status, and set that field to `true` on a message to display the typing indicator instead of message content. | |
| The Chat component supports displaying a typing indicator to show when another user is composing a message. First, set the `IsTypingField` parameter to specify which field in your data model indicates typing status. Next, set that field to `true` on a message to display the typing indicator instead of the message content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, create a numbered list of steps from the last two sentences.
| } | ||
| ```` | ||
|
|
||
| When a message has `IsTyping` set to `true`, the Chat will display an animated typing indicator (typically three dots) instead of the message content. This provides visual feedback that enhances the conversational experience, especially in real-time chat scenarios. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This paragraph should ideally be way above, at the beginning of the section.
|
|
||
| The `SuggestionsLayoutMode` parameter controls how suggestions are displayed in the chat interface. Choose from three layout options to optimize the presentation based on the number and length of your suggestions: | ||
|
|
||
| * `ChatSuggestionsLayoutMode.Wrap` - Suggestions wrap to the next line if they exceed the container width (default) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Switch to mdashes.
| } | ||
| ```` | ||
|
|
||
| Use `Scroll` or `ScrollButtons` mode when you have many suggestions or longer text that won't fit comfortably in the available width. The `ScrollButtons` mode is particularly helpful for users who prefer button navigation over scrolling gestures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, these seem more appropriate toward the start of the section.
|
|
||
| The `SuggestedActionsLayoutMode` parameter controls how suggested actions (quick actions attached to specific messages) are displayed. Similar to `SuggestionsLayoutMode`, it offers three layout options: | ||
|
|
||
| * `ChatSuggestedActionsLayoutMode.Wrap` - Suggested actions wrap to the next line (default) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Switch to mdashes :)
| ## NoDataTemplate | ||
|
|
||
| Customize how individual messages are rendered within the Chat. | ||
| The `NoDataTemplate` allows you to define custom content displayed when the Chat has no messages. This is useful for showing welcome messages, instructions, or branding when the conversation is empty. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same note for allows as before.
|
|
||
| ## MessageContentTemplate | ||
|
|
||
| Customize how individual message content is rendered within the Chat. This template has been renamed from `MessageTemplate` for better clarity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This intro strays from the style of the other sections on the page. Consider aligning for consistency.
Closes https://github.com/telerik/blazor/issues/12450