# FloatingObject · 浮动文本对象

在通用文档中创建有独立可编辑正文的浮动对象。它需要布局 provider 支持；Word 锚点模型使用 WordFloatingObjectAnchor。

在通用文档中创建有独立可编辑正文的浮动对象。它需要布局 provider 支持；Word 锚点模型使用 WordFloatingObjectAnchor。

`@quirekit/extension-floating-object` · **AGPL-3.0-only**

## 编辑器适用范围
层次：**共享文档能力**
| 编辑器 | 状态 | 所需装配与边界 |
| --- | --- | --- |
| Classic | 需适配 | 需由宿主连接本页所列服务、目标与生命周期，并验证所选 View 和文档模型。核心接口可复用，但没有一段无宿主参数的通用产品安装代码。 |
| Block | 未验证 | 尚未建立此入口的完整产品接入与验证路径。公开 Core 导出不代表当前产品已提供对应呈现、控件或文件支持。 |

“直接支持”指已有上述产品装配；具体交互、宿主服务和格式支持仍有各自条件。[状态与接入规则](/plugins/compatibility)。许可独立显示。

## 接入

```sh
pnpm add @quirekit/extension-floating-object@alpha
```

在创建 Editor 时放入 `extensions`。挂载容器、视图和保存由宿主提供，见[快速开始](/guide/quick-start)。

```ts
import { FloatingObject } from '@quirekit/extension-floating-object'
```

安装时按包声明选择兼容版本，外部可用版本以分发源为准。本站使用工作区 Alpha；许可标签来自入口所属包，使用条件见[支持与许可](/support)。

## 按编辑器接入

以下片段沿用已挂载的宿主元素 `element`，宿主负责容器尺寸与保存；退出页面时调用 `instance.destroy()`。已有预设装配的能力不要再重复追加；需要宿主端口的入口应先完成下方配置。

### Classic

需由宿主连接本页所列服务、目标与生命周期，并验证所选 View 和文档模型。核心接口可复用，但没有一段无宿主参数的通用产品安装代码。

### Block

尚未建立此入口的完整产品接入与验证路径。公开 Core 导出不代表当前产品已提供对应呈现、控件或文件支持。

## 配置

下面是扩展自身的默认选项。预设可以覆盖这些值；它们不等于当前文档属性。配置方法见[配置插件](/plugins/configuration)。

### width

创建通用浮动对象时采用的文档宽度，单位为 CSS 像素。

类型：`number`

默认：`240`

### minHeight

创建通用浮动对象时保存的最小高度，单位为 CSS 像素。

类型：`number`

默认：`96`

### minimumWidth

命令与布局接受的最小对象宽度，单位为 CSS 像素。

类型：`number`

默认：`96`

### minimumHeight

命令与布局接受的最小高度下限，单位为 CSS 像素。

类型：`number`

默认：`48`

### movementStep

键盘移动对象每次推进的距离，单位为 CSS 像素。

类型：`number`

默认：`8`

### HTMLAttributes

序列化 HTML 时合并的属性，例如 class。它不修改 Canvas 排版，也不是文档中节点属性的默认值。

类型：`Record<string, unknown>`

默认：`{}`

## 命令与运行方式

以下命令由此扩展直接提供，均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定；可以先用 `editor.can()` 查询。

| 命令 | 参数签名 |
| --- | --- |
| `setFloatingObject` | `setFloatingObject(attributes?: Partial<FloatingObjectAttributes> \| undefined)` |
| `selectFloatingObject` | `selectFloatingObject()` |
| `enterFloatingObject` | `enterFloatingObject()` |
| `leaveFloatingObject` | `leaveFloatingObject()` |
| `moveFloatingObject` | `moveFloatingObject(move: FloatingObjectMove)` |
| `resizeFloatingObject` | `resizeFloatingObject(resize: FloatingObjectResize)` |
| `restoreFloatingObjectGeometry` | `restoreFloatingObjectGeometry(snapshot: FloatingObjectRestore)` |

这里只展示参数签名。接界面时见[命令与控件](/build/commands)，正文变更继续经过同一事务与历史。

## 下一步

返回[全部插件](/plugins)，或阅读[配置插件](/plugins/configuration)区分配置、文档属性与命令。

自己定义能力时见[扩展开发](/build/extension)；搭建完整宿主时见[构建产品](/build)。