react-feedback-surveys

Lightweight, customizable survey widgets to collect user feedback in React apps.

Introduction

react-feedback-surveys is a standalone, open-source (MIT) UI library — no backend, no hosting, no account required. Render the components, wire onScoreSubmit/onFeedbackSubmit to your own backend (or nowhere at all).

Want AI-generated insights, a hosted dashboard, and response storage without building your own backend? Check out feedback.tools — built by the same team.

Features

A single Survey component – the format (methodology, scale length, visual style) is configuration, not a different import
Ready-to-use survey formats – CSAT (2 or 5 points), CES (7 points), NPS (0–10)
Multiple scale styles – emoji, stars, numbers, thumbs
Flexible placement – embed inline or display as popup overlay
Follow-up feedback – optional text input or multiple choice responses
Optional email collection – close the loop by capturing a respondent's email when no user identity is known
Fully customizable – CSS variables and custom class names
Zero dependencies
TypeScript support

Survey Types

Survey covers three feedback methodologies, selected with the type prop. CSAT is the only one with a variable scale length, set via points:

CSAT (Customer Satisfaction Score): type="csat", 2-point or 5-point scale (points={2} or points={5})
NPS (Net Promoter Score): type="nps", fixed 0–10 scale
CES (Customer Effort Score): type="ces", fixed 7-point scale

Installation

1. Install

npm i react-feedback-surveys
# or
yarn add react-feedback-surveys

2. Styles

import 'react-feedback-surveys/index.css';

Survey Component

Every format is reached through the same Survey import — type and points pick the methodology and scale length, scaleStyle picks the visual style. See Format Props for the full matrix of valid type/points/scaleStyle combinations.

CSAT (Customer Satisfaction Score)

Surveys to ask users about their overall satisfaction, or about a specific feature or flow.

Example questions:

"How satisfied are you with our product?"
"Was this search helpful?"
"Are you satisfied with the checkout process?"

import { Survey } from 'react-feedback-surveys';
import 'react-feedback-surveys/index.css';

<Survey
  type="csat"
  points={5}
  scaleStyle="emoji"
  question="How would you rate your satisfaction with our product?"
  minLabel="Very unsatisfied"
  maxLabel="Very satisfied"
  responseType="text"
  textQuestion="We'd love to hear your thoughts — what can we improve?"
  textButtonSendLabel="Send"
  textButtonSkipLabel="Skip"
  thankYouMessage="Thanks for your feedback!"
  onScoreSubmit={({ value }) => {/* ... */}}
  onFeedbackSubmit={({ value, text }) => {/* ... */}}
/>

<Survey
  type="csat"
  points={2}
  scaleStyle="thumbs"
  question="Are you satisfied with the result?"
  responseType="text"
  textQuestion="We'd love to hear your thoughts — what can we improve?"
  textButtonSendLabel="Send"
  textButtonSkipLabel="Skip"
  thankYouMessage="Thank you for your feedback!"
  onScoreSubmit={({ value }) => {/* ... */}}
  onFeedbackSubmit={({ value, text }) => {/* ... */}}
/>

points={5} → scaleStyle: emoji | numbers | stars. points={2} → scaleStyle: emoji | thumbs.

NPS (Net Promoter Score)

Surveys to ask users if they'd recommend your product. Fixed 0–10 scale — no points prop needed.

Example questions:

"How likely are you to recommend us to a friend or colleague?"
"On a scale of 0-10, would you recommend our service?"
"How likely are you to recommend this product to others?"

import { Survey } from 'react-feedback-surveys';
import 'react-feedback-surveys/index.css';

<Survey
  type="nps"
  scaleStyle="numbers"
  question="How likely are you to recommend our product/service to a friend or colleague?"
  minLabel="Very unlikely"
  maxLabel="Very likely"
  responseType="text"
  textQuestion="We'd love to hear your thoughts — what can we improve?"
  textButtonSendLabel="Send"
  textButtonSkipLabel="Skip"
  thankYouMessage="Thank you for your feedback!"
  onScoreSubmit={({ value }) => {/* ... */}}
  onFeedbackSubmit={({ value, text }) => {/* ... */}}
/>

scaleStyle: numbers.

CES (Customer Effort Score)

Surveys to ask users how easy it is to use your product. Fixed 7-point scale — no points prop needed.

Example questions:

"How easy was it to complete your task?"
"How much effort did it take to resolve your issue?"
"How easy was it to sign up for an account?"

import { Survey } from 'react-feedback-surveys';
import 'react-feedback-surveys/index.css';

