Skip to main content

​
Install

npm install @feedbackfun/js

​
Basic usage

Import and initialize the widget in your app’s entry point: 
import FeedbackfunWidget from '@feedbackfun/js';
import '@feedbackfun/js/dist/feedbackfun-widget.min.css';

const widget = new FeedbackfunWidget('YOUR_API_KEY', 'https://feedbackfun.com', {
  // optional config
});
Looking for framework-specific examples? See the React, Next.js, and Vue guides.

​
Constructor

new FeedbackfunWidget(
  apiKey: string,
  apiUrl?: string,    // default: "https://feedbackfun.com"
  config?: WidgetConfig
)
ParameterTypeRequiredDescription
apiKeystringYesYour project API key
apiUrlstringNoAPI base URL (default: https://feedbackfun.com)
configWidgetConfigNoWidget configuration options — see Configuration

​
TypeScript support

@feedbackfun/js ships with full TypeScript declarations: 
import FeedbackfunWidget, { WidgetConfig, UserConfig } from '@feedbackfun/js';

const config: WidgetConfig = {
  primaryColor: '#6366f1',
  displayMode: 'popover',
  user: {
    id: 'user_123',
    email: 'user@example.com',
    name: 'Jane Doe',
  },
};

const widget = new FeedbackfunWidget('YOUR_API_KEY', undefined, config);

​
Next steps

Configuration

See all available config options.

User identification

Link feedback to real user accounts.