questionnaire
Updated: 2025-07-03 14:46:06
1. Introduction
The questionnaire component is used for survey functionality in live streaming rooms. It supports multiple question types, including single-choice, multiple-choice, open-ended, and star rating questions. The component provides complete functionality for displaying, answering, and submitting questionnaires.
The component provides one main entry component:
NormalQuestionnaire- General questionnaire component
2. Import
2.1 UMD Method
<script src="https://websdk.videocc.net/iar-questionnaire-ui/rc-20250612/normal-questionnaire.umd.js"></script>
<script>
const { NormalQuestionnaire } = window.PolyvIarQuestionnaireUi;
</script>
2.2 NPM Method
// 安装依赖
pnpm add @polyv/iar-questionnaire-ui
// 引入组件
import { NormalQuestionnaire } from '@polyv/iar-questionnaire-ui';
3. Code Example
<template>
<div>
<!-- 问卷组件 -->
<NormalQuestionnaire
ref="questionnaireRef"
:questionnaire-target="questionnaireSDK"
:questionnaire-data="questionnaireData"
@to-show="onToShow"
@to-hide="onToHide"
@submit-success="onSubmitSuccess"
/>
</div>
</template>
<script setup>
import { NormalQuestionnaire } from '@polyv/iar-questionnaire-ui';
import { Questionnaire } from '@polyv/iar-questionnaire-sdk';
// 初始化问卷 SDK
const questionnaireSDK = new Questionnaire(iarCore);
// 问卷数据
const questionnaireData = ref(null);
// 事件处理
const onToShow = () => {
console.log('显示问卷弹窗');
};
const onToHide = () => {
console.log('隐藏问卷弹窗');
};
const onSubmitSuccess = () => {
console.log('问卷提交成功');
};
</script>
4. API
4.1 Props
| Parameter | Description | Type | Default | Required |
|---|---|---|---|---|
| questionnaireTarget | Questionnaire SDK instance | Questionnaire |
- | Yes |
| questionnaireData | Questionnaire data | QuestionnaireData |
- | No |
4.2 Events
| Event Name | Description | Callback Parameters |
|---|---|---|
| to-show | Triggered when the questionnaire popup is displayed | () => void |
| to-hide | Triggered when the questionnaire popup is hidden | () => void |
| submit-success | Triggered when the questionnaire is submitted successfully | () => void |
4.3 Methods
Component methods can be called via ref:
| Method Name | Description | Parameters | Return Value |
|---|---|---|---|
| show | Display the questionnaire | - | void |
| hide | Hide the questionnaire | - | void |
| submit | Submit the questionnaire | - | Promise<void> |
