Poll Vote

Real-time polling component with single and multiple-choice voting, percentage results, three responsive templates, and the standard sign-in/lead/CTA configuration.

Import

import { PollVote } from "fansunited-frontend-components";
import { PollVoteProps, WidgetTemplate } from "fansunited-frontend-core";

Required props

Prop	Type	Description
`entityId`	`string`	Poll identifier.
`sdk`	`FansUnitedSDKModel`	SDK instance.
`template`	`WidgetTemplate`	`STANDARD`, `SPLIT`, or `OVERLAY`.
`language`	`LanguageType`	Display language.

Optional props

Prop	Type	Description
`themeOptions`	`CustomThemeOptions`	See Theming.
`leads`	`LeadsOptions`	See Lead Collection.
`consents`	`ConsentsConfig`	Profile consent checkboxes. See Consents and the section below.
`imagePosition`	`"left" \| "right"`	`STANDARD` template only.
`defaultImagePlaceholderUrl`	`string`	Fallback image URL.
`userIsLoggedIn`	`boolean`	Host auth state for sign-in-gated polls.
`signInCTA`	`SignInCTADetails`	See Sign-in CTA.
`additionalCTA`	`AdditionalCTADetails`	See Additional CTA.
`rulesDisplay`	`RulesDisplay`	See Rules Display.
`callbacks`	`PollVoteCallbacks`	`onFinish` — see Callbacks.

Voting behavior

Single or multiple choice is determined by the poll configuration on the backend.
Vote attempt limits are enforced server-side. The component disables the form once a user has reached the limit and shows the results view instead.
Real-time results are fetched after a successful vote and updated on the results screen.

Consents

Collect profile consents alongside the vote. The shape is the shared ConsentDef — see Consents for the full field reference and the URL tokens.

import { ConsentsConfig } from "fansunited-frontend-core";

const consents: ConsentsConfig = {
  items: [
    {
      consentId: "terms",
      body: "I accept the {{privacyPolicyUrl}} and the {{termsAndConditionsUrl}}",
      required: true,
    },
    { consentId: "marketing", body: "Send me news and offers by email", position: "after" },
  ],
};

<PollVote {...otherProps} consents={consents} />

Poll configuration	Consent surface
`authRequirement: "LEAD"` + `leads.position` set	The lead form, at the lead's position — all consents, each `position` ignored
No lead form	`"before"` → a gate screen shown before the poll; `"after"` → its own step between the vote and its submission

Without ctaLabel, the gate screen uses the poll's Start label and the consent step its Vote label — the step is what submits the vote.

Examples

Basic

<PollVote
  entityId="poll-123"
  sdk={sdk}
  template={WidgetTemplate.STANDARD}
  language="en"
/>

Customized

<PollVote
  entityId="poll-123"
  sdk={sdk}
  template={WidgetTemplate.OVERLAY}
  language="en"
  userIsLoggedIn={false}
  signInCTA={{ defaultLabel: "Sign in to vote", onClick: openSignIn }}
  leads={{
    position: "after",
    fields: ["fullName", "email"],
    campaignId: "poll-campaign",
    campaignName: "User Survey 2024",
    syncWithProfile: true,
  }}
  themeOptions={{ mode: "dark" }}
/>