@salesforcedevs/docs-components 0.0.11-chat → 0.0.11-edit

package/lwc.config.json

@@ -12,6 +12,7 @@
         "doc/contentCallout",
         "doc/chat",
         "doc/doDont",
+        "doc/editFile",
         "doc/contentLayout",
         "doc/contentMedia",
         "doc/docXmlContent",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.0.11-chat",
+    "version": "0.0.11-edit",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

package/src/modules/doc/chat/README.md

@@ -0,0 +1,179 @@
+# Sliding Chat Component (doc-chat)
+
+A self-contained sliding chat component with a floating trigger button that can be embedded in any layout, perfect for customer support, documentation help, or any conversational interface.
+
+## Features
+
+- 🎯 **Sliding Component**: Slides in/out with smooth animations
+- 🔘 **Floating Trigger**: Built-in floating button to open chat (bottom-right corner)
+- 💬 **Real-time Chat**: Interactive messaging with typing indicators
+- 🎨 **Modern Design**: Clean, responsive interface with subtle animations
+- ⚙️ **Configurable**: Customizable title, placeholder, and assistant name
+- 📱 **Mobile Friendly**: Full-width on mobile devices
+- ♿ **Accessible**: ARIA labels and keyboard navigation
+- 🎭 **Storybook Ready**: Multiple story variations for testing
+
+## Basic Usage
+
+The component is completely self-contained with a built-in floating trigger button:
+
+```html
+<doc-chat
+    title="Customer Support"
+    placeholder="How can we help you today?"
+    assistant-name="Support Bot"
+    is-open="false"
+    show-timestamp="true"
+></doc-chat>
+```
+
+That's it! The component will automatically show a floating chat button in the bottom-right corner when closed, and slide in the chat interface when opened.
+
+## Properties
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `title` | String | `"Chat"` | Title displayed in the chat header |
+| `placeholder` | String | `"Type your message..."` | Placeholder text for input field |
+| `assistant-name` | String | `"Assistant"` | Name of the assistant/bot |
+| `disabled` | Boolean | `false` | Disables the chat functionality |
+| `show-timestamp` | Boolean | `false` | Shows timestamps on messages |
+| `is-open` | Boolean | `false` | Controls sidebar visibility |
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| `openChat()` | Opens the chat sidebar |
+| `closeChat()` | Closes the chat sidebar |
+
+## Events
+
+| Event | Description | Detail |
+|-------|-------------|--------|
+| `chatopened` | Fired when chat is opened | `{ opened: true }` |
+| `chatclosed` | Fired when chat is closed | `{ closed: true }` |
+
+## Integration Example
+
+### Simple Integration (Self-Contained)
+```html
+<!-- The component includes its own trigger button -->
+<doc-chat
+    title="Customer Support"
+    placeholder="How can we help you today?"
+    assistant-name="Support Bot"
+    show-timestamp="true"
+    is-open="false"
+></doc-chat>
+```
+
+### Advanced Integration (With Custom Triggers)
+```html
+<!-- Optional: Custom trigger button -->
+<button id="chat-trigger" onclick="openSupportChat()">
+    💬 Need Help?
+</button>
+
+<!-- Chat component -->
+<doc-chat
+    id="support-chat"
+    title="Customer Support"
+    placeholder="How can we help you today?"
+    assistant-name="Support Bot"
+    show-timestamp="true"
+    is-open="false"
+></doc-chat>
+```
+
+### JavaScript
+```javascript
+// Optional: Custom trigger function
+function openSupportChat() {
+    const chat = document.getElementById('support-chat');
+    chat.openChat();
+}
+
+// Listen for chat events
+document.getElementById('support-chat').addEventListener('chatclosed', (event) => {
+    console.log('Chat was closed');
+});
+
+document.getElementById('support-chat').addEventListener('chatopened', (event) => {
+    console.log('Chat was opened');
+});
+```
+
+## Styling
+
+The component uses CSS custom properties for easy theming:
+
+```css
+doc-chat {
+    --chat-width: 400px;
+    --chat-z-index: 1000;
+    --chat-transition-duration: 0.3s;
+    --chat-header-bg: #f8f9fa;
+    --chat-primary-color: #0066cc;
+    --chat-border-color: #e0e0e0;
+}
+```
+
+## Responsive Behavior
+
+- **Desktop**: Fixed width component (400px)
+- **Tablet**: Full width component
+- **Mobile**: Full width component
+
+## Accessibility
+
+- ARIA labels for screen readers
+- Keyboard navigation support
+- High contrast mode support
+- Reduced motion preferences respected
+
+## Assistant Response Simulation
+
+The component includes a built-in response simulation system that responds to:
+
+- **Greetings**: "Hello", "Hi" → Friendly greeting
+- **Help requests**: "Help" → Assistance offer
+- **Documentation**: "Documentation", "Docs" → Navigation help
+- **General messages**: Contextual responses
+
+### Replacing with Real API
+
+To integrate with a real chat API, replace the `simulateAssistantResponse` method:
+
+```javascript
+// Replace this method in your extended component
+simulateAssistantResponse(userMessage) {
+    // Call your chat API
+    fetch('/api/chat', {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ message: userMessage })
+    })
+    .then(response => response.json())
+    .then(data => {
+        this.addMessage(data.response, 'assistant');
+    });
+}
+```
+
+## Browser Support
+
+- Chrome 80+
+- Firefox 72+
+- Safari 13+
+- Edge 80+
+
+## Examples
+
+Check out the Storybook examples for various use cases:
+
+- **Default**: Basic chat setup
+- **With Timestamps**: Shows message timestamps
+- **Interactive Demo**: Fully functional example
+- **Mobile View**: Mobile device simulation
+- **Chat Trigger Example**: Integration patterns