保利威文档中心

帮助中心

coupon 优惠券

更新时间:2025-07-03 14:46:06

一、介绍

优惠券组件用于直播间的优惠券功能,支持优惠券领取、查看和展示。组件包含可领取优惠券列表、已领取优惠券列表和优惠券挂件等功能。

组件提供三种不同的入口组件:

  • NormalCouponCommonList - 可领取优惠券列表组件
  • NormalCouponUserList - 已领取优惠券列表组件
  • NormalCouponPendant - 优惠券挂件组件

二、引入

2.1 UMD 方式

其中 normal-coupon-common-list.umd.js 是可领取优惠券列表组件,normal-coupon-user-list.umd.js 是已领取优惠券列表组件,normal-coupon-pendant.umd.js 是优惠券挂件组件。

<script src="https://websdk.videocc.net/iar-coupon-ui/rc-20250612/normal-coupon-common-list.umd.js"></script>

<script>
const { NormalCouponCommonList, NormalCouponUserList, NormalCouponPendant } = window.PolyvIarCouponUi;
</script>

2.2 NPM 方式

// 安装依赖
pnpm add @polyv/iar-coupon-ui

// 引入组件
import { NormalCouponCommonList, NormalCouponUserList, NormalCouponPendant } from '@polyv/iar-coupon-ui';

三、代码示例

<template>
  <div>
    <!-- 可领取优惠券列表 -->
    <NormalCouponCommonList
      ref="couponCommonListRef"
      :coupon-target="couponSDK"
      @to-show="onToShow"
      @to-hide="onToHide"
    />

    <!-- 已领取优惠券列表 -->
    <NormalCouponUserList
      ref="couponUserListRef"
      :coupon-target="couponSDK"
      @to-show="onToShow"
      @to-hide="onToHide"
    />

    <!-- 优惠券挂件 -->
    <NormalCouponPendant
      ref="couponPendantRef"
      :coupon-target="couponSDK"
      @to-show="onToShow"
      @to-hide="onToHide"
    />
  </div>
</template>

<script setup>
import { NormalCouponCommonList, NormalCouponUserList, NormalCouponPendant } from '@polyv/iar-coupon-ui';
import { Coupon } from '@polyv/iar-coupon-sdk';

// 初始化优惠券 SDK
const couponSDK = new Coupon(iarCore);

// 事件处理
const onToShow = () => {
  console.log('显示优惠券弹窗');
};

const onToHide = () => {
  console.log('隐藏优惠券弹窗');
};
</script>

四、API

4.1 Props

参数 说明 类型 默认值 必填
couponTarget 优惠券 SDK 实例 Coupon -

4.2 Events

事件名 说明 回调参数
to-show 显示优惠券弹窗时触发 () => void
to-hide 隐藏优惠券弹窗时触发 () => void

4.3 方法

通过 ref 可以调用组件的方法:

方法名 说明 参数 返回值
show 显示组件 - void
hide 隐藏组件 - void
联系客服,在线咨询