@bbki.ng/bb-msg-history 0.1.2 → 0.3.0

package/README.md

@@ -37,54 +37,203 @@ Each message is a line with the author name, a colon, and the message text:
 
 Blank lines and lines without a colon are ignored.
 
-## Built-in Authors
+## Author Avatars
 
-Two authors have built-in SVG avatars and are pre-configured with a specific side:
+By default, every author gets a **letter avatar** (first character of their name) and appears on the **left** side.
 
-| Author | Side | Bubble Color |
-|--------|------|--------------|
-| `bbki.ng` | right | light gray |
-| `xwy` | left | light pink |
+Use the `setAuthor()` method to customize avatar, side, bubble color, and text color:
 
-Any other author name is placed on the **left** side and receives a letter avatar (first character of the name).
+```js
+const el = document.querySelector('bb-msg-history');
+
+// Emoji avatar, right side
+el.setAuthor('me', { avatar: '🐱', side: 'right' });
+
+// Image avatar, custom bubble color
+el.setAuthor('bot', {
+  avatar: '<img src="bot.png" width="28" height="28" />',
+  side: 'left',
+  bubbleColor: '#e0f2fe',
+});
+
+// SVG avatar
+el.setAuthor('alice', {
+  avatar: '<svg viewBox="0 0 48 48">...</svg>',
+  side: 'left',
+});
+```
+
+### `setAuthor(name, options)`
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `avatar` | `string` | letter avatar | HTML string: emoji, `<img>`, `<svg>`, or text |
+| `side` | `'left' \| 'right'` | `'left'` | Which side the bubbles appear on |
+| `bubbleColor` | `string` | `'#f9fafb'` | Bubble background color |
+| `textColor` | `string` | `'#111827'` | Text color inside bubble |
+
+Returns `this` for chaining:
+
+```js
+el.setAuthor('me', { avatar: '🐱', side: 'right' })
+  .setAuthor('you', { avatar: '🐶', side: 'left' });
+```
+
+Fuzzy matching: if an author name _contains_ a configured key (e.g. you configured `"alice"` and the message is from `"alice(phone)"`), the config is reused.
+
+Use `removeAuthor(name)` to remove a custom config.
+
+### `appendMessage(message)`
+
+Append a message programmatically with smooth scroll to the new message.
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `message.author` | `string` | The author name |
+| `message.text` | `string` | The message text |
+
+```js
+el.appendMessage({ author: 'alice', text: 'Hello!' });
+el.appendMessage({ author: 'bob', text: 'How are you?' });
+```
+
+Returns `this` for chaining. This is ideal for chat applications where messages arrive in real-time.
+
+**Note:** Unlike modifying `textContent` directly, `appendMessage()` scrolls smoothly to the newly added message.
+
+## Customization
+
+### CSS Custom Properties
+
+| Property | Default | Description |
+|----------|---------|-------------|
+| `--bb-max-height` | `600px` | Maximum height of the message container |
+
+```css
+bb-msg-history {
+  --bb-max-height: 400px;
+}
+```
+
+### Manual Registration
+
+By default, the component auto-registers as `<bb-msg-history>`. You can also register manually with a custom tag name:
+
+```js
+import { BBMsgHistory, define } from '@bbki.ng/bb-msg-history';
+
+// Register with default tag name
+define();
+
+// Or use a custom tag name
+define('my-chat-history');
+```
 
 ## Features
 
 - Plain-text message format — no JSON or attributes needed
 - Left/right bubble layout based on author
-- SVG avatars with hover tooltip showing the author name
+- Customizable avatars: emoji, `<img>`, `<svg>`, or letter avatars
+- Hover tooltip showing the author name
+- Consecutive messages from the same author are grouped (avatar hidden)
 - Auto-scroll to the latest message on render
-- Fade-in animation per message row
+- **`appendMessage()` API** — programmatically add messages with smooth scroll
+- Long text word-wrap and overflow handling
+- Empty state when no messages are provided
 - Dark mode support via `prefers-color-scheme`
 - Mobile responsive layout
 - `prefers-reduced-motion` support
