W3Cschool
恭喜您成為首批注冊(cè)用戶
獲得88經(jīng)驗(yàn)值獎(jiǎng)勵(lì)
Editor 富文本編輯器動(dòng)態(tài)庫(kù)提供了支持富文本編輯的 ?editor
?組件和操作?editor
?組件的?createEditorContext
?方法,通過使用該動(dòng)態(tài)庫(kù),用戶可以對(duì)圖片、文本進(jìn)行編輯。編輯器導(dǎo)出內(nèi)容支持帶標(biāo)簽的html和純文本的text,編輯器內(nèi)部采用delta格式進(jìn)行存儲(chǔ)。
富文本編輯器組件中設(shè)置了一些基本樣式使得內(nèi)容可以正確展示,在開發(fā)過程中可以進(jìn)行覆蓋,在其他組件或者環(huán)境中使用富文本編輯器導(dǎo)出的?html
?時(shí),需要額外維護(hù)以下?DOM
?結(jié)構(gòu):
<ql-container>
<ql-editor></ql-editor>
</ql-container>
參考使用動(dòng)態(tài)庫(kù)中提供的方法,在 app.json 中增添一項(xiàng) dynamicLib,與 pages 同級(jí)。
"dynamicLib": {
"editorLib": {
"provider": "swan-editor"
}
},
在每個(gè)使用到富文本編輯器組件的頁(yè)面,配置 *.json 文件如:
{
"usingSwanComponents": {
"editor": "dynamicLib://editorLib/editor"
}
}
<editor
read-only="{{readOnly}}"
placeholder="{{placeholder}}"
/>
這是一種最基本的使用方式,其中readOnly和placeholder的值可以在 *.js 文件中設(shè)置。
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
read-only | Boolean | false | 否 | 設(shè)置編輯器為只讀 |
placeholder | String | 否 | 編輯器提示信息 | |
show-img-size | Boolean | false | 否 | 點(diǎn)擊圖片時(shí)顯示圖片大小控件 |
show-img-resize | Boolean | false | 否 | 點(diǎn)擊圖片時(shí)顯示圖片縮放控件 |
show-img-toolbar | Boolean | false | 否 | 點(diǎn)擊圖片時(shí)顯示圖片工具欄控件 |
bindready | EventHandle | 否 | 編輯器初始化完成時(shí)觸發(fā) | |
bindfocus | EventHandle | 否 | 編輯器聚焦時(shí)觸發(fā),event.detail = { html, text, delta } | |
bindblur | EventHandle | 否 | 編輯器失去焦點(diǎn)時(shí)觸發(fā),event.detail = { html, text, delta } | |
bindinput | EventHandle | 否 | 編輯器內(nèi)容改變時(shí)觸發(fā),event.detail = { html, text, delta } | |
bindstatuschange | EventHandle | 否 | 編輯器內(nèi)容或樣式通過EditorContext 中的方法改變時(shí)觸發(fā),返回選區(qū)已設(shè)置的樣式 |
Page({
data: {
readOnly: false,
placeholder: '請(qǐng)輸入...'
}
});
編輯器內(nèi)支持部分HTML
標(biāo)簽和內(nèi)聯(lián)樣式,但不支持
class
和id
。
不滿足的標(biāo)簽會(huì)被忽略,
div
標(biāo)簽會(huì)被轉(zhuǎn)換為p
標(biāo)簽存儲(chǔ)。
類型 | 節(jié)點(diǎn) |
---|---|
行內(nèi)元素 | <span> <strong> <b> <em> <i> <u> <a> <s> <sub> <sup> <img>
|
塊級(jí)元素 | <br> <hr> <ol> <ul> <li> <h1> <h2> <h3> <h4> <h5> <h6>
|
內(nèi)聯(lián)樣式僅支持設(shè)置在行內(nèi)元素或塊級(jí)元素上,不能同時(shí)設(shè)置,如 text-align
歸類為塊級(jí)樣式,在
span
標(biāo)簽上設(shè)置是無(wú)效的。
類型 | 樣式 |
---|---|
塊級(jí)樣式 | text-align
direction
|
行內(nèi)樣式 | color
background-color
|
Editor 富文本編輯器動(dòng)態(tài)庫(kù)提供了 createEditorContext
的方法來(lái)獲取某個(gè)
editor
組件的實(shí)例,EditorContext
通過
id
和 一個(gè) editor
組件綁定,操作對(duì)應(yīng)的
editor
組件。
Page({
onEditorReady() {
this.editorCtx = requireDynamicLib('editorLib').createEditorContext('editorId');
}
});
解釋: 編輯器失焦
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 清空編輯器內(nèi)容
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 修改格式
對(duì)已經(jīng)應(yīng)用樣式的選區(qū)設(shè)置會(huì)取消樣式。
參數(shù)
string name: 屬性
string value: 值
支持設(shè)置的樣式列表
name | value |
---|---|
bold | |
italic | |
underline | |
strike | |
ins | |
script | sub / super |
header | H1 / H2 / H3 / H4 / H5 / H6 |
align | center / right / justify |
direction | rtl |
indent | -1 / +1 |
list | ordered / bullet / check |
color | hex color |
backgroudColor | hex color |
解釋: 獲取編輯器內(nèi)容
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
object.success 回調(diào)函數(shù)
參數(shù): Object res
屬性 | 類型 | 說明 |
---|---|---|
html | String | 帶標(biāo)簽的html 內(nèi)容 |
text | String | 純文本內(nèi)容 |
delta | Object | 描述內(nèi)容的delta 對(duì)象 |
解釋: 獲取編輯器內(nèi)選區(qū)的純文本內(nèi)容。當(dāng)編輯器失焦或未選中一段區(qū)間時(shí),返回內(nèi)容為空
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
object.success 回調(diào)函數(shù)
參數(shù): Object res
屬性 | 類型 | 說明 |
---|---|---|
text | String | 純文本內(nèi)容 |
解釋: 插入分隔符
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 插入圖片
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
src | String | 是 | 圖片地址,目前僅支持 http(s)、base64、本地圖片 | |
alt | String | 否 | 圖片無(wú)法顯示時(shí)的替代文本 | |
extClass | String | 否 | 添加到圖片 img 標(biāo)簽上的類名 | |
data | Object | 否 | data 會(huì)被序列化為 name1=value1&name2=value2 的格式掛在屬性 data-custom 上 | |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 覆蓋當(dāng)前選區(qū),設(shè)置一段文本
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
text | String | 否 | 文本內(nèi)容 | |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 清除當(dāng)前選區(qū)的樣式
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 初始化編輯器內(nèi)容,html和delta同時(shí)存在時(shí)僅delta生效
需要注意的是,通過setContents設(shè)置編輯器內(nèi)容時(shí),由于支持的html標(biāo)簽和內(nèi)聯(lián)樣式有限,建議開發(fā)者在小程序內(nèi)通過delta進(jìn)行插入。
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
html | String | 否 | 帶標(biāo)簽的html 內(nèi)容 | |
delta | Object | 否 | 描述內(nèi)容的delta 對(duì)象 | |
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 將編輯器光標(biāo)處滾動(dòng)到窗口可視區(qū)域內(nèi)
解釋: 恢復(fù)
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
解釋: 撤銷
參數(shù): Object object
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
success | Function | 否 | 接口調(diào)用成功的回調(diào)函數(shù) | |
fail | Function | 否 | 接口調(diào)用失敗的回調(diào)函數(shù) | |
complete | Function | 否 | 接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) |
Copyright©2021 w3cschool編程獅|閩ICP備15016281號(hào)-3|閩公網(wǎng)安備35020302033924號(hào)
違法和不良信息舉報(bào)電話:173-0602-2364|舉報(bào)郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號(hào)
聯(lián)系方式:
更多建議: