微信小程序API 富文本

2022-04-29 15:17 更新

EditorContext

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

EditorContext 實例,可通過 wx.createSelectorQuery 獲取。

EditorContext 通過 id 跟一個 editor 組件綁定,操作對應的 editor 組件。

方法:

EditorContext.blur(Object object)

基礎庫 2.8.3 開始支持,低版本需做兼容處理。

編輯器失焦,同時收起鍵盤。

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


EditorContext.clear(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

清空編輯器內容

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


EditorContext.format(string name, string value)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

修改樣式

參數(shù)

string name

屬性

string value

支持設置的樣式列表

namevalueverson
bold2.7.0
italic2.7.0
underline2.7.0
strike2.7.0
ins2.7.0
scriptsub / super2.7.0
headerH1 / H2 / h3 / H4 / h5 / H62.7.0
alignleft / center / right / justify2.7.0
directionrtl2.7.0
indent-1 / +12.7.0
listordered / bullet / check2.7.0
colorhex color2.7.0
backgroundColorhex color2.7.0
margin/marginTop/marginBottom/marginLeft/marginRightcss style2.7.0
padding/paddingTop/paddingBottom/paddingLeft/paddingRightcss style2.7.0
font/fontSize/fontStyle/fontVariant/fontWeight/fontFamilycss style2.7.0
lineHeightcss style2.7.0
letterSpacingcss style2.7.0
textDecorationcss style2.7.0
textIndentcss style2.8.0
wordWrapcss style2.10.2
wordBreakcss style2.10.2
whiteSpacecss style2.10.2

對已經(jīng)應用樣式的選區(qū)設置會取消樣式。css style 表示 css 中規(guī)定的允許值。


EditorContext.getContents(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

獲取編輯器內容

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)

object.success 回調函數(shù)

參數(shù)
Object res
屬性類型說明
htmlstring帶標簽的HTML內容
textstring純文本內容
deltaObject表示內容的delta對象


EditorContext.getSelectionText(Object object)

基礎庫 2.10.2 開始支持,低版本需做兼容處理。

獲取編輯器已選區(qū)域內的純文本內容。當編輯器失焦或未選中一段區(qū)間時,返回內容為空。

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)

object.success 回調函數(shù)

參數(shù)
Object res
屬性類型說明
textstring純文本內容


EditorContext.insertDivider(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

插入分割線

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


EditorContext.insertImage(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

插入圖片。

地址為臨時文件時,獲取的編輯器html格式內容中 <img> 標簽增加屬性 data-local,delta 格式內容中圖片 attributes 屬性增加 data-local 字段,該值為傳入的臨時文件地址。

開發(fā)者可選擇在提交階段上傳圖片到服務器,獲取到網(wǎng)絡地址后進行替換。替換時對于html內容應替換掉 <img> 的 src 值,對于 delta 內容應替換掉 insert { image: abc } 值。

參數(shù)

Object object

屬性類型默認值必填說明
srcstring圖片地址,僅支持 http(s)、base64、云圖片(2.8.0)、臨時文件(2.8.3)。
altstring圖像無法顯示時的替代文本
widthstring圖片寬度(pixels/百分比)
heightstring圖片高度 (pixels/百分比)
extClassstring添加到圖片 img 標簽上的類名
dataObjectdata 被序列化為 name=value;name1=value2 的格式掛在屬性 data-custom 上
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)

示例代碼

this.editorCtx.insertImage({
  src: 'xx',
  width: '100px',
  height: '50px',
  extClass: className
})


EditorContext.insertText(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

覆蓋當前選區(qū),設置一段文本

參數(shù)

Object object

屬性類型默認值必填說明
textstring文本內容
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


EditorContext.redo(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

恢復

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


EditorContext.removeFormat(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

清除當前選區(qū)的樣式

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


EditorContext.scrollIntoView()

基礎庫 2.8.3 開始支持,低版本需做兼容處理。

使得編輯器光標處滾動到窗口可視區(qū)域內。


EditorContext.setContents(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

初始化編輯器內容,html和delta同時存在時僅delta生效

參數(shù)

Object object

屬性類型默認值必填說明
htmlstring帶標簽的HTML內容
deltaObject表示內容的delta對象
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


EditorContext.undo(Object object)

基礎庫 2.7.0 開始支持,低版本需做兼容處理。

撤銷

參數(shù)

Object object

屬性類型默認值必填說明
successfunction接口調用成功的回調函數(shù)
failfunction接口調用失敗的回調函數(shù)
completefunction接口調用結束的回調函數(shù)(調用成功、失敗都會執(zhí)行)


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號