Skip to content

富文本

EditorContext

功能說明: EditorContext實例,可通過wx.createSelectorQuery 獲取,EditorContext通過id跟一個editor組件綁定,操作對應的editor組件。

.blur

TIP

該API使用方法為: EditorContext.blur(Object object)

  • 功能說明: 編輯器失焦,同時收起鍵盤。
  • 參數及說明: Object object
    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)

.clear

TIP

該API使用方法為: EditorContext.clear(Object object)

  • 功能說明: 清空編輯器內容。
  • 參數及說明: Object object
    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)

.format

TIP

該API使用方法為: EditorContext.format(string name, string value)

  • 功能說明: 修改樣式。

  • 參數及說明:

    • string name,内容;
    • string value, 值
  • 支持設定的樣式清單:

    namevalue
    bold-
    italic-
    underline-
    strike-
    ins-
    scriptsub / super
    headerH1 / H2 / h3 / H4 / h5 / H6
    alignleft / center / right / justify
    directionrtl
    indent-1 / +1
    listordered / bullet / check
    colorhex color
    backgroundColorhex color
    margin/marginTop/marginBottom/marginLeft/marginRightcss style
    padding/paddingTop/paddingBottom/paddingLeft/paddingRightcss style
    font/fontSize/fontStyle/fontVariant/fontWeight/fontFamilycss style
    lineHeightcss style
    letterSpacingcss style
    textDecorationcss style
    textIndentcss style
    wordWrapcss style
    wordBreakcss style
    whiteSpacecss style
  • 對已經應用樣式的選區設定會取消樣式。 css style表示css中規定的允許值。

.getContents

TIP

該API使用方法為: EditorContext.getContents(Object object)

  • 功能說明: 獲取編輯器內容。

  • 參數及說明: Object object

    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)
    • object.success 回呼函數

    參數 Object.res

    内容類型說明
    htmlstring帶標籤的HTML內容
    textstring純文字內容
    deltaObject表示內容的delta對象

.getSelectionText

TIP

該API使用方法為: EditorContext.getSelectionText(Object object)

  • 功能說明: 獲取編輯器已選區域內的純文字內容。 當編輯器失焦或未選中一段區間時,返回內容為空。

  • 參數及說明: Object object

    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)
    • object.success 回呼函數

    參數 Object.res

    内容類型說明
    textstring純文字內容

.insertDivider

TIP

該API使用方法為: EditorContext.insertDivider(Object object)

  • 功能說明: 插入分割線。
  • 參數及說明: Object object
    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)

.insertlmage

TIP

該API使用方法為: EditorContext.insertlmage(Object object)

  • 功能說明: 插入圖片。

    • 地址為暫存文件時,獲取的編輯器html格式內容中標籤新增内容data-local,deta格式內容中圖片attributes内容新增data-local欄位,該值為傳入的暫存文件地址。
    • 開發者可選擇在提交階段上傳圖片到伺服器,取得到網路位址後進行替換。替換時對於 html 內容應替換掉 的 src 值,對於 delta 內容應替換掉 insert { image: abc } 值。
  • 參數及說明: Object object

    内容類型預設值必填說明
    srcstring-圖片地址,僅支持http(s)、base64、暫存文件
    nowrapbooleanfalse插入圖片後是否自動換行,默認換行
    altstring-影像無法顯示時的替代文字
    widthstring-圖片寬度(pixels/百分比)
    heightstring-圖片高度(pixels/百分比)
    extClassstring-添加到圖片img標籤上的類名
    dataObject-data被序列化為name=value; name1=value2的格式掛在内容data-custom上
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(調用成功、失敗都會執行)
  • 示例代碼:

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

.insertText

TIP

該API使用方法為: EditorContext.insertText(Object object)

  • 功能說明: 覆蓋當前選區,設定一段文字。
  • 參數及說明: Object object
    内容類型預設值必填說明
    textstring-文字內容
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)

.redo

TIP

該API使用方法為: EditorContext.redo(Object object)

  • 功能說明: 恢復
  • 參數及說明: Object object
    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)

.removeFormat

TIP

該API使用方法為: EditorContext.removeFormat(Object object)

  • 功能說明: 清除當前選區的樣式。
  • 參數及說明: Object object
    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)

.scrolllntoView

TIP

該API使用方法為: EditorContext.scrollIntoView()

  • 功能說明: 使得編輯器光標處滾動到視窗可視區域內。

.setContents

TIP

該API使用方法為: EditorContext.setContents(Object object)

  • 功能說明: 初始化編輯器內容,html和delta同時存在時僅delta生效。
  • 參數及說明: Object object
    内容類型預設值必填說明
    htmlstring-帶標籤的HTML內容
    deltaObject-表示內容的delta對象
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)

.undo

TIP

該API使用方法為: EditorContext.undo(Object object)

  • 功能說明: 撤銷。
  • 參數及說明: Object object
    内容類型預設值必填說明
    successFunction-接口調用成功的回呼函數
    failFunction-接口調用失敗的回呼函數
    completeFunction-接口調用結束的回呼函數(無論成功與否都執行)