Getting Started
Features
Complete list of TheWebRatings features and capabilities
Core Features
Star Rating System
- 5-star rating interface with hover effects and labels (Poor, Fair, Good, Great, Excellent)
- Visual indicator for rating selection
- Required rating before submission
Text Review Collection
- Multi-line textarea for detailed reviews (20–1000 characters)
- Minimum length validation before submit is enabled
- Character counter with validation states
User Management
- Create User - Explicitly identify users with email/name via
open(email, name) - Auto-Detection - Automatically detect users from:
- HTML forms (email/name inputs)
- localStorage (common user data keys)
- Cookies (auth cookies)
- Global variables (window.user, etc.)
- URL parameters
- User Caching - Cache user data to reduce API calls
- No Anonymous Reviews - Prevents spam by requiring user identification
- Email Verification (OTP) - Secure email verification via OTP for new users and significant review updates
- 6-digit segmented OTP input with auto-advance and paste support
- Rate-limited resend (configurable, default 30 seconds)
- Automatic OTP sending on user creation
- Required for editing or deleting existing reviews
Auto-Prompt
- Session-based auto-trigger — the widget automatically opens after the user has visited your app across 3 sessions (configurable). No button click or code needed.
- Intelligent backoff on dismissal (4 → 8 sessions → permanent stop after 3 dismissals)
- Respects completed reviews — never re-prompts users who have already reviewed
- Waits for page visibility (5 seconds default) to avoid accidental triggers
- Works alongside manual
open()— both methods are fully independent - See Auto-Prompt for full details.
Advanced Features
Existing Review Management
- View Previous Reviews - Show users their existing review
- Edit Reviews - Update rating and review text
- Delete Reviews - Remove a submitted review
- OTP Verification for Updates - Email verification required for edits and deletes
Offline Fallback
- Local storage fallback for failed submissions
- User still sees the success screen so the experience stays positive
- Failed submissions are stored locally with metadata for potential manual retry
Note: The widget does not automatically retry when the connection is restored. It stores the submission locally and shows the success screen. Listen to
rating:submittedto confirm when a rating was successfully sent to the server.
Success Experience
- Inline Success Screen - Green checkmark animation shown inside the bottom sheet
- Done Button - User explicitly closes the sheet after seeing the success state
- Edit/Delete Success - Separate inline screens for update and delete confirmations
Event System
- Comprehensive event tracking for lifecycle, user actions, and submissions
- Listen to modal events, form interactions, and submission status
- Custom event handlers with
on()andoff()methods
Customization Features
Styling
- Colors: Button, textarea, stars, and modal (background/backdrop) via
init({ colors: { ... } }). See Configuration Options. - Bottom sheet and widget UI follow the theme (light/dark).
Configuration
- Platform detection (web, iOS, Android)
- API endpoint configuration
- Custom authentication types
- Debug mode for development
- Features:
offline,retry,analytics(all optional toggles ininit({ features: { ... } })).
Note: Custom copy (modal title, button text, terms, success messages) and branding (logo, custom typography) are not yet configurable in the current widget release.
Integration Features
Multiple Trigger Methods
- Programmatic trigger (
TheWebRatings.open()) - Session-based auto-prompt (opens after configurable number of visits)
- Custom event listeners
Framework Support
- Works with any JavaScript framework — vanilla HTML, React, Vue, Angular, Next.js, and more
- No framework-specific dependencies required
Responsive Design
- Mobile-optimized bottom sheet layout
- Touch-friendly interactions
- Adaptive sizing (420px max on desktop, full-width on mobile)
Developer Features
Event-Based Tracking
- Listen to
rating:submitted,widget:closed,user:created, and other events - Build custom analytics, reward systems, or notifications on top of the event system
API Management
- User creation and retrieval
- Rating submission, updates, and deletion
- User cache management