social.io/catalog
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(build): migrate smart config setup and align TypeScript compatibility updates

Browse Source
This commit is contained in:
Jürgen Kunz
2026-04-02 12:50:20 +00:00
parent 3338261cfa
commit 47f2a64a61
15 changed files with 2222 additions and 2749 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
readme.md
View File

@@ -1,6 +1,6 @@
# @social.io/catalog
A modern, beautifully designed UI component library for building conversational interfaces and support chat experiences. Built with Lit Element and TypeScript.
A modern, beautifully crafted UI component library for building conversational interfaces and support chat experiences. Built with [Lit Element](https://lit.dev/) and TypeScript, featuring a shadcn-inspired design system with full dark mode support. 🚀
## Issue Reporting and Security
@@ -8,20 +8,19 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
## 🎯 Features
- **Complete Chat UI** - Ready-to-use conversation components with message threads, typing indicators, and attachments
- **Floating Action Button** - Eye-catching FAB with smooth animations for triggering the chat interface
- **PDF Viewer** - Built-in PDF rendering with zoom, pagination, and download capabilities
- **Image Lightbox** - Full-featured lightbox with zoom, pan, and keyboard navigation
- **Modern Design Tokens** - Consistent styling with customizable colors, spacing, typography, and shadows
- **Dark Mode Ready** - Full light/dark theme support out of the box
- **Accessibility** - Keyboard navigation and proper ARIA attributes
- **TypeScript First** - Full type definitions for all components
- **Complete Chat UI** — Ready-to-use conversation components with message threads, typing indicators, and file attachments
- **Floating Action Button** — Eye-catching FAB with smooth gradient animations and glow effects
- **PDF Viewer** — Built-in PDF rendering with zoom, pagination, and download capabilities
- **Image Lightbox** — Full-featured lightbox with zoom, pan, and keyboard navigation
- **Design Token System** — Comprehensive tokens for colors, spacing, typography, shadows, and animations
- **Dark Mode Ready** — Full light/dark theme support out of the box via `bdTheme()` helper
- **Accessibility** — Keyboard navigation and proper ARIA attributes throughout
- **TypeScript First** — Full type definitions and IntelliSense for all components
- **Lazy-loaded Libraries** — rrweb for session recording is loaded on-demand from CDN via `SioServiceLibLoader`
## 📦 Installation
```bash
npm install @social.io/catalog
# or
pnpm add @social.io/catalog
```
@@ -30,8 +29,7 @@ pnpm add @social.io/catalog
```typescript
import { SioFab, SioCombox } from '@social.io/catalog';
// Components auto-register as custom elements
// Just use them in your HTML:
// Components auto-register as custom elements — just drop them into your HTML:
```
```html
@@ -46,54 +44,74 @@ import { SioFab, SioCombox } from '@social.io/catalog';
### Core Components
| Component | Description |
|-----------|-------------|
| `<sio-fab>` | Floating action button with animated chat icon |
| `<sio-combox>` | Complete chat interface with conversation list and message view |
| `<sio-button>` | Styled button with variants (primary, secondary, destructive, outline, ghost) |
| `<sio-icon>` | Lucide icon wrapper with size and color customization |
| `<sio-dropdown-menu>` | Animated dropdown menu with keyboard support |
| Component | Tag | Description |
|-----------|-----|-------------|
| `SioFab` | `<sio-fab>` | Floating action button with animated gradient, glow effects, and pulse animation |
| `SioCombox` | `<sio-combox>` | Complete chat interface combining conversation list, message view, and input |
| `SioButton` | `<sio-button>` | Styled button with variants: `primary`, `secondary`, `destructive`, `outline`, `ghost` |
| `SioIcon` | `<sio-icon>` | [Lucide](https://lucide.dev/) icon wrapper with size, color, and strokeWidth customization |
| `SioDropdownMenu` | `<sio-dropdown-menu>` | Animated dropdown menu with keyboard support and auto-positioning |
### Conversation Components
| Component | Description |
|-----------|-------------|
| `<sio-conversation-selector>` | Searchable list of conversations with unread indicators |
| `<sio-conversation-view>` | Message thread with typing indicators and file attachments |
| `<sio-message-input>` | Auto-expanding textarea with file upload |
| Component | Tag | Description |
|-----------|-----|-------------|
| `SioConversationSelector` | `<sio-conversation-selector>` | Searchable list of conversations with unread indicators and status badges |
| `SioConversationView` | `<sio-conversation-view>` | Message thread with typing indicators, timestamps, and file attachment support |
| `SioMessageInput` | `<sio-message-input>` | Auto-expanding textarea with file upload capabilities |
### Media Components
| Component | Description |
|-----------|-------------|
| `<sio-image-lightbox>` | Fullscreen image viewer with zoom and pan |
| `<sio-pdf-viewer>` | PDF renderer with page navigation and zoom controls |
| Component | Tag | Description |
|-----------|-----|-------------|
| `SioImageLightbox` | `<sio-image-lightbox>` | Fullscreen image viewer with zoom, pan, and keyboard navigation; also handles PDF files |
| `SioPdfViewer` | `<sio-pdf-viewer>` | PDF renderer with page navigation, zoom controls, and download button |
### Utility Components
| Component | Description |
|-----------|-------------|
| `<sio-recorder>` | Session recording using rrweb |
| Component | Tag | Description |
|-----------|-----|-------------|
| `SioRecorder` | `<sio-recorder>` | Session recording and playback using [rrweb](https://www.rrweb.io/), lazy-loaded from CDN |
## 💅 Styling & Theming
### Services
The library uses CSS custom properties for theming. The design system includes:
| Export | Description |
|--------|-------------|
| `SioServiceLibLoader` | CDN-based lazy loader for rrweb and rrweb-player libraries |
- **Colors** - Primary, secondary, accent, destructive, muted, and semantic colors
- **Typography** - System font stack with size and weight variants
- **Spacing** - Consistent spacing scale (0.5rem increments)
- **Radius** - Border radius tokens from sm to full
- **Shadows** - Elevation system from sm to 2xl
- **Transitions** - Smooth animation presets
## 💅 Design System
The library ships a comprehensive, shadcn/ui-inspired design token system. All tokens are exported so you can use them in your own components.
### Colors
```typescript
import { colors, bdTheme } from '@social.io/catalog/elements/00colors.js';
```
Includes `primary`, `secondary`, `accent`, `destructive`, `muted`, `success`, `background`, `foreground`, `card`, `popover`, `border`, `input`, `ring`, and 5 chart colors — each with light and dark variants.
### Spacing, Radius, Shadows & More
```typescript
import { spacing, radius, shadows, transitions, sizes, zIndex, breakpoints } from '@social.io/catalog/elements/00tokens.js';
```
- **Spacing** — Tailwind-compatible scale from `0` to `96` (0–384px)
- **Radius** — From `sm` (2px) through `full` (9999px)
- **Shadows** — Elevation system from `sm` to `2xl`, plus theme-aware `card` and `dropdown` shadows
- **Transitions** — Presets (`all`, `colors`, `opacity`, `shadow`, `transform`) with timing functions
- **Z-index** — Semantic layers: `dropdown`, `sticky`, `fixed`, `modal`, `popover`, `tooltip`
- **Breakpoints** — `sm` (640px) through `2xl` (1536px)
### Dark Mode
Dark mode is automatically supported. The components use `bdTheme()` helper that switches between light and dark values:
Dark mode is automatically supported. Use the `bdTheme()` helper for theme-aware values:
```typescript
import { bdTheme } from '@social.io/catalog';
import { bdTheme } from '@social.io/catalog/elements/00colors.js';
// Usage in styles
// Returns the correct value based on the current theme
css`
background: ${bdTheme('hsl(0 0% 100%)', 'hsl(0 0% 10%)')};
`
@@ -101,40 +119,55 @@ css`
## 📖 Usage Examples
### Basic Chat FAB
### 💬 Chat FAB
```html
<sio-fab></sio-fab>
```
The FAB opens a complete chat interface when clicked. It includes:
- Keyboard shortcut (Ctrl+S) to toggle
The FAB positions itself at the bottom-right corner and opens a complete chat interface when clicked. It features:
- Animated gradient background (indigo → violet → purple)
- Glow effect on hover
- Smooth scale and pulse animations
- Gradient background with glow effects
### Custom Button Variants
### 🔘 Buttons
```html
<sio-button>Default</sio-button>
<sio-button type="primary">Submit</sio-button>
<sio-button type="destructive">Delete</sio-button>
<sio-button type="outline">Cancel</sio-button>
<sio-button type="ghost" size="sm">
<sio-icon icon="settings"></sio-icon>
</sio-button>
<sio-button size="lg">Large</sio-button>
<sio-button disabled>Disabled</sio-button>
```
### Image Lightbox
Sizes: `sm`, `default`, `lg`. Status: `normal`, `pending`, `success`, `error`.
### 🖼️ Image Lightbox
```typescript
const lightbox = document.querySelector('sio-image-lightbox');
lightbox.open({
// Open with an image
await lightbox.open({
url: 'https://example.com/photo.jpg',
name: 'My Photo',
size: 1024000
});
// Or open with a PDF
await lightbox.open({
url: 'https://example.com/document.pdf',
name: 'report.pdf',
type: 'application/pdf',
size: 565000
});
```
### PDF Viewer
### 📄 PDF Viewer
```html
<sio-pdf-viewer
@@ -143,12 +176,13 @@ lightbox.open({
></sio-pdf-viewer>
```
### Dropdown Menu
### ☰ Dropdown Menu
```html
<sio-dropdown-menu
.items=${[
{ id: 'edit', label: 'Edit', icon: 'pencil' },
{ id: 'divider', label: '', divider: true },
{ id: 'delete', label: 'Delete', icon: 'trash', destructive: true }
]}
@item-selected=${(e) => console.log('Selected:', e.detail.item)}
@@ -159,6 +193,17 @@ lightbox.open({
</sio-dropdown-menu>
```
### 🎨 Icons
Uses the full [Lucide](https://lucide.dev/) icon set. Pass kebab-case icon names:
```html
<sio-icon icon="search"></sio-icon>
<sio-icon icon="message-square" color="#3b82f6"></sio-icon>
<sio-icon icon="x" size="32"></sio-icon>
<sio-icon icon="send" .strokeWidth=${3}></sio-icon>
```
## 🔧 Development
```bash
@@ -168,23 +213,26 @@ pnpm install
# Start development server with hot reload
pnpm watch
# Run tests
pnpm test
# Build for production
pnpm build
# Run tests (Chromium browser tests)
pnpm test
```
## 📚 Dependencies
- **@design.estate/dees-element** - Lit Element base with utilities
- **@design.estate/dees-domtools** - DOM manipulation helpers
- **lucide** - Beautiful open-source icons
- **rrweb** - Session recording/replay (for recorder component)
| Package | Purpose |
|---------|---------|
| [`@design.estate/dees-element`](https://www.npmjs.com/package/@design.estate/dees-element) | Lit Element base class with theming utilities |
| [`@design.estate/dees-domtools`](https://www.npmjs.com/package/@design.estate/dees-domtools) | DOM manipulation and convenience helpers |
| [`@design.estate/dees-wcctools`](https://www.npmjs.com/package/@design.estate/dees-wcctools) | Web component catalog tools |
| [`lucide`](https://lucide.dev/) | Beautiful, consistent open-source icon set |
| [`rrweb`](https://www.rrweb.io/) | Session recording/replay (lazy-loaded from CDN) |
## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.