@slimreviews/slimreviews-widget
v1.0.5
Published
Slim Reviews embeddable widget for collecting reviews.
Maintainers
Readme
@slimreviews/slimreviews-widget
Embeddable JavaScript widget for Slim Reviews, designed to help creators, small businesses, and projects collect meaningful feedback with minimal friction.
Features
- Lightweight and easy to embed.
- Collects reviews directly from your website.
- Works with your Slim Reviews projects.
- Minimal setup required.
Installation
Install via npm:
npm install @slimreviews/slimreviews-widgetOr yarn:
yarn add @slimreviews/slimreviews-widgetUsage
Import the widget in your project:
import SlimReviewsWidget from '@slimreviews/slimreviews-widget';
// Initialize the widget
SlimReviewsWidget.init({
projectId: 'YOUR_PROJECT_ID', // Required: your Slim Reviews project ID
container: '#widget-container', // Optional: CSS selector where the widget should mount
});Add a container in your HTML:
<div id="widget-container"></div>Requirements
- You must have a Slim Reviews project to activate the widget.
- Works in modern browsers with ES6 support.
Configuration
You can pass an options object to customize the widget:
| Option | Type | Description | Required |
| ----------- | ------ | ------------------------------------- | -------- |
| projectId | string | Your Slim Reviews project ID | Yes |
| container | string | CSS selector for the widget container | No |
License
MIT License. Free to use, modify, and distribute.
Contact
For support, questions, or feedback, reach out to us:
- Email: [email protected]
- Website / Contact Form: https://slimreviews.net/contact
