react-visual-feedback 1.2.1 → 1.3.0

package/README.md

@@ -6,21 +6,21 @@ A powerful, visual feedback collection tool for React applications with an integ
 
 ### Feedback Collection
 - 🎯 Visual element selection with hover highlighting
-- 📸 Automatic screenshot capture of selected elements with perfect CSS rendering
-- 📝 Feedback form with rich context
+- 📸 Automatic screenshot capture with perfect CSS rendering
+- 📝 Rich feedback form with context
 - ⚡ Lightweight and performant
 - 🎨 Works with any CSS framework (Tailwind, Bootstrap, Material-UI, etc.)
-- ⌨️ Keyboard shortcuts (Ctrl+Q to activate, Esc to cancel, Ctrl+Enter to submit)
+- ⌨️ Keyboard shortcuts (Ctrl+Q to activate, Esc to cancel)
 - 🌓 Dark mode support
 
-### Feedback Dashboard (New!)
-- 📊 **Professional dashboard** with localStorage or custom data source
-- 👨‍💻 **Developer mode** with full technical details
-- 👤 **User mode** for simplified feedback view
-- 🏷️ **Status management** with 7 professional status options
-- ✅ **Custom dropdown** with smooth animations
-- 🔒 **Permission system** - Users can only view, developers can manage
-- 🔄 **Status change callbacks** for database synchronization
+### Feedback Dashboard
+- 📊 Professional dashboard with localStorage or custom data source
+- 👨‍💻 Developer mode with full technical details
+- 👤 User mode for simplified feedback view
+- 🏷️ Status management with 7 professional status options
+- 💬 Status change modal with developer comments
+- 🔒 Permission system - Users can only view, developers can manage
+- 🔄 Status change callbacks for database synchronization
 - ⌨️ Dashboard keyboard shortcut (Ctrl+Shift+Q)
 
 ## Installation
