Svelte feedback widget

Installation

npm install @happyreact/svelte 

Usage

First, you need to create a Happy React project. You will get a token to connect the widget with Happy React. There you can change project settings, add domains to the whitelist, or see statistics.

SvelteKit extra setup

1. Must exclude @happyreact/svelte from optimize dependencies by Vite

// vite.config.ts
const config: UserConfig = {
  [...]
  optimizeDeps: {
    exclude: ['@happyreact/svelte']
  }
};

2. Every page with widget must have csr enabled

// src/routes/+page.ts
export const csr = true;

Both ssr and prerender doesn't impact the work of the widget. With the above setup, you can follow this guide.

Displaying widget with basic styling

This code lets you add the widget to your website with the basic styling that comes with the package.

<!-- FeedbackWidget.svelte -->
 
<script>
  import { Widget } from "@happyreact/svelte";
  import '@happyreact/svelte/theme.css';
</script>
 
<Widget token="[token]" resource="users-happiness" />

• [token] - project token, find it in project settings
• users-happiness - unique identifier of a resource

Custom styles using Global CSS

Use this if your application allows importing global styles. You can use default classes to style widget elements. Please see Happy React styling guide for more about styling.

<!-- FeedbackWidget.svelte -->
 
<script>
  import { Widget } from "@happyreact/svelte";
</script>
 
<Widget token="[token]" resource="users-happiness" />
 
<style>
  :global(.hr-container) {}
 
  :global(.hr-reaction) {}
</style>

Custom styles using classes

Use this with Module CSS. Import styles as a variable and assign them using classes property. This can let you add class to different elements of the widget. Please see Happy React styling guide for more about styling.

<!-- FeedbackWidget.svelte -->
 
<script>
  import { Widget } from "@happyreact/svelte";
  import styles from './FeedbackWidget.module.css';
</script>
 
<Widget
  token="[token]"
  resource="users-happiness"
  classes={{
    container: styles.container,
    reaction: styles.reaction
  }}
/>

And here is our FeedbackWidget.module.css file:

/* FeedbackWidget.module.css */
 
.container {
}
 
.reaction {
}

Reacting to user events

Right now you can use two events:

• onReaction - fire after user reaction
• onReactionsLimitReached - fire after the user reach the limit of reactions

<!-- FeedbackWidget.svelte -->
 
<script>
  import { Widget } from "@happyreact/svelte";
 
  function handleReaction(data) {
    console.log('Reaction clicked with data', data);
  }
 
  function handleReactionsLimitReached() {
    console.log('Reactions limit reached');
  }
</script>
 
<Widget
  token="[token]"
  resource="users-happiness"
  onReaction={handleReaction}
  onReactionsLimitReached={handleReactionsLimitReached}
/>

API

The Widget component lets you display a feedback widget with reactions and settings. Control these settings on Happy React dashboard (opens in a new tab).

Required props

Optional props