<Survey
  type="ces"
  scaleStyle="numbers"
  question="How easy was it to complete your task?"
  minLabel="Very difficult"
  maxLabel="Very easy"
  responseType="text"
  textQuestion="We'd love to hear your thoughts — what can we improve?"
  textButtonSendLabel="Send"
  textButtonSkipLabel="Skip"
  thankYouMessage="Thank you for your feedback!"
  onScoreSubmit={({ value }) => {/* ... */}}
  onFeedbackSubmit={({ value, text }) => {/* ... */}}
/>

scaleStyle: numbers.

Layout Components

Popup

The <Popup> component wraps survey widgets in a fixed overlay that slides in from the screen edge. It includes positioning, animations, and a close button for easy dismissal.

Usage

import { Popup, Survey } from 'react-feedback-surveys';
import 'react-feedback-surveys/index.css';

<Popup
  animated
  classNames={{
    base: 'custom-popup-base',
    content: 'custom-popup-content',
    close: 'custom-popup-close'
  }}
  placement="bottomRight"
  onClose={() => console.log('Closed')}
>
  <Survey
    type="csat"
    points={5}
    scaleStyle="stars"
    question="How would you rate your satisfaction?"
    onScoreSubmit={({ value }) => {/* ... */}}
  />
</Popup>

Props

Prop	Type	Required	Default	Description
`placement`	`'topLeft' \| 'topRight' \| 'bottomRight' \| 'bottomLeft'`	-	`'bottomRight'`	Position of the popup relative to the screen edges.
`animated`	`boolean`	-	`true`	Enables a fade-in animation when the popup appears.
`className`	`string`	-	-	Additional CSS class name for the popup container.
`classNames`	`{ base?: string; content?: string; close?: string }`	-	-	Optional class names for internal popup elements.
`children`	`React.ReactNode`	-	-	Content to render inside the popup (typically a survey component).
`onClose`	`() => void`	-	-	Callback fired when the close button is clicked.

For more examples, check out the Storybook stories under widgets/Survey (grouped by CSAT/NPS/CES in the sidebar).

Surface

The <Surface> component is a basic container wrapper that provides consistent styling for survey content. It's used internally by the Popup component and can be used standalone to display surveys with a card-like appearance.

The Surface component provides:

Background color with depth/elevation (box shadow)
Rounded corners (controlled via --ft-surface-radius)
Responsive padding that adapts to mobile devices

Usage

import { Surface, Survey } from 'react-feedback-surveys';
import 'react-feedback-surveys/index.css';

<Surface className="custom-surface">
  <Survey
    type="csat"
    points={5}
    scaleStyle="stars"
    question="How would you rate your satisfaction?"
    onScoreSubmit={({ value }) => {/* ... */}}
  />
</Surface>

Props

Prop	Type	Required	Default	Description
`className`	`string`	-	-	Additional CSS class name for the surface container.
`children`	`React.ReactNode`	-	-	Content to render inside the surface.

The Surface component uses the --ft-surface-padding, --ft-surface-padding-mobile, and --ft-surface-radius CSS variables for responsive padding and border radius.

Props

Most props are shared across every survey format. type (and points, for CSAT) select the format; scaleStyle picks its visual style — see Format Props.

Shared Props

Prop	Type	Required	Description
`classNames`	`ClassNamesConfig` (see below)	-	Optional class names to target internal parts.
`dir`	`'ltr' \| 'rtl' \| 'auto'`	-	Text direction for RTL/LTR language support.
`question`	`string`	required	Main survey question displayed on the first screen.
`minLabel`	`string`	-	Left label for the scale.
`maxLabel`	`string`	-	Right label for the scale.
`responseType`	`null \| 'text' \| 'choices'`	-	Enables optional follow-up feedback.
`textQuestion`	`string`	-	Follow-up question displayed when `responseType` is defined.
`textButtonSendLabel`	`string`	-	Submit label for the feedback screen.
`textButtonSkipLabel`	`string`	-	Skip label for the feedback screen.
`choiceOptions`	`string[] \| null`	-	Predefined choices (when `responseType === 'choices'`).
`thankYouMessage`	`string`	required	Message shown after submission.
`collectContact`	`boolean`	-	Enables an optional email collection step before the success screen.
`userId`	`string`	-	Existing user identity. When provided, the email collection step is skipped.
`contactQuestion`	`string`	-	Question shown on the email collection screen.
`contactSubtext`	`string`	-	Descriptive text shown above the email input.
`contactButtonSendLabel`	`string`	-	Submit label for the email collection screen.
`contactButtonSkipLabel`	`string`	-	Skip label for the email collection screen.

ClassNamesConfig Type

