Props-referanse

Komplett oversikt over alle props for LumiSurveyDock-komponenten.

Top-level props

Prop	Type	Påkrevd	Beskrivelse
surveyId	string	✅	Unik identifikator for surveyen (f.eks. "soknad-kvittering")
survey	LumiSurveyConfig	✅	Konfigurasjonsobjekt med spørsmålene
transport	LumiSurveyTransport	✅	Objekt med submit-funksjon for innsending
context	LumiSurveyContext	❌	Metadata/tags/debug for segmentering
behavior	LumiSurveyBehavior	❌	Styrer åpning, lukking, cooldown og storage
events	LumiSurveyEvents	❌	Event-callbacks for sporing og livssyklus
labels	LumiSurveyLabels	❌	Tekster for UI-elementer
success	LumiSurveySuccessConfig	❌	Konfigurer suksess-visning
style	LumiSurveyStyle	❌	Visuell styling (posisjon, farger, classNames)
intro	LumiSurveyIntroConfig	❌	Intro-skjerm før første spørsmål

survey — LumiSurveyConfig

interface LumiSurveyConfig {
  /** Survey-type for analytics. Default: "custom" */
  type?: "rating" | "topTasks" | "discovery" | "taskPriority" | "custom";

  /** Alle spørsmål, i rekkefølge */
  questions: LumiSurveyQuestion[];
}

Se Spørsmålstyper for detaljer om spørsmål-objektene.

transport — LumiSurveyTransport

interface LumiSurveyTransport {
  submit: (submission: LumiSurveySubmission) => Promise<void>;
}

submission.transportPayload er den ferdig-formaterte payloaden du kan sende direkte til Lumi API fra nettleseren med en API-nøkkel, eller via en egen backend hvis du vil proxy/videreprosessere. Se Koble til backend → Sjekkliste for oppsett.

behavior — LumiSurveyBehavior

Styrer åpning, lukking, lagring og layout.

Property	Type	Default	Beskrivelse
initialOpen	boolean	true	Om docken starter åpen
resetOnClose	boolean	true	Nullstill skjema ved lukking
dismissCooldownDays	number	30	Dager før dismissed dock vises igjen
hideAfterSubmit	boolean	true	Skjul helt etter vellykket innsending
questionLayout	"auto" | "singlePage" | "steps"	"auto"	Hvordan spørsmål presenteres
showPersonalDataNotice	boolean	true	Vis personverninfo
personalDataNotice	ReactNode	❌	Tilpasset personverninfo
collectLocation	boolean	false	Auto-collect pathname fra URL
storageStrategy	"localStorage" | "sessionStorage" | "none"	"localStorage"	Lagringsstrategi for dismissed-tilstand
consentResolver	LumiSurveyConsentResolver	—	Callback som avgjør om storage kan brukes
storageAdapter	StorageAdapter	—	Custom lagringsadapter for dismissed-tilstand
deduplicationKey	string	—	Opaque ikke-PII token for backend-deduplisering når browser storage er av
showProgress	boolean	false	Vis fremdriftslinje i step-modus

consentResolver evalueres før lesing, skriving og sletting av dismissal-state. Når den returnerer false eller { storage: false }, gjør widgeten ingen storage-operasjoner; eksisterende dismissal-nøkler kan derfor bli liggende til samtykke gis igjen eller host-appen rydder dem.

storageAdapter.write kan returnere void for suksess. Returner StorageWriteResult når adapteren må uttrykke no-op, nektet lagring eller skrivefeil. storageAdapter overstyrer storageStrategy, men er fortsatt gated av consentResolver hvis begge er satt.

deduplicationKey skal være en stabil opaque token, ikke fødselsnummer, e-post, rå bruker-id eller andre direkte identifikatorer.

questionLayout-verdier

• "auto" (default): Step-modus brukes automatisk når branching-logikk (logic) finnes. Ellers vises alle synlige spørsmål på én side.
• "singlePage": Alle synlige spørsmål vises alltid på én side.
• "steps": Alltid ett spørsmål om gangen med Neste/Tilbake-knapper.

labels — LumiSurveyLabels

Tekster for UI-elementer. Alle har fornuftige norske defaults.

Property	Type	Default	Beskrivelse
submit	string	"Send inn"	Send-knapp
submitPending	string	"Sender inn..."	Send-knapp under innsending
cancel	string	"Lukk"	Lukk-knapp
validationError	string	"Vennligst fyll ut alle påkrevde felt"	Valideringsfeilmelding
transportError	string	"Noe gikk galt ved innsending. Prøv igjen senere."	Innsendingsfeil
minimizedButton	string	"Gi tilbakemelding"	Tekst på minimert knapp

<LumiSurveyDock
  labels={{
    submit: "Send tilbakemelding",
    cancel: "Avbryt",
    minimizedButton: "Hjelp oss å bli bedre",
  }}
/>

success — LumiSurveySuccessConfig

Konfigurer suksess-skjermen etter innsending.

Property	Type	Default	Beskrivelse
title	string	"Takk for tilbakemeldingen!"	Overskrift
body	ReactNode	—	Valgfri tekst under overskriften
primaryLabel	string	"Lukk"	Knappetekst
autoClose	boolean	false	Lukk automatisk etter suksess
autoCloseDelayMs	number	1600	Forsinkelse før auto-lukk (ms)

<LumiSurveyDock
  success={{
    title: "Tusen takk!",
    body: "Tilbakemeldingen din hjelper oss å forbedre tjenesten.",
    autoClose: true,
    autoCloseDelayMs: 2000,
  }}
/>

style — LumiSurveyStyle

Visuell tilpasning av dock-panelet.

Property	Type	Default	Beskrivelse
position	"bottom-right" | "bottom-left"	"bottom-right"	Posisjon på skjermen
offset	number	24	Avstand fra viewport-kant i px
containerClassName	string	—	Ekstra CSS-klasse for container
panelClassName	string	—	Ekstra CSS-klasse for panelet
panelBackground	--lumi-* CSS custom property eller CSS-fargestreng	"default"	Bakgrunnsfarge
panelBorderColor	--lumi-* CSS custom property eller CSS-fargestreng	"neutral-subtle"	Kantfarge

<LumiSurveyDock
  style={{
    position: "bottom-left",
    offset: 16,
    panelBackground: "surface-subtle",
  }}
/>

Se Styling for mer om visuell tilpasning.

events — LumiSurveyEvents

Event-callbacks for livssyklus og sporing. Se Events for fullstendig dokumentasjon med brukseksempler.

intro — LumiSurveyIntroConfig

Viser en intro-skjerm før første spørsmål.

Property	Type	Default	Beskrivelse
title	string	✅ (påkrevd)	Overskrift på intro-skjermen
body	ReactNode	—	Valgfri brødtekst
startLabel	string	"Start"	Knappetekst for å starte surveyen

<LumiSurveyDock
  intro={{
    title: "Hjelp oss å forbedre tjenesten",
    body: "Det tar bare 30 sekunder. Alle svar er anonyme.",
    startLabel: "Gi tilbakemelding",
  }}
/>

context — LumiSurveyContext

Metadata for segmentering og feilsøking. Se Context & tags for fullstendig dokumentasjon.

interface LumiSurveyContext {
  // Auto-collected
  viewport?: { width: number; height: number };
  deviceType?: "mobile" | "tablet" | "desktop";
  userAgent?: string;

  // Opt-in (krever collectLocation: true)
  url?: string;
  pathname?: string;

  // Manuelt satt
  tags?: Record<string, string | number | boolean>;
  debug?: Record<string, unknown>;
}