@businessflow/reviews
v2.1.5
Published
Generic review and testimonial management utilities with customizable display components
Maintainers
Readme
@businessflow/reviews
Generic review and testimonial management utilities for React and NextJS applications.
Features
- ⭐ Star Ratings: Customizable star rating components
- 📝 Review Forms: Pre-built review submission forms
- 🎨 Display Components: Beautiful testimonial display layouts
- 🔒 Secure: Server-side API handling with reCAPTCHA
- 📱 Responsive: Mobile-friendly components
- 🎨 Customizable: Flexible styling and configuration
- 📝 TypeScript: Full type safety and IntelliSense support
Installation
npm install @businessflow/reviewsQuick Start
1. Create API Routes (NextJS App Router)
// app/api/reviews/featured/route.ts
import { createReviewHandler } from '@businessflow/reviews/server';
export const GET = createReviewHandler({
onFetch: async (params) => {
// Fetch from your database/API
const reviews = await fetchReviewsFromDB({
limit: params?.limit || 10,
featured: true
});
return reviews;
}
});
// app/api/reviews/submit/route.ts
export const POST = createReviewHandler({
onSubmit: async (data) => {
// Save to your database/API
const result = await saveReviewToDB(data);
return {
success: !!result.id,
reviewId: result.id,
message: 'Review submitted successfully'
};
},
recaptcha: {
secretKey: process.env.RECAPTCHA_SECRET_KEY!
}
});2. Display Testimonials
import { TestimonialsSection } from '@businessflow/reviews/react';
export default function HomePage() {
return (
<TestimonialsSection
limit={6}
layout="grid"
showRating={true}
autoRefresh={true}
/>
);
}3. Review Submission Form
import { ReviewForm } from '@businessflow/reviews/react';
export default function ReviewPage() {
return (
<ReviewForm
recaptcha={{ siteKey: process.env.NEXT_PUBLIC_RECAPTCHA_SITE_KEY! }}
onSuccess={(response) => console.log('Review submitted!', response)}
/>
);
}Documentation
License
MIT