interface ClassNamesConfig {
  base?: {
    base?: string;       // The outer widget container
    head?: string;       // Header row containing title and close button
    title?: string;      // The heading that shows main/feedback/success text
    body?: string;       // Main content region (rating scale, feedback form or success)
    rating?: string;     // Additional class applied when rating screen is active
    feedback?: string;   // Additional class applied when feedback screen is active
    contact?: string;    // Additional class applied when email collection screen is active
    success?: string;    // Additional class applied when success screen is active
    close?: string;      // Close button
  };
  scale?: {
    base?: string;       // Container around the scale style
    list?: string;       // Wrapper for the interactive items (emoji/stars/numbers)
    button?: string;     // Each clickable item in the scale
    icon?: string;       // Icon inside a scale button (emoji, stars)
    score?: string;      // Number inside a scale button (for numeric variants)
    labels?: string;     // Left/Right labels displayed under the scale
  };
}

Shared Events

Prop	Type	Required	Description
`onScoreSubmit`	`(payload: ScorePayload) => void \| Promise<void>`	-	Fires immediately when a score is selected, before any follow-up feedback screen. Captures the raw rating.
`onFeedbackSubmit`	`(payload: FeedbackPayload) => void \| Promise<void>`	-	Fires when feedback is submitted. Includes the selected score and the user's text(s).
`onContactSubmit`	`(payload: ContactPayload) => void \| Promise<void>`	-	Fires when the respondent submits an email on the optional email collection screen. Not called when the step is skipped or not shown.

Event Payload Types:

type ScorePayload = { value: number };
type FeedbackPayload = { value: number; text?: string | string[] };
type ContactPayload = { value?: number; text?: string | string[]; email: string };

Event behavior

`onScoreSubmit`

Invoked immediately when the user selects a score on the rating scale — this callback runs before any optional follow-up screen is shown.
Use it to persist the rating instantly.
The actual value returned depends on the survey type:

CSAT2: 0–1
CSAT5: 1–5
CES7: 1–7
NPS10: 0–10

`onFeedbackSubmit`

Invoked when the user completes the follow-up step and submits their feedback (only applies when responseType is text or choices).
This callback provides both the original score and the user's input.

The feedback step is always optional: respondents can submit feedback or skip it via the textButtonSkipLabel button (or by submitting with empty input), and either action advances to the next screen. onFeedbackSubmit only fires when feedback text or choices are actually submitted; it is not called when the step is skipped.

Arguments:

value: number — the same score previously passed to onScoreSubmit
text: string | string[] — depends on responseType:
- text: a single text comment
- choices: an array of selected options (may include a free-text comment if enabled)

Important
You should listen to both onScoreSubmit and onFeedbackSubmit.
A user may select a score but abandon the follow-up screen (close the widget, navigate away, refresh, etc.).
Handling both events ensures you capture at least the rating even when additional feedback is not provided — and still receive extended data when it is.

`onContactSubmit`

When collectContact is true and no userId is provided, an optional email collection screen is shown after the rating/feedback screens and before the success screen. This lets you "close the feedback loop" by capturing an email for a respondent whose identity isn't already known to the host app.

If userId is provided, the step is skipped entirely — the widget assumes identity is already known.
The step is always optional: respondents can submit an email or skip it, and either action advances to the success screen.
onContactSubmit only fires when the respondent actually submits an email; it is not called when the step is skipped or not shown.

Arguments:

value?: number — the selected rating, if any.
text?: string | string[] — the submitted feedback text or choices, if any.
email: string — the email address entered by the respondent.

<Survey
  type="csat"
  points={5}
  scaleStyle="numbers"
  question="How would you rate your satisfaction with our product?"
  responseType="text"
  textQuestion="We'd love to hear your thoughts — what can we improve?"
  thankYouMessage="Thanks for your feedback!"
  collectContact
  userId={currentUser?.id}
  contactQuestion="Mind sharing your email so we can follow up?"
  contactButtonSendLabel="Submit"
  contactButtonSkipLabel="Skip"
  onScoreSubmit={({ value }) => {/* ... */}}
  onFeedbackSubmit={({ value, text }) => {/* ... */}}
  onContactSubmit={({ value, text, email }) => {/* attribute the feedback to this email */}}
/>

Format Props

Prop	Type	Required	Description
`type`	`'csat'` \| `'nps'` \| `'ces'`	required	Survey methodology. Determines the scale range and which `scaleStyle`/`points` combinations are valid.
`points`	`2` \| `5`	required for `type="csat"`; not used otherwise	Number of points on the scale. `nps` is a fixed 0–10 scale and `ces` a fixed 1–7 scale, so neither takes `points`.

