uni-app
uni-app x
uniCloud
HBuilder X
uni 小程序 sdk
uni-ad广告
开发者服务
uni-app
uniCloud
HBuilder X
uni 小程序 sdk
uni-ad广告
开发者服务
GitHub
API
uni.createEditorContextAsync(options)
createEditorContextAsync 兼容性
参数
EditorContext 的方法
format(name : string, value ?: string | number | null) : void
insertDivider(options ?: UniEditorElementOptions | null) : void
insertImage(options ?: UniEditorElementInsertImageOptions | null) : void
insertText(options ?: UniEditorElementInsertTextOptions | null) : void
insertLink(options ?: UniEditorElementInsertLinkOptions | null) : void
insertMention(options ?: UniEditorElementInsertMentionOptions | null) : void
展示全部

# uni.createEditorContextAsync(options)

创建并返回 editor 上下文 editorContext 对象

本API是 editor组件 的上下文对象。

# createEditorContextAsync 兼容性 ?

Web 微信小程序 Android(VDOM) Android(Vapor) iOS(VDOM) iOS(Vapor) HarmonyOS
5.08 5.08 5.08 x 5.08 x 5.08

# 参数

名称 类型 必填
options CreateEditorContextAsyncOptions 是
名称 类型 必备 兼容性 描述
id string.IDString 是
editor 元素的 id 属性
component ComponentPublicInstance 否
组件或页面实例，限定在什么范围内查找id
success (context: EditorContext) => void 否
接口调用成功的回调函数
fail (error: UniError) => void 否
接口调用失败的回调函数
complete () => void 否
接口调用结束的回调函数（调用成功、失败都会执行）

# EditorContext 的方法

# format(name : string, value ?: string | number | null) : void

format 修改样式

# format 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
name string 是
value string | number 否

# insertDivider(options ?: UniEditorElementOptions | null) : void

insertDivider 插入分割线

# insertDivider 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementOptions 否
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# insertImage(options ?: UniEditorElementInsertImageOptions | null) : void

insertImage 插入图片

# insertImage 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementInsertImageOptions 否
名称 类型 必备
src string 否
alt string 否
width string 否
height string 否
extClass string 否
data any 否
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# insertText(options ?: UniEditorElementInsertTextOptions | null) : void

insertText 覆盖当前选区，设置一段文本

# insertText 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementInsertTextOptions 否
名称 类型 必备
text string 否
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

insertLink 插入链接

Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementInsertLinkOptions 否
名称 类型 必备
text string 否
href string 是
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# insertMention(options ?: UniEditorElementInsertMentionOptions | null) : void

insertMention 插入可整块删除的提及，提及文本默认为

# insertMention 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS(VDOM) HarmonyOS(Vapor)
5.08 5.08 5.08 5.08 5.08 5.11
# 参数
名称 类型 必填
options UniEditorElementInsertMentionOptions 否
名称 类型 必备 默认值 描述
id string 否 被 @ 的人 id
name string 否 被 @ 的人名字
color string 否 #1677ff 提及文本颜色，默认为 #1677ff
background string 否 #e6f3ff 提及背景颜色，默认为 #e6f3ff
radius string 否 4px 提及圆角，默认为 4px
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# setContents(options ?: UniEditorElementSetContentsOptions | null) : void

setContents 初始化编辑器内容，html和delta同时存在时仅delta生效

# setContents 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementSetContentsOptions 否
名称 类型 必备
delta any 否
html string 否
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# getContents(options ?: UniEditorElementGetContentsOptions | null) : void

getContents 获取编辑器内容

