Home > SYS_IFrame > openIFrame

SYS_IFrame.openIFrame() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

打开内联框架窗口

Signature

public openIFrame(htmlFileName: string, width?: number, height?: number, id?: string, props?: { maximizeButton?: undefined | false | true; minimizeButton?: undefined | false | true; minimizeStyle?: undefined | 'collapsed' | 'constricted'; buttonCallbackFn?: undefined | ((button: 'close' | 'minimize' | 'maximize') => void | Promise<void>); onBeforeCloseCallFn?: undefined | (() => boolean | undefined | Promise<boolean | undefined>); grayscaleMask?: undefined | false | true; title?: undefined | string; x?: undefined | number; y?: undefined | number }): Promise<boolean>;

Parameters

Parameter	Type	Description
htmlFileName	string	需要加载的 HTML 文件在扩展包内的路径，从扩展根目录起始，例如 /iframe/index.html
width	number	(Optional) 内联框架窗口的宽度
height	number	(Optional) 内联框架窗口的高度
id	string	(Optional) 内联框架窗口 ID，用于关闭内联框架窗口
props	{ maximizeButton?: undefined | false | true; minimizeButton?: undefined | false | true; minimizeStyle?: undefined | 'collapsed' | 'constricted'; buttonCallbackFn?: undefined | ((button: 'close' | 'minimize' | 'maximize') => void | Promise<void>); onBeforeCloseCallFn?: undefined | (() => boolean | undefined | Promise<boolean | undefined>); grayscaleMask?: undefined | false | true; title?: undefined | string; x?: undefined | number; y?: undefined | number }	(Optional) 其它参数

Returns

Promise<boolean>

操作是否成功

Remarks

本接口仅扩展包允许调用，用户需要在扩展包内包含用于内联的 HTML 文件；

本接口调用后将会打开一个 Dialog 窗口，该 Dialog 窗口的标题为 HTML 文件的 <title>，标题栏有关闭按钮；

正文部分为内联框架，width 和 height 均为正文部分内联框架的宽高；

内联框架需要展示 htmlFileName 的内容，该 HTML 从扩展包内获取，并已在安装时被存储至 IndexedDB 中

注意：本接口仅扩展有效，在独立脚本环境内调用将始终 throw Error