@pollyou/react
v0.1.0
Published
React component and hook for PollYou surveys (wraps the <pollyou-survey> web component).
Maintainers
Readme
@pollyou/react
React component and hook for PollYou polls and surveys. Wraps the
<pollyou-survey> web component of @pollyou/embed-core. React 18 and 19, SSR-safe
(Next.js App Router: the entry is a 'use client' module).
npm install @pollyou/reactimport { PollYouSurvey } from '@pollyou/react'
export function Feedback() {
return (
<PollYouSurvey
surveyId="AbC123xyz0"
apiBase="https://app.pollyou.app"
locale="de"
hidden={{ ref: 'newsletter' }}
onComplete={(detail) => console.log(detail.responseId)}
/>
)
}Props
| Prop | Element attribute / behaviour |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| surveyId (required) | survey-id |
| embedId, apiBase, locale, identityToken | embed-id, api-base, locale, identity-token |
| mode | inline | popup | slider | fullpage |
| theme | auto | light | dark |
| showResults | show-results="true\|false" |
| liveResults, preview | boolean attributes |
| meta | meta (JSON) |
| hidden | one hidden-<key> attribute per entry |
| channel | channel, default react |
| open | controlled popup visibility (open attribute); omit for uncontrolled use |
| onReady, onStart, onAnswer, onComplete, onClose, onError | pollyou:* events, called with (detail, event) |
| className, style, id | rendered on the element |
ref is forwarded to the <pollyou-survey> element.
usePollYou()
const survey = usePollYou()
<button onClick={survey.open}>Feedback</button>
<PollYouSurvey ref={survey.ref} surveyId="AbC123xyz0" mode="popup" />
// survey.isOpen, survey.lastEvent ({ type, detail }), survey.completed, survey.close()How it works
Attributes and event listeners are applied through a ref in effects, so React 18 and 19
behave the same. Rendering touches no browser API; @pollyou/embed-core is imported
lazily in an effect and defines the element (loadPollYou() triggers it manually).
User documentation (German): docs/frameworks/react.md.
pnpm --filter @pollyou/react test # Vitest + Testing Library, React 19 and 18 (test/react18), SSR
pnpm --filter @pollyou/react build # tsdown → dist (ESM, CJS, .d.ts/.d.cts)Overlay modes and triggers
mode popup, slider or fullpage renders an overlay that is visible while open is set. Triggers (delay, scroll depth, exit intent, page views) and frequency rules come from the embed configuration (embedId); the wrapper has no trigger props – the app controls open. See @pollyou/embed-core README, "Overlay modes". Listen to pollyou:shown on the element (it bubbles) for host analytics.
