# 错误页插件

错误页浮层UI插件,用于错误提示。

使用show/hide方法展示/隐藏,当传入showOnError配置时,会在播放器上监听error事件展示、监听播放隐藏

# 引入

import { H5Player } from '@tencent/thumbplayer-h5';
import { ErrorPagePlugin } from '@tencent/thumbplayer-plugin-error-page';

const player = new H5Player({ container: '#demo', plugins: [ErrorPagePlugin.pluginName] });
const errorPage = player.plugins[ErrorPagePlugin.pluginName];

// 展示错误页
errorPage.show();
// 指定文案
errorPage.show('很抱歉,当前平台暂不支持播放本内容');
// 指定文案、错误码 和 图片地址 并隐藏刷新按钮
errorPage.show({ text: '很抱歉,当前平台暂不支持播放本内容', code: '错误码1.0.0', hideRefresh: true, img: '//i.gtimg.cn/qqlive/images/20170712/error_tip2.png' });
// 隐藏浮层
errorPage.hide()

# 配置

new H5Player({ 
  container: '#demo', 
  plugins: [
    [ErrorPagePlugin.pluginName, { showOnError: false }],
  ],
});

# 插件API

interface IShowParam {
  /** 文案会以innerHTML设置到dom */
  text?: string;
  /** 错误码会以innerHTML设置到dom */
  code?: string | number;
  /** 错误图片 */
  img?: string;
  /** 隐藏刷新 */
  hideRefresh?: boolean;
}

# destroy

destroy(): void

销毁插件,移除dom

Returns: void


# hide

hide(): void

隐藏错误页

Returns: void


# show

show(param?: string | IShowParam): void

展示错误页

# Parameters:

Name Type
param string | IShowParam

Returns: void

上次更新: 8/2/2021, 11:23:39 AM