HtmlSandbox · HTML 沙箱
保存显式 HTML 源码对象,只有宿主提供 mount 时才挂载隔离预览。静态 HTML 导出保留转义源码,不嵌入执行中的 iframe。
保存显式 HTML 源码对象,只有宿主提供 mount 时才挂载隔离预览。静态 HTML 导出保留转义源码,不嵌入执行中的 iframe。
@quirekit/extension-html-sandbox · MIT
编辑器适用范围
层次:共享文档能力
| 编辑器 | 状态 | 所需装配与边界 |
|---|---|---|
| Classic | 未验证 | 尚未建立此入口的完整产品接入与验证路径。公开 Core 导出不代表当前产品已提供对应呈现、控件或文件支持。 |
| Block | 需适配 | 需由宿主连接本页所列服务、目标与生命周期,并验证所选 View 和文档模型。核心接口可复用,但没有一段无宿主参数的通用产品安装代码。 |
“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。
接入
pnpm add @quirekit/extension-html-sandbox@alpha
在创建 Editor 时放入 extensions。挂载容器、视图和保存由宿主提供,见快速开始。
import { HtmlSandbox } from '@quirekit/extension-html-sandbox'
安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。
按编辑器接入
以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。
Classic · 未验证
尚未建立此入口的完整产品接入与验证路径。公开 Core 导出不代表当前产品已提供对应呈现、控件或文件支持。
Block · 需适配
需由宿主连接本页所列服务、目标与生命周期,并验证所选 View 和文档模型。核心接口可复用,但没有一段无宿主参数的通用产品安装代码。
配置
下面是扩展自身的默认选项。预设可以覆盖这些值;它们不等于当前文档属性。配置方法见配置插件。
mount
为 HTML 源码对象挂载隔离预览,返回可更新和销毁的句柄。
类型:((container: HTMLElement, document: HtmlSandboxDocument) => HtmlSandboxViewHandle) | null
默认:null
命令与运行方式
以下命令由此扩展直接提供,均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定;可以先用 editor.can() 查询。
| 命令 | 参数签名 |
|---|---|
insertHtmlSandbox | insertHtmlSandbox(request: HtmlSandboxInsertion) |
updateHtmlSandbox | updateHtmlSandbox(request: HtmlSandboxUpdate) |
这里只展示参数签名。接界面时见命令与控件,正文变更继续经过同一事务与历史。