OpenWebUI TypeScript Embedded SDK

Modern Angular 20 library for embedding OpenWebUI chat in your applications with full conversation history, markdown support, and Angular 2025 architecture.

🌐 Live Demo

Try the live demo →

Interactive demo showcasing all features:

Dynamic configuration
Model selection
Real-time chat with conversation history
Markdown rendering
Multi-language support

✨ Features

🚀 Angular 2025 Ready - Zoneless, Signals, Modern file structure
💬 Conversation History - AI remembers all previous messages
📝 Markdown Support - Rich text rendering with ngx-markdown
⚡ Signals & Zoneless - Latest Angular reactive patterns
📡 Streaming Responses - Real-time chat with typing indicator
⏹️ Stop Generation - Cancel AI response at any time
🎤 Voice Input - Record audio messages with automatic transcription
🌍 Multi-language - 10 languages supported
🎨 Customizable - SCSS with modern features
🔧 TypeScript - Full type safety
📱 Responsive - Mobile-friendly design
⭐ Response Actions - Continue, regenerate, and rate responses
👍 Rating System - Comprehensive feedback with good/bad ratings

🚀 Quick Start

Installation

npm install ngx-open-web-ui-chat

Setup

1. Configure Bootstrap (main.ts)

import { bootstrapApplication } from '@angular/platform-browser';
import { provideZonelessChangeDetection } from '@angular/core';
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http';
import { provideMarkdown } from 'ngx-markdown';
import { AppComponent } from './app/app.component';

bootstrapApplication(AppComponent, {
  providers: [
    provideZonelessChangeDetection(),  // Zoneless mode!
    provideHttpClient(withInterceptorsFromDi()),
    provideMarkdown()  // For markdown rendering
  ]
}).catch((err) => console.error(err));

2. Use Component

import { Component } from '@angular/core';
import { OpenwebuiChatComponent } from 'ngx-open-web-ui-chat';

@Component({
  standalone: true,
  imports: [OpenwebuiChatComponent],
  template: `
    <openwebui-chat
      [endpoint]="'https://your-openwebui-instance.com'"
      [modelId]="'llama3'"
      [apiKey]="'sk-your-api-key'">
    </openwebui-chat>
  `
})
export class AppComponent {}

📖 Key Concepts

Conversation History

The component automatically maintains conversation context:

[
  {"role": "user", "content": "Hello"},
  {"role": "assistant", "content": "Hi! How can I help?"},
  {"role": "user", "content": "What did I just say?"},
  {"role": "assistant", "content": "You said 'Hello'"}
]

Features:

✅ Full conversation history sent with each request
✅ AI remembers all previous messages
✅ Context-aware responses

Angular 2025 Architecture

Zoneless Change Detection:

provideZonelessChangeDetection()  // No ZoneJS!

Signals for State:

messages = signal<ChatMessage[]>([]);
isLoading = signal(false);

Modern File Structure:

components/
├── openwebui-chat.ts       ← Logic
├── openwebui-chat.html     ← Template
└── openwebui-chat.scss     ← Styles (SCSS!)

📁 Project Structure

openwebui-ts-embedded-sdk/
├── projects/
│   └── ngx-open-web-ui-chat/    # Library package
│       ├── src/lib/
│       │   ├── components/
│       │   │   ├── openwebui-chat.ts
│       │   │   ├── openwebui-chat.html
│       │   │   ├── openwebui-chat.scss
│       │   │   ├── chat-input/
│       │   │   ├── chat-message/
│       │   │   ├── error-banner/
│       │   │   ├── message-actions/
│       │   │   ├── rating-form/
│       │   │   └── regenerate-menu/
│       │   ├── services/
│       │   │   └── openwebui-api.ts
│       │   ├── models/
│       │   │   └── chat.model.ts
│       │   └── i18n/
│       │       └── translations.ts
│       └── dist/                 # Built package
├── test-app/                     # Test application
│   ├── src/app/
│   │   ├── app.component.ts
│   │   ├── app.component.html
│   │   └── app.component.scss
│   └── package.json
├── docs/                         # Documentation
│   ├── API.md
│   ├── I18N.md
│   ├── MARKDOWN.md
│   └── CHANGELOG.md
├── README.md                     # This file
└── package.json

🎯 API Reference

Inputs

Input	Type	Required	Default	Description
`endpoint`	`string`	✅	-	OpenWebUI instance URL
`modelId`	`string`	✅	-	AI model identifier
`apiKey`	`string`	✅	-	API key
`enableMarkdown`	`boolean`	❌	`true`	Enable markdown
`debug`	`boolean`	❌	`false`	Debug logging
`language`	`string`	❌	`'en'`	UI language

Outputs