Scale Style Options

Valid scaleStyle values depend on type (and points, for CSAT):

`type`	`points`	Scale range	Valid `scaleStyle`
`csat`	`5`	1–5	`'emoji'` (5 emotion levels) \| `'numbers'` \| `'stars'` (1–5 stars)
`csat`	`2`	0–1	`'emoji'` (happy/sad faces) \| `'thumbs'` (thumbs up/down)
`ces`	—	1–7	`'numbers'`
`nps`	—	0–10	`'numbers'`

Invalid combinations (e.g. type="ces" with scaleStyle="stars") are rejected at the type level.

Styling

The package ships with minimal default styles. To use them:

import 'react-feedback-surveys/index.css';

CSS Variables

You can override colors and fonts via CSS variables:

:root {
  /* Main text color for headings and body text */
  --ft-color-text: 30 8% 14%;

  /* Background color for survey widgets */
  --ft-color-bg: 0 0% 100%;

  /* Muted text color for labels and secondary content */
  --ft-color-muted: 222 11% 46%;

  /* Error color for validation messages */
  --ft-color-error: 32 95% 44%;

  /* Border color for inputs and containers */
  --ft-color-border: 214 14% 83%;

  /* Outline color for focused interactive elements */
  --ft-color-outline: 218 14% 65%;

  /* Shadow color for depth and elevation effects */
  --ft-color-shadow: 0 0% 0%;

  /* Background color for input controls and buttons */
  --ft-color-control: 214 20% 96%;

  /* Z-index for popup overlay positioning */
  --ft-popup-z-index: 49;

  /* Inline-end offset for survey head inside popups (right padding in LTR, left in RTL) */
  /* Automatically set to 32px inside Popup to prevent title overlap with close button */
  /* Set to 0 by default for inline surveys */
  --ft-popup-head-offset: 0;

  /* Padding for Surface component container (desktop) */
  --ft-surface-padding: 24px;

  /* Padding for Surface component container on mobile devices (max-width: 400px) */
  --ft-surface-padding-mobile: 20px;

  /* Border radius for Surface container, inputs, and submit button */
  --ft-surface-radius: 8px;
}

/* Use with hsl() function: */
/* color: hsl(var(--ft-color-text)); */
/* background: hsl(var(--ft-color-bg)); */
/* box-shadow: 0 0 10px hsl(var(--ft-color-shadow) / 20%); */

Dark Theme Example

The library uses CSS variables for all colors, making it easy to implement custom themes including dark mode. The library itself is theme-agnostic - you control how to override the variables.

Example dark theme color palette:

Here's an example of dark theme colors that work well with the survey components:

/* Example: Class-based dark theme */
.dark {
  --ft-color-text: 210 11% 88%;
  --ft-color-bg: 220 13% 13%;
  --ft-color-muted: 214 10% 60%;
  --ft-color-error: 14 90% 62%;
  --ft-color-border: 217 10% 28%;
  --ft-color-outline: 216 12% 45%;
  --ft-color-shadow: 0 0% 0%;
  --ft-color-control: 218 12% 19%;
}

/* Alternative: Using media query */
@media (prefers-color-scheme: dark) {
  :root {
    --ft-color-text: 210 11% 88%;
    --ft-color-bg: 220 13% 13%;
    /* ... other variables */
  }
}

/* Alternative: Data attribute based */
[data-theme="dark"] {
  --ft-color-text: 210 11% 88%;
  --ft-color-bg: 220 13% 13%;
  /* ... other variables */
}

Implementation example with React:

import { Survey } from 'react-feedback-surveys';
import 'react-feedback-surveys/index.css';
import { useEffect } from 'react';

function App() {
  useEffect(() => {
    // Example: Apply theme based on system preference
    const isDarkMode = window.matchMedia('(prefers-color-scheme: dark)').matches;

    if (isDarkMode) {
      document.documentElement.classList.add('dark');
    }

    // Listen for system preference changes
    const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
    const handleChange = (e: MediaQueryListEvent) => {
      document.documentElement.classList.toggle('dark', e.matches);
    };

    mediaQuery.addEventListener('change', handleChange);
    return () => mediaQuery.removeEventListener('change', handleChange);
  }, []);

  return (
    <Survey
      type="csat"
      points={5}
      scaleStyle="emoji"
      question="How satisfied are you with our product?"
      onScoreSubmit={({ value }) => console.log('Score:', value)}
    />
  );
}

Manual theme toggle:

// Toggle between light and dark
function toggleTheme() {
  document.documentElement.classList.toggle('dark');
}

