Skip to content

docs(InlineAiPrompt): add inline ai prompt documentation #3174

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 12, 2025
Merged

docs(InlineAiPrompt): add inline ai prompt documentation #3174

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc8de8b
docs(InlineAiPrompt): add inline ai prompt documentation
xristianstefanov Aug 12, 2025
83a739a
chore(InlineAiPrompt): address all comments
xristianstefanov Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
242 changes: 242 additions & 0 deletions components/inlineaiprompt/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
---
title: Events
page_title: InlineAIPrompt - Events
description: Events in the InlineAIPrompt for Blazor.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a meaningful description.

slug: inlineaiprompt-events
tags: telerik,blazor,inlineaiprompt,events
published: true
position: 10
---

# InlineAIPrompt Events

This article explains the events available in the Telerik InlineAIPrompt for Blazor:

* [`OnOutputActionClick`](#onoutputactionclick)
* [`OnPromptRequest`](#onpromptrequest)
* [`OnPromptRequestStop`](#onpromptrequeststop)
* [`OnCommandExecute`](#oncommandexecute)
* [`PromptChanged`](#promptchanged)

## OnOutputActionClick

The `OnOutputActionClick` event fires when the user clicks an output action button in the output view of the AIPrompt component. Use this event to handle custom actions such as copying, retrying, or providing feedback on the generated output.

To define the available output actions, set the `OutputActions` parameter to a list of [`InlineAIPromptOutputActionDescriptor`](slug:Telerik.Blazor.Components.InlineAIPromptOutputActionDescriptor) objects. Each action descriptor configures the appearance and behavior of an action button.

The event handler receives an argument of type `InlineAIPromptOutputActionClickEventArgs`, which provides details about the clicked action, the prompt, the output, and the related command (if any). For a full list of available properties, refer to the [`InlineAIPromptOutputActionClickEventArgs` API reference](slug:Telerik.Blazor.Components.InlineAIPromptOutputActionClickEventArgs).

## OnPromptRequest

The `OnPromptRequest` event fires when the user clicks on the **Generate** button within the Prompt view or retries a prompt from the Output view.

The event handler receives an argument of type [`InlineAIPromptPromptRequestEventArgs`](slug:Telerik.Blazor.Components.InlineAIPromptPromptRequestEventArgs). See the [example below](#example).

@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

| Property | Type | Description |
| --- | --- | --- |
| `Prompt` | `string` | The prompt text of the request. |
| `Output` | `string` | The output of the request. The output is based on the prompt text. |
| `IsCancelled` | `bool` | Whether the event is cancelled and the built-in action is prevented. |
| `OutputItem` | `InlineAIPromptOutputItemDescriptor` | The output item. This property will be populated only when the user retries an existing output. See [`InlineAIPromptOutputItemDescriptor`](slug:Telerik.Blazor.Components.InlineAIPromptOutputItemDescriptor). |

> Do not use the `OnPromptRequest` event when [integrating the InlineAIPrompt component with `Microsoft.Extensions.AI`](slug:common-features-microsoft-extensions-ai-integration). The `OnPromptRequest` event disables such integration.

## OnPromptRequestStop

The `OnPromptRequestStop` event fires when the user stops a prompt request by clicking the stop floating action button in the output view. This event allows you to handle the cancellation of an ongoing prompt request.

The event handler receives an `EventCallback` with no arguments.

## OnCommandExecute

The `OnCommandExecute` event fires when the user clicks on a command within the Commands view.

The event handler receives an argument of type [`InlineAIPromptCommandExecuteEventArgs`](slug:Telerik.Blazor.Components.InlineAIPromptCommandExecuteEventArgs). See the [example below](#example).

@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

| Property | Type | Description |
| --- | --- | --- |
| `Command` | `AIPromptCommandDescriptor` | The executed command. |
| `Output` | `string` | The output based on the executed command. |
| `IsCancelled` | `bool` | Whether the event is cancelled and the built-in action is prevented. |
| `OutputItem` | `InlineAIPromptOutputItemDescriptor` | The output item. This property will be populated only when the user retries an existing output. See [`InlineAIPromptOutputItemDescriptor`](slug:Telerik.Blazor.Components.InlineAIPromptOutputItemDescriptor). |

## PromptChanged

The `PromptChanged` event fires when the user changes the prompt text. Use the event to update the InlineAIPrompt's prompt when the `Prompt` parameter is set with one-way binding, otherwise, the user action will be ignored.

## Example

>caption Using InlineAIPrompt events

````Razor
<div class="genres-container">
@foreach (var genre in MovieGenres)
{
<div class="genre-card"
@onclick="@((MouseEventArgs e) => OnGenreContextMenuAsync(e, genre))"
@onclick:preventDefault="true">
@genre
</div>
}
</div>

<TelerikInlineAIPrompt @ref="@InlinePromptRef"
@bind-Prompt="@UserPrompt"
EnableSpeechToText="true"
OnPromptRequest="@OnPromptRequest"
OnCommandExecute="@OnCommandExecute"
OnPromptRequestStop="@OnPromptRequestStop"
OnOutputActionClick="@OnOutputActionClick"
Commands="@Commands"
OutputActions="@OutputActions"
PromptContext="@PromptContext">
</TelerikInlineAIPrompt>

<div id="events-log">
@((MarkupString)EventsLog)
</div>

@code {
private int PromptRequestsCount { get; set; } = 0;
private string EventsLog { get; set; } = string.Empty;
private string UserPrompt { get; set; }
private string PromptContext { get; set; }
private TelerikInlineAIPrompt InlinePromptRef { get; set; }

private List<InlineAIPromptCommandDescriptor> Commands { get; set; } = new()
{
new InlineAIPromptCommandDescriptor()
{
Id = "recommend",
Title = "Recommend Movies",
Icon = SvgIcon.Sparkles,
Prompt = "Suggest top-rated movies in this genre.",
Children = new List<InlineAIPromptCommandDescriptor>
{
new InlineAIPromptCommandDescriptor()
{
Id = "recommend-classics",
Title = "Classic Picks",
Icon = SvgIcon.Star,
Prompt = "List timeless classics in this genre."
},
new InlineAIPromptCommandDescriptor()
{
Id = "recommend-new",
Title = "New Releases",
Icon = SvgIcon.Calendar,
Prompt = "List recent must-watch releases in this genre."
}
}
},
new InlineAIPromptCommandDescriptor()
{
Id = "trivia",
Title = "Genre Trivia",
Icon = SvgIcon.AggregateFields,
Prompt = "Share fun facts and trivia about this movie genre."
}
};

private List<InlineAIPromptOutputActionDescriptor> OutputActions { get; set; } = new()
{
new InlineAIPromptOutputActionDescriptor()
{
Text = "Mark as Favorite",
Icon = SvgIcon.Heart,
Title = "Save this recommendation to favorites",
Enabled = true,
},
new InlineAIPromptOutputActionDescriptor
{
Name = "Retry",
},
new InlineAIPromptOutputActionDescriptor
{
Name = "Copy",
},
new InlineAIPromptOutputActionDescriptor
{
Name = "Discard",
}
};

private List<string> MovieGenres { get; set; } = new()
{
"Action",
"Comedy",
"Drama",
"Science Fiction"
};

private async Task OnGenreContextMenuAsync(MouseEventArgs e, string genre)
{
PromptContext = genre;
await InlinePromptRef.ShowAsync(e.ClientX, e.ClientY);
}

private async Task OnPromptRequest(InlineAIPromptPromptRequestEventArgs args)
{
await Task.Delay(1000);
args.Output = $"AI suggestion for prompt #{PromptRequestsCount++} in {PromptContext}";
EventsLog += $"OnPromptRequest fired <br />";
}

private async Task OnCommandExecute(InlineAIPromptCommandExecuteEventArgs args)
{
await Task.Delay(1000);
args.Output = $"AI executed: {args.Command.Title} for {PromptContext}";
EventsLog += $"OnCommandExecute fired <br />";
}

private void OnPromptRequestStop()
{
EventsLog += $"OnPromptRequestStop: Prompt request stopped. <br />";
}

private void OnOutputActionClick(InlineAIPromptOutputActionClickEventArgs args)
{
EventsLog += $"OnOutputActionClick fired <br />";
}
}

<style>
.genres-container {
display: flex;
flex-wrap: wrap;
gap: 1rem;
padding: 1rem;
justify-content: center;
}

.genre-card {
padding: 1rem 1.5rem;
background-color: #f9f9f9;
border: 1px solid #ddd;
border-radius: 8px;
font-family: 'Segoe UI', sans-serif;
font-size: 1rem;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
transition: transform 0.2s ease;
min-width: 200px;
text-align: center;
cursor: pointer;
}

.genre-card:hover {
transform: translateY(-5px);
box-shadow: 0 4px 8px rgba(0,0,0,0.2);
}

#events-log {
padding: 1rem;
font-family: monospace;
font-size: 0.9rem;
border-top: 1px solid #ddd;
}
</style>
````
Loading