Appearance
xtf-editor
组件说明
xtf-editor 是富文本编辑器，用于编辑 HTML 或 Delta 内容并调用格式化命令。当前实现读取 toolbarActions 数据、通过 input 等事件反馈交互、提供实例方法。
- 实际 Demo 路由：
#/pages/components/xtf-editor/index - Demo 源码
基础用法
1. 最小可用
提供能够直接看到或操作组件的最少业务内容。
vue
<template>
<view class="doc-minimum">
<XtfEditor placeholder="请输入内容" :toolbar-actions="fixture" />
</view>
</template>
<script setup lang="uts">
import XtfEditor from "@/uni_modules/xtf-linkuiunix/components/xtf-editor/xtf-editor.uvue"
const fixture = [{ key: 'bold', type: 'format', name: 'bold', value: '', command: '', label: '粗体', icon: 'format_bold' }, { key: 'undo', type: 'command', name: '', value: '', command: 'undo', label: '撤销', icon: 'undo' }] as Array<any>
</script>
<style>
.doc-minimum { display: flex; flex-direction: column; padding: 24rpx; }
</style>2. 核心数据与主要事件
使用组件真实数据入口，并记录当前源码声明的主要事件。
vue
<template>
<view class="doc-core">
<XtfEditor placeholder="请输入内容" :toolbar-actions="fixture" @input="onPrimaryEvent" />
</view>
</template>
<script setup lang="uts">
import XtfEditor from "@/uni_modules/xtf-linkuiunix/components/xtf-editor/xtf-editor.uvue"
const fixture = [{ key: 'bold', type: 'format', name: 'bold', value: '', command: '', label: '粗体', icon: 'format_bold' }, { key: 'undo', type: 'command', name: '', value: '', command: 'undo', label: '撤销', icon: 'undo' }] as Array<any>
function onPrimaryEvent(payload: any): void { console.log("xtf-editor:input", payload) }
</script>
<style>
.doc-core { display: flex; flex-direction: column; padding: 24rpx; }
</style>3. 动态 disabled 状态
运行时切换 disabled，观察组件对应状态变化。
vue
<template>
<view class="doc-dynamic">
<XtfEditor placeholder="请输入内容" :toolbar-actions="fixture" :disabled="state" />
<button class="doc-action-button" @click="toggleState">切换 disabled</button>
<text class="doc-state-text">disabled: {{ state }}</text>
</view>
</template>
<script setup lang="uts">
import XtfEditor from "@/uni_modules/xtf-linkuiunix/components/xtf-editor/xtf-editor.uvue"
import { ref } from "vue"
const fixture = [{ key: 'bold', type: 'format', name: 'bold', value: '', command: '', label: '粗体', icon: 'format_bold' }, { key: 'undo', type: 'command', name: '', value: '', command: 'undo', label: '撤销', icon: 'undo' }] as Array<any>
const state = ref(false)
function toggleState(): void { state.value = !state.value; console.log("disabled", state.value) }
</script>
<style>
.doc-dynamic { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
.doc-state-text { margin-top: 12rpx; color: #475569; font-size: 24rpx; }
</style>4. 调用 undo()
调用该公开实例能力；签名为 undo(): void。
vue
<template>
<view class="doc-method">
<XtfEditor placeholder="请输入内容" :toolbar-actions="fixture" ref="componentRef" />
<button class="doc-action-button" @click="callMethod">调用该公开实例能力</button>
</view>
</template>
<script setup lang="uts">
import XtfEditor from "@/uni_modules/xtf-linkuiunix/components/xtf-editor/xtf-editor.uvue"
import { ref } from "vue"
const fixture = [{ key: 'bold', type: 'format', name: 'bold', value: '', command: '', label: '粗体', icon: 'format_bold' }, { key: 'undo', type: 'command', name: '', value: '', command: 'undo', label: '撤销', icon: 'undo' }] as Array<any>
const componentRef = ref<any>(null)
function callMethod(): void { componentRef.value?.undo(); console.log("调用 undo") }
</script>
<style>
.doc-method { display: flex; flex-direction: column; padding: 24rpx; }
.doc-action-button { margin-top: 16rpx; }
</style>全部属性
| 属性 | 源码类型 | withDefaults 默认值 | 实际行为 / 范围 | 适用范围 |
|---|---|---|---|---|
modelValue | any | undefined | 参与组件运行逻辑；源码在 6 处读取该值；消费位置：script 行 22、script 行 53、script 行 90 | 需要覆盖组件默认业务值时设置。 |
value | any | "" | 参与组件运行逻辑；源码在 3 处读取该值；消费位置：script 行 22、script 行 53、script 行 90 | 需要覆盖组件默认业务值时设置。 |
placeholder | string | "开始输入内容..." | 参与组件运行逻辑；源码在 2 处读取该值；消费位置：script 行 45 | 需要提供业务文案或图标内容时设置。 |
readOnly | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 44 | 需要覆盖组件默认业务值时设置。 |
disabled | boolean | false | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 44 | 需要控制显示、可用性或交互状态时设置。 |
minHeight | number | string | 360 | 设置对应区域高度；消费位置：script 行 48 | 需要调整布局或视觉表现时设置。 |
showToolbar | boolean | true | 开关对应显示或交互行为；消费位置：template 行 3 | 需要控制显示、可用性或交互状态时设置。 |
toolbarActions | any[] | () => [] as any[] | 提供组件渲染或选择使用的数据集合；消费位置：script 行 46 | 数据驱动或选项渲染场景。 |
showImgSize | boolean | true | 设置对应元素尺寸；消费位置：template 行 10 | 需要调整布局或视觉表现时设置。 |
showImgToolbar | boolean | true | 开关对应显示或交互行为；消费位置：template 行 10 | 需要控制显示、可用性或交互状态时设置。 |
showImgResize | boolean | true | 开关对应显示或交互行为；消费位置：template 行 10 | 需要控制显示、可用性或交互状态时设置。 |
customClass | string | "" | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：template 行 2 | 需要调整布局或视觉表现时设置。 |
customStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 参与组件运行逻辑；源码在 1 处读取该值；消费位置：script 行 47 | 需要调整布局或视觉表现时设置。 |
editorClass | string | "" | 追加到对应内部区域的 class；消费位置：template 行 10 | 需要调整布局或视觉表现时设置。 |
editorStyle | UTSJSONObject | () => ({} as UTSJSONObject) | 覆盖或追加对应内部区域的样式对象；消费位置：script 行 48 | 需要调整布局或视觉表现时设置。 |
事件
| 事件名称 | 源码触发边界 | 回调参数 | 参数说明 |
|---|---|---|---|
input | handleInput 内触发（script 行 57）；参数表达式：html；前置 guard：disposed || resolvedReadOnly.value || applyingExternal.valuesetup 内触发（script 行 81）；参数表达式：""；前置 guard：disposed || resolvedReadOnly.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:modelValue | handleInput 内触发（script 行 57）；参数表达式：html；前置 guard：disposed || resolvedReadOnly.value || applyingExternal.valuesetup 内触发（script 行 81）；参数表达式：""；前置 guard：disposed || resolvedReadOnly.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
update:value | handleInput 内触发（script 行 57）；参数表达式：html；前置 guard：disposed || resolvedReadOnly.value || applyingExternal.valuesetup 内触发（script 行 81）；参数表达式：""；前置 guard：disposed || resolvedReadOnly.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
change | handleInput 内触发（script 行 57）；参数表达式：{ html, text: detail["text"] == null ? "" : detail["text"], delta: detail["delta"] == null ? null : detail["delta"] }；前置 guard：disposed || resolvedReadOnly.value || applyingExternal.valuesetup 内触发（script 行 81）；参数表达式：{ html: "", text: "", delta: null }；前置 guard：disposed || resolvedReadOnly.valuesetup 内触发（script 行 87）；参数表达式：result | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
focus | handleFocus 内触发（script 行 58）；参数表达式：event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
blur | handleBlur 内触发（script 行 59）；参数表达式：event | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
ready | setup 内触发（script 行 56）；参数表达式：{ editorCtx: context }；前置 guard：disposedsetup 内触发（script 行 56）；参数表达式：{ editorCtx: null, error } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
statuschange | handleStatusChange 内触发（script 行 60）；参数表达式：formats.value | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
insert-image | setup 内触发（script 行 86）；参数表达式：{ src } | (...args: any[]) | 表中参数表达式来自当前源码直接调用点；禁用、守卫失败或未进入该函数分支时不会触发。 |
插槽
| 插槽 | Scope 参数 | 实际渲染位置 |
|---|---|---|
| - | - | 当前模板没有公开 slot。 |
方法
实例方法
| 方法 | 签名 / 返回值 | 调用边界 |
|---|---|---|
format | format(name: string, value?: string): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
undo | undo(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
redo | redo(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
clear | clear(): void | 清空内容；通过组件 ref 调用，参数和返回值按签名处理。 |
removeFormat | removeFormat(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
insertDivider | insertDivider(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
insertDate | insertDate(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
insertText | insertText(text: string): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
insertImage | insertImage(src: string = ""): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
getContents | getContents(): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
setContents | setContents(value: any): void | 调用该公开实例能力；通过组件 ref 调用，参数和返回值按签名处理。 |
公开状态
| 状态 | 类型 / 包装 | 读取边界 |
|---|---|---|
| - | - | 当前组件没有公开状态。 |
主题说明
- 当前组件 CSS 未读取
var(--xtf-*)主题变量；颜色或尺寸可能来自 props、固定样式或父级上下文。
平台与实现边界
- 基线为 HBuilderX 5.26+ 与 uni-app x；当前报告已验证 Web Chromium 的对应 Demo，不据此承诺 Safari、小程序或 App 原生端等价。
- Android、iOS、HarmonyOS、Vapor 原生路径、触摸手势、字体、Canvas、安全区和系统权限能力，只有源码或完整性报告明确覆盖的部分才可视为已验证。
- 本文按当前源码生成，不补入旧版
xtf-linkui存在但迁移版未实现的 props、事件、slot 或方法。 - 详细公共边界见 平台与实现边界，逐项运行证据见项目根目录 COMPONENT_COMPLETENESS.md。