@aleph-alpha/chat-kit
v0.1.0
Published
Chat kit package for building chat interfaces with Vue
Readme
@aleph-alpha/chat-kit
Chat kit for building chat interfaces with Vue. Provides pre-built components, composables, and services for conversational experiences.
Part of the frontend-hub monorepo.
Installation
pnpm add @aleph-alpha/chat-kitArchitecture
This package follows a three-layer architecture:
- Services Layer — Interfaces and abstract classes for chat service implementations
- Composables Layer — Reactive state management via Vue Composition API
- Components Layer — Pre-built Vue 3 components for chat UI
Dependencies flow: Components → Composables → Services
Usage
Import from specific entry points for tree-shaking:
// Services only
import { ChatService, type IChatService } from '@aleph-alpha/chat-kit/services';
// Composables only
import { useChat } from '@aleph-alpha/chat-kit/composables';
// Components only
import { ChatConversation } from '@aleph-alpha/chat-kit/components';
// Everything
import { ChatService, useChat, ChatConversation } from '@aleph-alpha/chat-kit';Development
This package lives in the frontend-hub monorepo. To work on it locally:
git clone [email protected]:Aleph-Alpha/frontend-hub.git
cd frontend-hub
pnpm install
# Run tests
pnpm nx run chat-kit:test
# Lint
pnpm nx run chat-kit:lint
# Storybook
pnpm nx run chat-kit:storybookDocumentation
- Overview — Architecture and features
- Integration — Setup and configuration
- API Reference — Components, composables, and services
- CI/CD Flow — Release process and PR checks
- Storybook Deployment — Preview and production Storybook
License
MIT.