UG for the autocompletesuggestions, History, toolbar, working with ai…#4392
UG for the autocompletesuggestions, History, toolbar, working with ai…#4392Santhosh-SF4792 wants to merge 3 commits into
Conversation
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
|
||
|  | ||
|
|
||
| ### Category |
There was a problem hiding this comment.
Title should not have only API name. Make it meaningful.
|
|
||
| ### Category | ||
|
|
||
| In Syncfusion .NET MAUI AI AssistView, the `AssistSuggestion` class exposes a `Category` property that you can use to group autocomplete suggestions by topic. Set `Category` when creating suggestions (for example, "FAQ", "Commands", or "Examples") so the overlay can present related items together. |
There was a problem hiding this comment.
In Syncfusion .NET MAUI AI AssistView - verify this format, whether or not needed.
|
|
||
| In Syncfusion .NET MAUI AI AssistView, the `AssistSuggestion` class exposes a `Category` property that you can use to group autocomplete suggestions by topic. Set `Category` when creating suggestions (for example, "FAQ", "Commands", or "Examples") so the overlay can present related items together. | ||
|
|
||
| Example (setting categories in your ViewModel): |
There was a problem hiding this comment.
Change this heading format.
| {% highlight c# tabtitle="ViewModel.cs" %} | ||
| AutoCompleteSuggestions = new ObservableCollection<ISuggestion>() | ||
| { | ||
| new AssistSuggestion() { Text = "What is .NET MAUI?", Category = "FAQ" }, |
There was a problem hiding this comment.
Change the category example as Recommended/History
| }; | ||
| {% endhighlight %} | ||
|
|
||
| Using the `Category` property helps organize suggestions and creates a clearer experience by enabling grouped suggestions, category headers, and category-based filtering. |
There was a problem hiding this comment.
Not needed as mentioned at start
|
|
||
| ### Filter button | ||
|
|
||
| After clicking the search button in the conversation history drawer, the conversation search view opens. It includes a filter button that lets users filter conversations by date range. |
There was a problem hiding this comment.
Only add the topic description. The first line mentions conversation panel view scenario which is not needed here.
| - **Rename**: Opens a rename popup containing an editor where you can change the conversation title. The popup has two actions: **Rename** (save) and **Cancel** (exit without saving). When **Rename** is clicked, the conversation item's title is updated with the entered text. | ||
| - **Delete**: Opens a delete confirmation popup with two actions: **Delete** and **Cancel**. When **Delete** is clicked the selected conversation item is removed from the conversation history. | ||
|
|
||
| ### New chat and Incognito mode (in the conversation drawer) |
There was a problem hiding this comment.
This topic is not needed
|
|
||
| ## Toolbar menu items | ||
|
|
||
| In Syncfusion .NET MAUI AI AssistView, you can provide toolbar menu items using the `ToolbarMenuOptions` collection on `SfAIAssistView`. Each item can be an `ActionButton` (or any suitable view) and bound to a command on your view model. Example: |
| </syncfusion:SfAIAssistView> | ||
| {% endhighlight %} | ||
|
|
||
| The items added to `ToolbarMenuOptions` appear when the toolbar menu icon is clicked and invoke the bound commands when tapped. |
|
|
||
| Assist context menu items are represented by `AssistContextMenuItem` (inherits from `ActionButton`) and expose the familiar `Text`, `Icon`, `Command`, and `CommandParameter` properties. When the menu is opened for a specific assist item, the control sets the `AssistItem` property on each `AssistContextMenuItem` so commands can access the target `IAssistItem`. | ||
|
|
||
| - When a menu item is tapped the control executes the `Command` on the `AssistContextMenuItem` (if present). If `CommandParameter` is `null`, the control passes the `AssistContextMenuItem` instance as the parameter (so you can access the `AssistItem` property). Alternatively, set `CommandParameter` to `{Binding AssistItem}` in your item template. |
There was a problem hiding this comment.
Alternatively, set CommandParameter to {Binding AssistItem} in your item template. - not needed
| new AssistContextMenuItem | ||
| { | ||
| Text = "Copy", | ||
| Command = new Command<object>(param => |
There was a problem hiding this comment.
Add code snippets equivalent to Xaml
| </syncfusion:SfAIAssistView.ResquestContextMenuItemTemplate> | ||
| {% highlight %} | ||
|
|
||
| Event: `ContextMenuOpening` |
There was a problem hiding this comment.
Modify title as per standard and add heading tag
|
|
||
| Assist context menu items are represented by `AssistContextMenuItem` (inherits from `ActionButton`) and expose the familiar `Text`, `Icon`, `Command`, and `CommandParameter` properties. When the menu is opened for a specific assist item, the control sets the `AssistItem` property on each `AssistContextMenuItem` so commands can access the target `IAssistItem`. | ||
|
|
||
| - When a menu item is tapped the control executes the `Command` on the `AssistContextMenuItem` (if present). If `CommandParameter` is `null`, the control passes the `AssistContextMenuItem` instance as the parameter (so you can access the `AssistItem` property). Alternatively, set `CommandParameter` to `{Binding AssistItem}` in your item template. |
There was a problem hiding this comment.
Alternatively, set CommandParameter to {Binding AssistItem} in your item template. - not needed
|
|
||
| {% endhighlight %} | ||
|
|
||
| ### AutoScrollBehavior |
There was a problem hiding this comment.
Modify heading as a title not api
| {% tabs %} | ||
| {% highlight xaml hl_lines="1" %} | ||
| <syncfusion:SfAIAssistView AutoScrollBehavior="ScrollToLastRequest" | ||
| CanAutoScrollToBottom="True" |
| {% highlight xaml hl_lines="1" %} | ||
| <syncfusion:SfAIAssistView AutoScrollBehavior="ScrollToLastRequest" | ||
| CanAutoScrollToBottom="True" | ||
| AssistItems="{Binding AssistItems}" /> |
There was a problem hiding this comment.
Both Xaml and c# should be similar.
| {% endhighlight %} | ||
| {% endtabs %} | ||
|
|
||
| Using `AutoScrollBehavior` together with `CanAutoScrollToBottom` and handling the `Scrolled` event gives you full control over when and how the AssistView scrolls in response to new content. |
There was a problem hiding this comment.
Include in topic description part
This PR contains the UG for the topics:
AutoSuggestionOverlay - Include Grouping feature.
Conversation Filter Button.
support to pin, Rename and delete feature
ScrollToLastRequest and Response
Toolbar menu items
History new chat and temporary chat.