// Set specific theme
function setTheme(theme: 'light' | 'dark') {
  document.documentElement.classList.toggle('dark', theme === 'dark');
}

Notes:

The library only uses CSS variables - how you define them is up to you
Choose any approach: class-based, data attributes, media queries, or CSS-in-JS
The example colors provide WCAG AA compliant contrast ratios
Emoji and icon colors remain unchanged regardless of theme

Or wrap the survey in your own class and target the generated markup.

For deeper customization strategies, see the section below.

Custom Classes

Survey accepts a classNames prop with two optional groups: base (outer shell) and scale (the interactive rating UI). Pass your own class names to override styles without relying on internal selectors.

When is this useful?

Apply your design system spacing, typography or colors
Adjust layout (e.g., make the scale full-width, change gaps)
Restyle scale items (buttons, icons, numbers) consistently

Reference: available keys

Key	Applies to
`base.base`	The outer widget container
`base.head`	Header row containing title and close button
`base.title`	The heading that shows main/feedback/success text
`base.body`	Main content region (rating scale, feedback form or success)
`base.rating`	Additional class applied when rating screen is active
`base.feedback`	Additional class applied when feedback screen is active
`base.contact`	Additional class applied when email collection screen is active
`base.success`	Additional class applied when success screen is active
`base.close`	Close button
`scale.base`	Container around the scale style
`scale.list`	Wrapper for the interactive items (emoji/stars/numbers)
`scale.button`	Each clickable item in the scale
`scale.icon`	Icon inside a scale button (emoji, stars)
`scale.score`	Number inside a scale button (for numeric variants)
`scale.labels`	Left/Right labels displayed under the scale

Example: customizing a Survey widget

import { Survey } from 'react-feedback-surveys';
import 'react-feedback-surveys/index.css';

<Survey
  classNames={{
    base: {
      base: 'my-survey-base',
      body: 'my-survey-body',
      rating: 'my-rating-screen',
      feedback: 'my-feedback-screen',
      success: 'my-success-screen',
    },
    scale: {
      list: 'my-scale-list',
      button: 'my-scale-button',
      score: 'my-scale-score',
      labels: 'my-scale-labels',
    }
  }}
  type="csat"
  points={5}
  scaleStyle="numbers"
  question="How would you rate your satisfaction with our product?"
  minLabel="Very unsatisfied"
  maxLabel="Very satisfied"
  onScoreSubmit={({ value }) => {/* ... */}}
  onFeedbackSubmit={({ value, text }) => {/* ... */}}
/>

You can then style these classes in your app stylesheet.

Demo

Live demo: View Storybook
Run locally: npm run storybook

Contributing

Local development (Storybook)

npm i
npm run storybook

Storybook runs at http://localhost:6006 and is the recommended way to develop and review components.

Library build (watch mode)

npm run dev

This builds the package to dist/ and watches for changes.

Production build

npm run build

Roadmap

Custom emoji & icon support

Changelog

For a detailed history of changes, see the Changelog.

Credits

Emoji icons used in this package are from Sensa Emoji — thanks to the Sensa team for creating such a great set of expressive icons.

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
.storybook		.storybook
docs/assets		docs/assets
scripts		scripts
src		src
.dockerignore		.dockerignore
.gitignore		.gitignore
.stylelintrc.cjs		.stylelintrc.cjs
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
LICENSE.md		LICENSE.md
README.md		README.md
chromatic.config.json		chromatic.config.json
eslint.config.js		eslint.config.js
nginx.conf		nginx.conf
package-lock.json		package-lock.json
package.json		package.json
tsconfig.app.json		tsconfig.app.json
tsconfig.json		tsconfig.json
tsconfig.node.json		tsconfig.node.json
types-svg.d.ts		types-svg.d.ts
vite.config.ts		vite.config.ts
vitest.shims.d.ts		vitest.shims.d.ts

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

react-feedback-surveys

Introduction

Table of Contents

Features

Survey Types

Installation

1. Install

2. Styles

Survey Component

CSAT (Customer Satisfaction Score)

NPS (Net Promoter Score)

CES (Customer Effort Score)

Layout Components

Popup

Usage

Props

Surface

Usage

Props

Props

Shared Props

ClassNamesConfig Type

Shared Events

onScoreSubmit

onFeedbackSubmit

onContactSubmit

Format Props

Scale Style Options

Styling

CSS Variables

Dark Theme Example

Custom Classes

Demo

Contributing

Local development (Storybook)

Library build (watch mode)

Production build

Roadmap

Changelog

Credits

License

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

`onScoreSubmit`

`onFeedbackSubmit`

`onContactSubmit`