+- Reactive: automatically re-renders when content changes
+- Customizable max-height via `--bb-max-height` CSS custom property
 - Graceful degradation to `<pre>` when Custom Elements are unsupported
 
 ## Examples
 
-### Basic conversation
+### Basic
+
+```html
+<bb-msg-history>
+  alice: Hey, are you free this weekend?
+  bob: Sounds good! When?
+  alice: Saturday morning, around 10?
+  bob: Perfect. See you then!
+</bb-msg-history>
+```
+
+### Custom avatars
+
+```html
+<bb-msg-history id="chat">
+  me: Hey there!
+  friend: What's up?
+</bb-msg-history>
+
+<script>
+  const el = document.getElementById('chat');
+  el.setAuthor('me', { avatar: '🐱', side: 'right', bubbleColor: '#f3f4f6' });
+  el.setAuthor('friend', { avatar: '🐶', side: 'left', bubbleColor: '#e0f2fe' });
+</script>
+```
+
+### Consecutive messages — avatar grouping
+
+When the same author sends multiple messages in a row, the avatar is only shown on the first one:
 
 ```html
 <bb-msg-history>
-  bbki.ng: 谁呀？
-  xwy: 谁谁谁，你猴爷爷！
-  bbki.ng: foo
-  xwy: bar
+  alice: First message
+  alice: Second message, avatar hidden
+  alice: Third, still hidden
+  bob: Got it!
+  bob: I'll send two as well
 </bb-msg-history>
 ```
 
-### Unknown / custom authors
+### Unknown authors — letter avatars
 
-Authors not listed in the built-in config receive a letter avatar and appear on the left:
+Authors without custom config receive a letter avatar and appear on the left:
 
 ```html
 <bb-msg-history>
-  alice: Hey!
+  alice: Hello!
   bob: Hi there!
-  alice: How are you?
+  charlie: Hey everyone!
 </bb-msg-history>
 ```
 
+### Empty state
+
+When no messages are provided, a "No messages" placeholder is shown:
+
+```html
+<bb-msg-history></bb-msg-history>
+```
+
+### Dynamic message appending
+
+Use `appendMessage()` to add messages programmatically with smooth scrolling:
+
+```html
+<bb-msg-history id="chat" style="--bb-max-height: 300px;">
+  alice: Hey there!
+</bb-msg-history>
+
+<script>
+  const el = document.getElementById('chat');
+  el.setAuthor('alice', { avatar: '👩', side: 'right' });
+  el.setAuthor('bob', { avatar: '👨', side: 'left' });
+
+  // Add messages dynamically with smooth scroll
+  el.appendMessage({ author: 'bob', text: 'Hello! How are you?' });
+  el.appendMessage({ author: 'alice', text: 'I\'m doing great!' });
+  
+  // Simulate receiving a message after 2 seconds
+  setTimeout(() => {
+    el.appendMessage({ author: 'bob', text: 'Nice to hear that!' });
+  }, 2000);
+</script>
+```
+
 ### Full page example
 
 ```html
@@ -94,13 +243,19 @@ Authors not listed in the built-in config receive a letter avatar and appear on
   <script type="module" src="https://cdn.jsdelivr.net/npm/@bbki.ng/bb-msg-history@latest/dist/index.js"></script>
 </head>
 <body>
-  <bb-msg-history>
+  <bb-msg-history id="chat">
     alice: Hey, are you free this weekend?
     bob: Yeah, what's up?
     alice: Want to grab coffee?
     bob: Sounds good! Saturday morning?
     alice: Perfect, see you then!
   </bb-msg-history>
+
+  <script>
+    const el = document.getElementById('chat');
+    el.setAuthor('alice', { avatar: '👩', side: 'right' });
+    el.setAuthor('bob', { avatar: '👨', side: 'left', bubbleColor: '#ecfdf5' });
+  </script>
 </body>
 </html>
 ```

package/dist/component.d.ts

