Documentation

Learn how to integrate and customize the SaaS Feedback Widget in your application

Getting Started

Installation

npm install virmedilacra-widget

Basic Usage

Basic JavaScript Integration
import Virmedilacra from "virmedilacra-widget";

const widget = new Virmedilacra({
  appId: "your-app-id",
  theme: "light",
  userData: {
    id: "user123",
    email: "user@example.com",
    name: "John Doe",
    image: "https://example.com/avatar.jpg",
    isPaying: true
  }
});

widget.init();
Configuration Options

App ID

Your unique application identifier. You can find this in your dashboard.

appId: "Your App ID"
User Data Configuration

Provide user information to personalize the feedback experience and track feature requests by user.

User Data Structure
userData: {
  id: "unique-user-id",           // Required: Unique identifier
  email: "user@example.com",      // Required: User's email
  name: "John Doe",               // Optional: Display name
  image: "https://...",           // Optional: Avatar URL
  isPaying: true                  // Optional: Payment status
}

Required Fields

  • id - Unique user identifier
  • email - User's email address

Optional Fields

  • name - Display name for the user
  • image - Avatar image URL
  • isPaying - Whether user is a paying customer
Theming Options

Available Themes

light

Light theme with white background

dark

Dark theme with dark background

Usage Example

// Light theme (default)
theme: "light"

// Dark theme
theme: "dark"