Output	Type	Description
`chatInitialized`	`EventEmitter<void>`	Chat session ready
`messagesChanged`	`EventEmitter<number>`	Message count changed

Methods

Method	Description
`sendMessage(message: string)`	Send a message programmatically
`stopGeneration()`	Stop current AI response generation
`clearChat()`	Clear all messages
`createNewChat()`	Create new chat session
`changeModel(modelId: string)`	Switch to different model

Full API Documentation →

🛠️ Development

Build Library

cd projects/ngx-open-web-ui-chat
npm run build

Output: projects/ngx-open-web-ui-chat/dist/

Test Application

cd test-app
npm start

Visit: http://localhost:4200

Features:

Dynamic host & API key configuration
Model selection
Progressive connection flow
Chat controls (clear, disconnect, language)
Beautiful UI with step-by-step guide

📚 Documentation

Document	Description
API Reference	Complete API documentation
Markdown Guide	Markdown features & examples
I18N Guide	Multi-language support

🔧 Technology Stack

Angular 20.x - Latest framework with signals
TypeScript 5.8 - Full type safety
ng-packagr - Library packaging
ngx-markdown - Markdown rendering
RxJS - Only for streaming (Angular 2025 pattern)
SCSS - Modern styling with nesting

🏗️ Angular 2025 Features

✅ Zoneless Change Detection - No ZoneJS overhead
✅ Signals - Reactive state management
✅ Standalone Components - No NgModules
✅ Modern File Structure - Separated TS/HTML/SCSS
✅ inject() DI - Modern dependency injection
✅ Async/Await - Instead of Observable where appropriate
✅ Computed Properties - Derived state

🎨 Examples

Basic Usage

<openwebui-chat
  [endpoint]="'https://ai.example.com'"
  [modelId]="'llama3'"
  [apiKey]="'sk-abc123'">
</openwebui-chat>

With Controls

import { Component, ViewChild } from '@angular/core';
import { OpenwebuiChatComponent } from 'ngx-open-web-ui-chat';

@Component({
  template: `
    <button (click)="clearChat()">Clear</button>
    <button (click)="sendGreeting()">Say Hi</button>
    
    <openwebui-chat
      #chat
      [endpoint]="endpoint"
      [modelId]="modelId"
      [apiKey]="apiKey"
      (messagesChanged)="onMessageCount($event)">
    </openwebui-chat>
    
    <p>Messages: {{ messageCount }}</p>
  `
})
export class AppComponent {
  @ViewChild('chat') chat?: OpenwebuiChatComponent;
  messageCount = 0;
  
  clearChat() {
    this.chat?.clearChat();
  }
  
  sendGreeting() {
    this.chat?.sendMessage('Hello!');
  }
  
  onMessageCount(count: number) {
    this.messageCount = count;
  }
}

Multi-language

<openwebui-chat
  [endpoint]="endpoint"
  [modelId]="modelId"
  [apiKey]="apiKey"
  [language]="'en'">
</openwebui-chat>

Supported languages: en, zh, hi, es, ar, fr, pt, ru, bn, ja

🚀 Publishing

# 1. Build
cd projects/ngx-open-web-ui-chat
npm run build

# 2. Publish
cd dist
npm publish --access public

🤝 Contributing

Fork the repository
Create a feature branch
Make changes
Test thoroughly
Submit pull request

📝 License

MIT License - see LICENSE file for details

🎓 Best Practices Implemented

✅ Angular 2025 Architecture - Zoneless, signals, modern patterns
✅ Separation of Concerns - TS/HTML/SCSS files
✅ Type Safety - Full TypeScript strict mode
✅ SCSS Features - Nesting, variables, modern CSS
✅ Conversation Context - Full history maintained
✅ Event-Driven - Reactive communication
✅ Responsive Design - Mobile-friendly
✅ Clean Code - Following Angular style guide

🔮 Roadmap

🎤 Voice Input

The component includes voice recording with automatic transcription:

Features

Click microphone button to start recording
Real-time spectrogram visualization
Automatic transcription via OpenWebUI API
Editable transcribed text
Error handling with retry mechanism

Requirements

Modern browser with Web Audio API
Microphone permission
HTTPS connection (browser security requirement)

Status: Production-ready v1.0.9 Angular Version: 20.x
Node Required: >=20.19.0

Made with ❤️ using Angular 2025 architecture

Name		Name	Last commit message	Last commit date
Latest commit History 19 Commits
.github		.github
docs		docs
projects/ngx-open-web-ui-chat		projects/ngx-open-web-ui-chat
test-app		test-app
test-static		test-static
.gitignore		.gitignore
.npmignore		.npmignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
package-lock.json		package-lock.json
package.json		package.json

License

JealousyM/ngx-open-web-ui-chat

Folders and files

Latest commit

History

Repository files navigation