Home > SYS_IFrame > hideIFrame

SYS_IFrame.hideIFrame() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

隐藏内联框架窗口

签名

function hideIFrame(id?: string): Promise<boolean>;

参数名

参数	类型	描述
id	string	（可选） 内联框架窗口 ID，未传入时将隐藏扩展关联的所有内联框架窗口

返回值

Promise<boolean>

操作是否成功

备注

本接口为结果导向的： 如若未找到指定内联框架窗口，接口将会返回 false； 如若在执行操作前该内联框架窗口已处于隐藏状态，接口将会返回 true

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

示例

// 1. 打开一个内联框架窗口（自建 fixture）
const opened = await eda.sys_IFrame.openIFrame('/extension.json', 320, 200, '嘉立创示例_隐藏演示', {
	title: '嘉立创示例 隐藏演示窗口',
});
console.log('打开结果：', opened);

// 2. 隐藏该窗口（窗口从界面消失，但未被销毁）
const hidden = await eda.sys_IFrame.hideIFrame('嘉立创示例_隐藏演示');
console.log('隐藏结果：', hidden);

// 3. 对已隐藏的窗口再次隐藏，验证幂等语义（返回 true）
const hideAgain = await eda.sys_IFrame.hideIFrame('嘉立创示例_隐藏演示');
console.log('重复隐藏结果：', hideAgain);

// 4. 对不存在的窗口 ID 隐藏，结果导向返回 false（不抛错）
const hideMissing = await eda.sys_IFrame.hideIFrame('嘉立创示例_不存在的窗口');
console.log('不存在的窗口 ID →', hideMissing);

// 5. 关闭隐藏状态的窗口还原界面（隐藏的窗口可直接关闭）
const closed = await eda.sys_IFrame.closeIFrame('嘉立创示例_隐藏演示');
console.log('关闭隐藏窗口结果：', closed);