BbQ.ChatWidgets
1.0.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package BbQ.ChatWidgets --version 1.0.0
NuGet\Install-Package BbQ.ChatWidgets -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BbQ.ChatWidgets" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BbQ.ChatWidgets" Version="1.0.0" />
<PackageReference Include="BbQ.ChatWidgets" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add BbQ.ChatWidgets --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: BbQ.ChatWidgets, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package BbQ.ChatWidgets@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=BbQ.ChatWidgets&version=1.0.0
#tool nuget:?package=BbQ.ChatWidgets&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
BbQ.ChatWidgets
A compact library of UI chat widgets and helpers for server and client integrations.
This repository ships three distributable packages:
- NuGet:
BbQ.ChatWidgets(the .NET library: services, renderers, endpoints) - npm:
@bbq-chat/widgets(the JavaScript/TypeScript client library: widgets, client helpers) - npm:
@bbq-chat/widgets-angular(Angular-native components and services)
Note: the .NET package no longer bundles the JavaScript client or theme CSS. Install the npm package (or bring your own UI) to render widgets in a browser.
Quick start (ASP.NET Core)
using BbQ.ChatWidgets;
builder.Services.AddBbQChatWidgets(options =>
{
// configure options (chat client, tools, widgets, etc.)
});
app.MapBbQChatEndpoints();
Features
- Interactive Chat Widgets: Buttons, forms, cards, dropdowns, sliders, toggles, file uploads, and more
- Server-Driven UI: The LLM decides which widgets to show based on conversation context
- Automatic Chat History Summarization: Efficiently manages long conversations by summarizing older turns
- SSE Support: Real-time server-pushed widget updates
- Triage Agents: Route conversations to specialized agents based on classification
- Type-Safe Widget Actions: Strongly-typed handlers for widget interactions
- Extensible Architecture: Swap out components via dependency injection
Install
NuGet (.NET)
dotnet add [YOUR_PROJECT] package BbQ.ChatWidgets
npm (JS/TS client + themes)
npm install @bbq-chat/widgets
npm (Angular native components)
npm install @bbq-chat/widgets-angular @bbq-chat/widgets
Documentation
- Documentation sources:
docs_src/ - Contributing guide:
.github/CONTRIBUTING.md
Build the docs locally (requires DocFX):
./docs/generate-docs.ps1
Or run DocFX directly:
dotnet build BbQ.ChatWidgets/BbQ.ChatWidgets.csproj -c Release
docfx metadata docfx.json
docfx build docfx.json -o docs
Tests
- .NET:
dotnet test - JS/TS:
npm test(run fromSample/WebApp/ClientApp)
License
See LICENSE.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- BbQ.Outcome (>= 1.0.10)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.3.0)
- Microsoft.AspNetCore.Routing (>= 2.3.0)
- Microsoft.Extensions.AI (>= 10.1.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.