@dharanidharansr/converge
v1.0.3
Published
A beautiful feedback SDK for React applications - Converge
Downloads
14
Maintainers
Readme
Converge
A beautiful and customizable feedback component for React applications. Collect, analyze, and act on user feedback - all in one place.
Features
- 🎯 One-line integration
- 🎨 Light and dark theme support
- 🔄 Draggable feedback button
- 📝 Customizable form fields
- 🔒 Firebase authentication support
- 💫 Smooth animations
- 🎭 Elegant UI components
Installation
npm install convergeQuick Start
import { ConvergeFeedback } from "converge";
import "converge/dist/converge.css";
function App() {
return (
<ConvergeFeedback
projectId="your-project-id"
firebaseUid="your-firebase-uid"
apiUrl="https://converge-pfv0.onrender.com" // Optional: defaults to production
theme="light" // or "dark"
/>
);
}Props
| Prop | Type | Required | Description | | ----------- | ----------------- | -------- | -------------------------------------------------------------- | | projectId | string | Yes | Your project ID from Converge dashboard | | firebaseUid | string | Yes | Firebase user ID for authentication | | apiUrl | string | No | Backend API URL (default: "https://converge-pfv0.onrender.com")| | theme | "light" | "dark" | No | Theme for the feedback component (default: "light") |
Usage
- Create a project in your Converge Dashboard
- Set up your feedback form with custom fields
- Copy your project ID and Firebase UID
- Add the component to your React app
- Start collecting feedback!
Form Field Types
- Text input
- Email input
- Multiple choice
- Slider
- Textarea
Example
import { ConvergeFeedback } from "converge";
import "converge/dist/converge.css";
function App() {
return (
<div>
<h1>My Awesome App</h1>
<ConvergeFeedback
projectId={import.meta.env.CONVERGE_PROJECT_ID}
firebaseUid={import.meta.env.FIREBASE_UID}
apiUrl="https://converge-pfv0.onrender.com"
theme="dark"
/>
</div>
);
}Browser Support
- Chrome (latest)
- Firefox (latest)
- Safari (latest)
- Edge (latest)
Support
For issues and feature requests, please visit our GitHub repository.
Learn More
For more information on how to use Converge, check out our documentation.
