React SDK

Install the widget with a provider plus hooks when your app already runs React.

Last reviewed

React SDK

Use the React SDK when your app already runs React and you want the widget surface to feel native in component code.

Install

bun add @getuserfeedback/react

The package requires react >= 18.

Wrap your app

import { GetUserFeedbackProvider } from "@getuserfeedback/react";

export function App() {
  return (
    <GetUserFeedbackProvider clientOptions={{ apiKey: "YOUR_API_KEY" }}>
      <AppRoutes />
    </GetUserFeedbackProvider>
  );
}

Open a flow from React

import { useFlow } from "@getuserfeedback/react";

export function FeedbackButton() {
  const { open } = useFlow({ flowId: "YOUR_FLOW_ID" });

  return (
    <button type="button" onClick={() => open()}>
      Give feedback
    </button>
  );
}

Add later, not first

  • useGetUserFeedback() when you need identify, reset, or configure
  • useFlow({ container: "custom" }) when the widget should render inside your own dialog
  • disableAutoLoad when loading must wait for consent or some other gate