# getContents 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementGetContentsOptions 否
名称 类型 必备
success (res: UniEditorElementGetContentsOptionsRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementGetContentsOptionsRes 的属性值
名称 类型 必备
errMsg string 是
delta any 是
html string 是
text string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# clear(options ?: UniEditorElementOptions | null) : void

clear 清空编辑器内容

# clear 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementOptions 否
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# removeFormat(options ?: UniEditorElementOptions | null) : void

removeFormat 清除当前选区的样式

# removeFormat 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementOptions 否
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# undo(options ?: UniEditorElementOptions | null) : void

undo 撤销

# undo 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementOptions 否
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# redo(options ?: UniEditorElementOptions | null) : void

redo 恢复

# redo 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementOptions 否
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# getSelectionText(options ?: UniEditorElementGetSelectionTextOptions | null) : void

getSelectionText 获取编辑器已选区域内的纯文本内容。当编辑器失焦或未选中一段区间时，返回内容为空。

# getSelectionText 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementGetSelectionTextOptions 否
名称 类型 必备
success (res: UniEditorElementGetSelectionTextOptionsRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementGetSelectionTextOptionsRes 的属性值
名称 类型 必备
errMsg string 是
text string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# scrollIntoView(options ?: UniEditorElementOptions | null) : void

scrollIntoView 使得编辑器光标处滚动到窗口可视区域内。

# scrollIntoView 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementOptions 否
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# blur(options ?: UniEditorElementOptions | null) : void

blur 编辑器失焦，同时收起键盘

# blur 兼容性 ?
Web 微信小程序 Android iOS HarmonyOS
5.08 5.08 5.08 5.08 5.08
# 参数
名称 类型 必填
options UniEditorElementOptions 否
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptions 的属性值
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementInsertImageOptions 的属性值
名称 类型 必备
src string 否
alt string 否
width string 否
height string 否
extClass string 否
data any 否
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementInsertTextOptions 的属性值
名称 类型 必备
text string 否
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementInsertLinkOptions 的属性值
名称 类型 必备
text string 否
href string 是
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementInsertMentionOptions 的属性值
名称 类型 必备 默认值 描述
id string 否 被 @ 的人 id
name string 否 被 @ 的人名字
color string 否 #1677ff 提及文本颜色，默认为 #1677ff
background string 否 #e6f3ff 提及背景颜色，默认为 #e6f3ff
radius string 否 4px 提及圆角，默认为 4px
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementSetContentsOptions 的属性值
名称 类型 必备
delta any 否
html string 否
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementGetContentsOptions 的属性值
名称 类型 必备
success (res: UniEditorElementGetContentsOptionsRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementGetContentsOptionsRes 的属性值
名称 类型 必备
errMsg string 是
delta any 是
html string 是
text string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptions 的属性值
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptions 的属性值
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptions 的属性值
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptions 的属性值
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementGetSelectionTextOptions 的属性值
名称 类型 必备
success (res: UniEditorElementGetSelectionTextOptionsRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementGetSelectionTextOptionsRes 的属性值
名称 类型 必备
errMsg string 是
text string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptions 的属性值
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptions 的属性值
名称 类型 必备
success (res: UniEditorElementOptionsSuccessRes) => void 否
fail (res: UniEditorElementOptionsFailRes) => void 否
complete (res: UniEditorElementOptionsCompleteRes) => void 否
# UniEditorElementOptionsSuccessRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsFailRes 的属性值
名称 类型 必备
errMsg string 是
# UniEditorElementOptionsCompleteRes 的属性值
名称 类型 必备
errMsg string 是

# 参见

# 通用类型

# GeneralCallbackResult

名称 类型 必备 兼容性 描述
errMsg string 是
错误信息
本页导读
uni.createEditorContextAsync(options)
createEditorContextAsync 兼容性
参数
EditorContext 的方法
format(name : string, value ?: string | number | null) : void
insertDivider(options ?: UniEditorElementOptions | null) : void
insertImage(options ?: UniEditorElementInsertImageOptions | null) : void
insertText(options ?: UniEditorElementInsertTextOptions | null) : void
insertLink(options ?: UniEditorElementInsertLinkOptions | null) : void
insertMention(options ?: UniEditorElementInsertMentionOptions | null) : void
setContents(options ?: UniEditorElementSetContentsOptions | null) : void
getContents(options ?: UniEditorElementGetContentsOptions | null) : void
clear(options ?: UniEditorElementOptions | null) : void
removeFormat(options ?: UniEditorElementOptions | null) : void
undo(options ?: UniEditorElementOptions | null) : void
redo(options ?: UniEditorElementOptions | null) : void
getSelectionText(options ?: UniEditorElementGetSelectionTextOptions | null) : void
scrollIntoView(options ?: UniEditorElementOptions | null) : void
blur(options ?: UniEditorElementOptions | null) : void
参见
通用类型
GeneralCallbackResult
uni-agent