Lumifeed Docs
Widget

React

Use the Lumifeed React component in your React app.

React

Installation

npm install @lumifeed/react

Basic usage

import { LumifeedWidget } from "@lumifeed/react"

export default function App() {
  return (
    <>
      <YourApp />
      <LumifeedWidget apiKey={process.env.NEXT_PUBLIC_LUMIFEED_KEY} />
    </>
  )
}

Props

PropTypeDefaultDescription
apiKeystringRequired. Your project API key
positionstringbottom-rightButton position
themestringautolight, dark, or auto
labelstringFeedbackButton label
primaryColorstring#7c6af4Accent color
userobjectUser identification object
onSubmitfunctionCallback after successful submission

With user identification

import { LumifeedWidget } from "@lumifeed/react"
import { useUser } from "./hooks/useUser"

export default function Layout({ children }) {
  const user = useUser()

  return (
    <>
      {children}
      <LumifeedWidget
        apiKey={process.env.NEXT_PUBLIC_LUMIFEED_KEY}
        user={
          user
            ? { userId: user.id, name: user.name, email: user.email }
            : undefined
        }
        onSubmit={(feedback) => {
          console.log("Submitted:", feedback.id)
        }}
      />
    </>
  )
}

Programmatic control

import { useLumifeed } from "@lumifeed/react"

function TriggerButton() {
  const { open } = useLumifeed()
  return <button onClick={open}>Give feedback</button>
}

On this page