@@ -89,7 +89,6 @@ function FeedbackButtons() {
 
 function App() {
   const handleFeedbackSubmit = async (feedbackData) => {
-    console.log('Feedback received:', feedbackData);
     await fetch('/api/feedback', {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
@@ -97,13 +96,12 @@ function App() {
     });
   };
 
-  const handleStatusChange = async ({ id, status }) => {
-    console.log('Status changed:', { id, status });
-    // Update your database
+  const handleStatusChange = async ({ id, status, comment }) => {
+    // Update your database with status and developer comment
     await fetch(`/api/feedback/${id}/status`, {
       method: 'PATCH',
       headers: { 'Content-Type': 'application/json' },
-      body: JSON.stringify({ status })
+      body: JSON.stringify({ status, comment })
     });
   };
 
@@ -125,9 +123,7 @@ function App() {
 export default App;
 ```
 
-## Dashboard Features
-
-### Status Options
+## Status Options
 
 The dashboard includes 7 professional status options:
 
@@ -135,44 +131,11 @@ The dashboard includes 7 professional status options:
 |--------|-------|-------------|
 | **Reported** 🔴 | Red | Initial feedback submission |
 | **Opened** 🟠 | Amber | Acknowledged and under review |
-| **Doing it** 🔵 | Blue | Actively being worked on |
+| **In Progress** 🔵 | Blue | Actively being worked on |
 | **Resolved** 🟢 | Green | Fixed and ready |
 | **Released** 🟣 | Purple | Deployed to production |
 | **Blocked** 🔴 | Red | Waiting on dependencies |
-| **Won't do** ⚪ | Gray | Not planned for implementation |
-
-### Developer vs User Mode
-
-#### Developer Mode (`isDeveloper={true}`)
-- ✅ View all technical details (element info, CSS, viewport, user agent)
-- ✅ Change feedback status
-- ✅ Delete feedback items
-- ✅ Full control over feedback management
-
-#### User Mode (`isDeveloper={false}`)
-- ✅ View feedback submissions
-- ✅ See current status (read-only)
-- ❌ Cannot change status
-- ❌ Cannot delete items
-- Perfect for product managers and stakeholders
-
-### Data Persistence
-
-The dashboard supports two modes:
-
-1. **localStorage** (default) - Automatic persistence in browser
-2. **Custom data source** - Pass your own data via `dashboardData` prop
-
-```jsx
-// Using localStorage (automatic)
-<FeedbackProvider dashboard={true}>
-
-// Using custom data source
-<FeedbackProvider
-  dashboard={true}
-  dashboardData={yourFeedbackArray}
->
-```
+| **Won't Fix** ⚪ | Gray | Not planned for implementation |
 
 ## API Reference
 
@@ -181,7 +144,7 @@ The dashboard supports two modes:
 | Prop | Type | Required | Default | Description |
 |------|------|----------|---------|-------------|
 | `onSubmit` | `(feedbackData) => Promise<void>` | Yes | - | Callback when feedback is submitted |
-| `onStatusChange` | `({ id, status }) => void` | No | - | Callback when status changes |
+| `onStatusChange` | `({ id, status, comment }) => void` | No | - | Callback when status changes (includes optional developer comment) |
 | `children` | `ReactNode` | Yes | - | Your app components |
 | `dashboard` | `boolean` | No | `false` | Enable dashboard feature |
 | `dashboardData` | `Array` | No | `undefined` | Custom feedback data (uses localStorage if undefined) |
@@ -189,8 +152,7 @@ The dashboard supports two modes:
 | `isUser` | `boolean` | No | `true` | Enable user mode (read-only) |
 | `userName` | `string` | No | `'Anonymous'` | User name for feedback submissions |
 | `userEmail` | `string` | No | `null` | User email for feedback submissions |
-| `isActive` | `boolean` | No | `undefined` | Control widget active state (controlled mode) |
-| `onActiveChange` | `(active: boolean) => void` | No | - | Callback when active state changes |
+| `mode` | `'light' \| 'dark'` | No | `'light'` | Theme mode |
 
 ### useFeedback Hook
 
@@ -211,7 +173,7 @@ const { isActive, setIsActive, setIsDashboardOpen } = useFeedback();
   feedback: string,
   userName: string,
   userEmail: string | null,
-  status: 'reported' | 'opened' | 'doingIt' | 'resolved' | 'released' | 'blocked' | 'wontDo',
+  status: 'reported' | 'opened' | 'inProgress' | 'resolved' | 'released' | 'blocked' | 'wontFix',
   timestamp: string, // ISO 8601 format
   url: string,
   elementInfo: {
@@ -220,24 +182,11 @@ const { isActive, setIsActive, setIsDashboardOpen } = useFeedback();
     className: string,
     selector: string,
     text: string,
-    position: {
-      x: number,
-      y: number,
-      width: number,
-      height: number
-    },
-    styles: {
-      backgroundColor: string,
-      color: string,
-      fontSize: string,
-      fontFamily: string
-    }
+    position: { x: number, y: number, width: number, height: number },
+    styles: { backgroundColor: string, color: string, fontSize: string, fontFamily: string }
   },
   screenshot: string, // Base64 encoded PNG
-  viewport: {
-    width: number,
-    height: number
-  },
+  viewport: { width: number, height: number },
   userAgent: string
 }
 ```
@@ -251,114 +200,19 @@ const { isActive, setIsActive, setIsDashboardOpen } = useFeedback();
 | `Esc` | Cancel/close feedback mode or dashboard |
 | `Ctrl+Enter` | Submit feedback (when form is open) |
 
-## Usage Examples
-
-### Example 1: Basic Feedback Collection
-
-```jsx
-import { FeedbackProvider, useFeedback } from 'react-visual-feedback';
-import 'react-visual-feedback/dist/index.css';
-
-function FeedbackButton() {
-  const { setIsActive } = useFeedback();
-  return <button onClick={() => setIsActive(true)}>Report Issue</button>;
-}
-
-function App() {
-  return (
-    <FeedbackProvider onSubmit={async (data) => {
-      await fetch('/api/feedback', {
-        method: 'POST',
-        body: JSON.stringify(data)
-      });
-    }}>
-      <YourApp />
-      <FeedbackButton />
-    </FeedbackProvider>
-  );
-}
-```
-
-### Example 2: Full Dashboard with Status Management
-
-```jsx
-function App() {
-  const [isDeveloper, setIsDeveloper] = useState(true);
-
-  const handleStatusChange = async ({ id, status }) => {
-    // Update database
-    await fetch(`/api/feedback/${id}`, {
-      method: 'PATCH',
-      body: JSON.stringify({ status })
-    });
-  };
-
-  return (
-    <FeedbackProvider
-      dashboard={true}
-      isDeveloper={isDeveloper}
-      onSubmit={handleFeedbackSubmit}
-      onStatusChange={handleStatusChange}
-      userName="Jane Smith"
-      userEmail="jane@company.com"
-    >
-      <YourApp />
-    </FeedbackProvider>
-  );
-}
-```
-
-### Example 3: Custom Data Source
-
-```jsx
-function App() {
-  const [feedbackData, setFeedbackData] = useState([]);
+## Developer vs User Mode
 
-  useEffect(() => {
-    // Load feedback from your API
-    fetch('/api/feedback')
-      .then(res => res.json())
-      .then(setFeedbackData);
-  }, []);
-
-  return (
-    <FeedbackProvider
-      dashboard={true}
-      dashboardData={feedbackData}
-      isDeveloper={true}
-      onStatusChange={async ({ id, status }) => {
-        // Update API
-        await fetch(`/api/feedback/${id}`, {
-          method: 'PATCH',
-          body: JSON.stringify({ status })
-        });
-        // Reload data
-        const updated = await fetch('/api/feedback').then(r => r.json());
-        setFeedbackData(updated);
-      }}
-    >
-      <YourApp />
-    </FeedbackProvider>
-  );
-}
-```
-
-## Styling
-
-The widget comes with default styles, but you can customize them:
-
-```css
-/* Feedback Collection */
-.feedback-overlay { /* Background overlay */ }
-.feedback-highlight { /* Element highlight */ }
-.feedback-tooltip { /* Element info tooltip */ }
-.feedback-modal { /* Feedback form modal */ }
-.feedback-backdrop { /* Modal backdrop */ }
+### Developer Mode (`isDeveloper={true}`)
+- ✅ View all technical details (element info, CSS, viewport, user agent)
+- ✅ Change feedback status with optional comments
+- ✅ Delete feedback items
+- ✅ Full control over feedback management
 
-/* Dashboard */
-.feedback-dashboard { /* Dashboard container */ }
-.feedback-dashboard-backdrop { /* Dashboard backdrop */ }
-```
+### User Mode (`isDeveloper={false}`)
+- ✅ View feedback submissions
+- ✅ See current status and developer responses
+- ❌ Cannot change status
+- ❌ Cannot delete items
 
 ## How It Works
 
@@ -376,10 +230,12 @@ The widget comes with default styles, but you can customize them:
 
 1. User opens dashboard (Ctrl+Shift+Q or programmatically)
 2. Dashboard displays all feedback submissions
-3. Developer can change status via dropdown
-4. Status change triggers `onStatusChange` callback
-5. Your backend updates the database
-6. Dashboard reflects the new status
+3. Developer clicks status dropdown and selects new status
+4. Status change modal appears for optional developer comment
+5. Developer adds comment (optional) and confirms
+6. `onStatusChange` callback triggered with `{ id, status, comment }`
+7. Your backend updates the database
+8. Dashboard reflects the new status
 
 ## Browser Support
 
@@ -388,22 +244,6 @@ The widget comes with default styles, but you can customize them:
 - ✅ Safari
 - ✅ Opera
 
-## Screenshot Capture
-
-Uses `html-to-image` with `html2canvas` fallback for:
-- ✅ Perfect CSS rendering
-- ✅ Tailwind, Bootstrap, Material-UI support
-- ✅ Gradients, shadows, modern CSS
-- ✅ High-resolution (2x pixel ratio)
-
-## Dependencies
-
-- React ^16.8.0 || ^17.0.0 || ^18.0.0
-- react-dom ^16.8.0 || ^17.0.0 || ^18.0.0
-- html-to-image ^1.11.13
-- html2canvas ^1.4.1
-- lucide-react ^0.263.1
-
 ## Local Development
 
 ```bash
@@ -425,21 +265,12 @@ npm run dev
 
 Visit `http://localhost:8080` to see the demo!
 
-## What's New in v1.2.0
-
-### Dashboard Feature
-- 📊 Complete feedback management dashboard
-- 👨‍💻 Developer/User mode with permission system
-- 🏷️ 7 professional status options with custom dropdown
-- 🔄 Status change callbacks for database sync
-- 💾 localStorage or custom data source support
-- 📅 Improved timestamp formatting (e.g., "21 Oct 2025 at 9:35 PM")
+## What's New in v1.3.0
 
-### UI Improvements
-- ✨ Smooth animations for status dropdown
-- 🎨 Professional minimal design
-- 🔒 Read-only status for users
-- 🗑️ Conditional delete permissions
+### Status Change with Comments
+- 💬 Developers can add optional comments when changing status
+- 📝 Comments are passed to `onStatusChange` callback
+- 👥 Comments visible to users as developer responses
 
 ## License
 
@@ -455,7 +286,7 @@ Report issues at: https://github.com/Murali1889/react-feedback-widget/issues
 
 ## Author
 
-**Murali**
+**Murali Vvrsn Gurajapu**
 Email: murali.g@hyperverge.co
 
 ---