@@ -0,0 +1,35 @@
+import type { AuthorOptions, Message } from './types/index.js';
+export declare class BBMsgHistory extends HTMLElement {
+    private _mutationObserver?;
+    private _userAuthors;
+    private _lastAuthor;
+    constructor();
+    /**
+     * Configure an author's avatar, side, and colors.
+     * Call before or after rendering — the component re-renders automatically.
+     *
+     * @example
+     * el.setAuthor('alice', { avatar: '🐱', side: 'right', bubbleColor: '#e0f2fe' });
+     * el.setAuthor('bob', { avatar: '<img src="bob.png" />', side: 'left' });
+     */
+    setAuthor(name: string, options: AuthorOptions): this;
+    /**
+     * Remove a previously set author config.
+     */
+    removeAuthor(name: string): this;
+    /**
+     * Append a message to the history.
+     * Automatically scrolls to the new message with smooth animation.
+     *
+     * @example
+     * el.appendMessage({ author: 'alice', text: 'Hello!' });
+     * el.appendMessage({ author: 'bob', text: 'How are you?' });
+     */
+    appendMessage(message: Message): this;
+    private _appendSingleMessage;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private _setupMutationObserver;
+    private render;
+    private _renderEmpty;
+}

package/dist/component.js

@@ -0,0 +1,141 @@
+import { MAIN_STYLES, EMPTY_STYLES } from './const/styles.js';
+import { parseMessages } from './utils/message-parser.js';
+import { resolveAuthorConfig } from './utils/author-resolver.js';
+import { setupTooltips } from './utils/tooltip.js';
+import { buildMessageRowHtml, setupTooltipForElement } from './utils/message-builder.js';
+export class BBMsgHistory extends HTMLElement {
+    constructor() {
+        super();
+        this._userAuthors = new Map();
+        this._lastAuthor = '';
+        this.attachShadow({ mode: 'open' });
+    }
+    /**
+     * Configure an author's avatar, side, and colors.
+     * Call before or after rendering — the component re-renders automatically.
+     *
+     * @example
+     * el.setAuthor('alice', { avatar: '🐱', side: 'right', bubbleColor: '#e0f2fe' });
+     * el.setAuthor('bob', { avatar: '<img src="bob.png" />', side: 'left' });
+     */
+    setAuthor(name, options) {
+        this._userAuthors.set(name, options);
+        this.render();
+        return this;
+    }
+    /**
+     * Remove a previously set author config.
+     */
+    removeAuthor(name) {
+        this._userAuthors.delete(name);
+        this.render();
+        return this;
+    }
+    /**
+     * Append a message to the history.
+     * Automatically scrolls to the new message with smooth animation.
+     *
+     * @example
+     * el.appendMessage({ author: 'alice', text: 'Hello!' });
+     * el.appendMessage({ author: 'bob', text: 'How are you?' });
+     */
+    appendMessage(message) {
+        // Update textContent
+        const currentText = this.textContent || '';
+        const separator = currentText && !currentText.endsWith('\n') ? '\n' : '';
+        this.textContent = currentText + separator + `${message.author}: ${message.text}`;
+        // Temporarily disconnect observer to prevent recursive render
+        this._mutationObserver?.disconnect();
+        // Append single message without re-rendering entire list
+        this._appendSingleMessage(message);
+        // Reconnect observer
+        this._setupMutationObserver();
+        return this;
+    }
+    _appendSingleMessage(message) {
+        const container = this.shadowRoot.querySelector('.history');
+        // If empty state or no container, do full render first
+        if (!container) {
+            this.render();
+            return;
+        }
+        const author = message.author;
+        const text = message.text;
+        const config = resolveAuthorConfig(author, this._userAuthors);
+        const isFirstFromAuthor = author !== this._lastAuthor;
+        this._lastAuthor = author;
+        const isSubsequent = !isFirstFromAuthor;
+        // Use utility function to build message HTML
+        const msgHtml = buildMessageRowHtml(author, text, config, isSubsequent);
+        // Append to container
+        container.insertAdjacentHTML('beforeend', msgHtml);
+        // Setup tooltip for new element using utility function
+        const newWrapper = container.lastElementChild?.querySelector('.avatar-wrapper');
+        if (newWrapper) {
+            setupTooltipForElement(newWrapper);
+        }
+        // Smooth scroll to bottom
+        container.scrollTo({
+            top: container.scrollHeight,
+            behavior: 'smooth'
+        });
+    }
+    connectedCallback() {
+        this.render();
+        this._setupMutationObserver();
+    }
+    disconnectedCallback() {
+        this._mutationObserver?.disconnect();
+    }
+    _setupMutationObserver() {
+        let debounceTimer;
+        this._mutationObserver = new MutationObserver(() => {
+            clearTimeout(debounceTimer);
+            debounceTimer = setTimeout(() => this.render(), 50);
+        });
+        this._mutationObserver.observe(this, {
+            childList: true,
+            characterData: true,
+            subtree: true,
+        });
+    }
+    render() {
+        const messages = parseMessages(this.textContent);
+        if (messages.length === 0) {
+            this._lastAuthor = '';
+            this._renderEmpty();
+            return;
+        }
+        let lastAuthor = '';
+        const messagesHtml = messages
+            .map(({ author, text }) => {
+            const config = resolveAuthorConfig(author, this._userAuthors);
+            const isFirstFromAuthor = author !== lastAuthor;
+            lastAuthor = author;
+            const isSubsequent = !isFirstFromAuthor;
+            // Use utility function to build message HTML
+            return buildMessageRowHtml(author, text, config, isSubsequent);
+        })
+            .join('');
+        this._lastAuthor = lastAuthor;
+        this.shadowRoot.innerHTML = `
+      <style>${MAIN_STYLES}</style>
+      <div class="history" role="log" aria-live="polite" aria-label="Message history">
+        ${messagesHtml}
+      </div>
+    `;
+        requestAnimationFrame(() => {
+            const container = this.shadowRoot.querySelector('.history');
+            if (container) {
+                container.scrollTop = container.scrollHeight;
+            }
+            setupTooltips(this.shadowRoot);
+        });
+    }
+    _renderEmpty() {
+        this.shadowRoot.innerHTML = `
+      <style>${EMPTY_STYLES}</style>
+      <div class="empty-state">No messages</div>
+    `;
+    }
+}

