@pollyou/vue
v0.1.0
Published
Vue 3 component, plugin and composable for PollYou surveys (wraps the <pollyou-survey> web component).
Maintainers
Readme
@pollyou/vue
Vue 3 component, plugin and composable for PollYou polls and
surveys. Wraps the <pollyou-survey> web component of @pollyou/embed-core. Vue ≥ 3.4,
SSR-safe (Nuxt), no compilerOptions.isCustomElement needed.
npm install @pollyou/vue<script setup lang="ts">
import { PollYouSurvey } from '@pollyou/vue'
</script>
<template>
<PollYouSurvey
survey-id="AbC123xyz0"
api-base="https://app.pollyou.app"
:hidden="{ ref: 'newsletter' }"
@complete="(detail) => console.log(detail.responseId)"
/>
</template>Optional plugin with app-wide defaults (props win) that also registers the component globally:
import { PollYou } from '@pollyou/vue'
app.use(PollYou, { apiBase: 'https://app.pollyou.app', locale: 'de' })Props and events
Props: surveyId (required), embedId, apiBase, mode (inline | popup | slider |
fullpage), locale, theme (auto | light | dark), showResults, liveResults,
identityToken, meta (object → JSON), hidden (object → hidden-<key> attributes),
channel (default vue), preview, open (v-model:open). Other attributes (class,
style, hidden-user-id="42", …) fall through to the element.
Events (payload = detail of the pollyou:* event): ready, start, answer,
complete, close, error, plus update:open.
usePollYou()
<script setup lang="ts">
import { PollYouSurvey, usePollYou } from '@pollyou/vue'
const { survey, open, isOpen, lastEvent, completed } = usePollYou()
</script>
<template>
<button @click="open">Feedback</button>
<PollYouSurvey ref="survey" survey-id="AbC123xyz0" mode="popup" />
</template>How it works
The element is rendered with h('pollyou-survey') (a plain element vnode, so the template
compiler never needs to know it); attributes are applied after mounting and
@pollyou/embed-core is imported lazily in onMounted. Server rendering outputs a bare
<pollyou-survey> tag.
User documentation (German): docs/frameworks/vue.md.
pnpm --filter @pollyou/vue test # Vitest + @vue/test-utils, SSR with @vue/server-renderer
pnpm --filter @pollyou/vue build # tsdown → dist (ESM, CJS, .d.ts/.d.cts via vue-tsc)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.