package/dist/const/authors.d.ts

@@ -0,0 +1,10 @@
+import type { AuthorConfig } from '../types/index.js';
+/**
+ * Built-in author configurations (secret presets)
+ * These are used for specific authors in personal projects
+ */
+export declare const AUTHOR_CONFIG: Record<string, Omit<AuthorConfig, 'isCustomAvatar'>>;
+/**
+ * Authors that should use first-character avatar instead of SVG
+ */
+export declare const FIRST_CHAR_AVATAR_AUTHORS: Set<string>;

package/dist/const/authors.js

@@ -0,0 +1,29 @@
+import { THEME } from './theme.js';
+/**
+ * Built-in author configurations (secret presets)
+ * These are used for specific authors in personal projects
+ */
+export const AUTHOR_CONFIG = {
+    'bbki.ng': {
+        avatar: `<svg xmlns="http://www.w3.org/2000/svg" width="28" height="28" viewBox="0 0 48 48" fill="none"><path d="M29.1152 21.3106C32.0605 21.3106 34.4481 18.9101 34.4481 15.9489V24.6457C34.4481 25.7585 33.5508 26.6607 32.444 26.6607H15.1207C14.0138 26.6607 13.1166 25.7585 13.1166 24.6457V15.9489C13.1166 18.9101 15.5042 21.3106 18.4494 21.3106C21.3947 21.3106 23.7823 18.9101 23.7823 15.9489C23.7823 18.9101 26.17 21.3106 29.1152 21.3106Z" fill="${THEME.gray[400]}"/><path d="M23.7823 15.9373L23.7823 15.9489C23.7823 15.9451 23.7823 15.9412 23.7823 15.9373Z" fill="${THEME.gray[400]}"/><path d="M23.1143 28.004C23.1205 30.9598 25.5057 33.3541 28.4472 33.3541C31.3886 33.3541 33.7738 30.9598 33.7801 28.004H23.1143Z" fill="${THEME.gray[400]}"/><path d="M13.7846 28.004C13.7846 28.0079 13.7846 28.0117 13.7846 28.0156C13.7908 30.9714 16.1761 33.3657 19.1175 33.3657C22.0589 33.3657 24.4442 30.9714 24.4504 28.0156H13.7846V28.004Z" fill="${THEME.gray[400]}"/><path d="M14.4527 15.9373C14.4527 16.6792 13.8545 17.2806 13.1166 17.2806C12.3786 17.2806 11.7805 16.6792 11.7805 15.9373C11.7805 15.1954 12.3786 14.594 13.1166 14.594C13.8545 14.594 14.4527 15.1954 14.4527 15.9373Z" fill="${THEME.gray[400]}"/><path d="M25.1184 15.2657C25.1184 16.0076 24.5202 16.609 23.7823 16.609C23.0444 16.609 22.4462 16.0076 22.4462 15.2657C22.4462 14.5238 23.0444 13.9224 23.7823 13.9224C24.5202 13.9224 25.1184 14.5238 25.1184 15.2657Z" fill="${THEME.gray[400]}"/><path d="M35.7842 15.9373C35.7842 16.6792 35.186 17.2806 34.4481 17.2806C33.7102 17.2806 33.112 16.6792 33.112 15.9373C33.112 15.1954 33.7102 14.594 34.4481 14.594C35.186 14.594 35.7842 15.1954 35.7842 15.9373Z" fill="${THEME.gray[400]}"/></svg>`,
+        bubbleColor: THEME.gray[100],
+        textColor: THEME.gray[900],
+        side: 'right'
+    },
+    'xwy': {
+        avatar: `<svg width="28" height="28" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M12.821 17.5305C10.709 18.17 9.68345 19.4423 9.22624 20.1359C9.11159 20.3099 9.21615 20.5428 9.42038 20.5839L12.67 21.2381C12.8291 21.2702 12.9328 21.4275 12.9084 21.5879C11.3004 32.1653 21.5275 36.7547 28.6638 33.0597C28.7443 33.018 28.8408 33.0139 28.9245 33.0487C32.8032 34.6598 35.967 34.5662 37.8217 34.3099C38.131 34.2671 38.1505 33.841 37.855 33.7401C29.1343 30.7633 26.0152 24.5245 25.5144 18.8022C25.3835 17.3066 23.8172 13.2016 19.2675 13.0058C15.7934 12.8563 13.6137 15.6103 13.0319 17.325C12.9986 17.4231 12.9201 17.5004 12.821 17.5305Z" fill="${THEME.yyPink[100]}"/><circle cx="17.6178" cy="18.2688" r="0.995689" fill="white"/></svg>`,
+        bubbleColor: THEME.yyPink[50],
+        textColor: THEME.gray[900],
+        side: 'left'
+    },
+    '小乌鸦': {
+        avatar: `<svg width="28" height="28" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M12.821 17.5305C10.709 18.17 9.68345 19.4423 9.22624 20.1359C9.11159 20.3099 9.21615 20.5428 9.42038 20.5839L12.67 21.2381C12.8291 21.2702 12.9328 21.4275 12.9084 21.5879C11.3004 32.1653 21.5275 36.7547 28.6638 33.0597C28.7443 33.018 28.8408 33.0139 28.9245 33.0487C32.8032 34.6598 35.967 34.5662 37.8217 34.3099C38.131 34.2671 38.1505 33.841 37.855 33.7401C29.1343 30.7633 26.0152 24.5245 25.5144 18.8022C25.3835 17.3066 23.8172 13.2016 19.2675 13.0058C15.7934 12.8563 13.6137 15.6103 13.0319 17.325C12.9986 17.4231 12.9201 17.5004 12.821 17.5305Z" fill="${THEME.yyPink[100]}"/><circle cx="17.6178" cy="18.2688" r="0.995689" fill="white"/></svg>`,
+        bubbleColor: THEME.yyPink[50],
+        textColor: THEME.gray[900],
+        side: 'left'
+    }
+};
+/**
+ * Authors that should use first-character avatar instead of SVG
+ */
+export const FIRST_CHAR_AVATAR_AUTHORS = new Set(['小乌鸦']);

package/dist/const/styles.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Main component styles
+ */
+export declare const MAIN_STYLES: string;
+/**
+ * Empty state styles
+ */
+export declare const EMPTY_STYLES: string;
+/**
+ * Fallback styles for when custom elements are not supported
+ */
+export declare const FALLBACK_STYLES: string;