quill.js官方文档(二)【API之Content】

刺骨的言语ヽ痛彻心扉 2021-07-04 18:02 1003阅读 0赞

### `deleteText` ###

从编辑器中删除文本，返回代表对应变化的`Delta`数据。Source可能是 “`user`”、 “`api`” 或者 “`silent`”。当编辑器不可用\[disabled\]\#disable且`source`参数为“`user`”时，调用将被忽略。  
**方法**

deleteText(index: Number, length: Number, source: String = 'api'): Delta

**示例**

quill.deleteText(6, 4);

### `getContents` ###

返回编辑器的内容——包含格式数据的`Delta`数据。

**方法**

getContents(index: Number = 0, length: Number = remaining): Delta

**示例**

var delta = quill.getContents();

### `getLength` ###

返回编辑器内容的长度。注意，当Quill为空时，仍然包含一个由’`\n`'解析成的空行，所以`getLength`将返回`1`。

**方法**

getLength(): Number

**示例**

var length = quill.getLength();

### `getText` ###

返回编辑器的字符串内容。由于非字符串内容会被忽略掉，所以返回字符串内容的长度会比`getLength`返回的长度小。注意，尽管Quill为空，编辑器里仍有一行空行，所以这种情况会返回”`\n`”。

`length`参数默认为剩余文档的长度。  
**方法**

getText(index: Number = 0, length: Number = remaining): String

**示例**

var text = quill.getText(0, 10);

### `insertEmbed` ###

插入嵌入对象内容到编辑器，返回代表对应变化的`Delta`数据。 `Source`可能是 “`user`”、 “`api`” 或者 “`silent`”。当编辑器不可用\[disabled\]\#disable且`source`参数为“`user`”时，调用将被忽略。

**方法**

insertEmbed(index: Number, type: String, value: any, source: String = 'api'): Delta

**示例**

quill.insertEmbed(10, 'image', 'https://quilljs.com/images/cloud.png');

### `insertText` ###

向编辑器中插入文本，可选带有指定的文本格式或多个文本格式，返回代表对应变化的`Delta`数据。  
`Source`可能是 “`user`”、 “`api`” 或者 “`silent`”。当编辑器不可用\[disabled\]\#disable且`source`参数为“`user`”时，调用将被忽略。

**方法**

insertText(index: Number, text: String, source: String = 'api'): Delta
    insertText(index: Number, text: String, format: String, value: any,
               source: String = 'api'): Delta
    insertText(index: Number, text: String, formats: {  [String]: any },
               source: String = 'api'): Delta

**示例**

quill.insertText(0, 'Hello', 'bold', true);
    
    quill.insertText(5, 'Quill', { 
      'color': '#ffff00',
      'italic': true
    });

### `setContents` ###

用给定的内容覆盖原编辑器内容。内容将会用换行符结尾。返回代表对应变化的`Delta`数据。如果给定的`Delta`没有无效的操作，返回值和传入的值相同。

`Source`可能是 “`user`”、 “`api`” 或者 “`silent`”。当编辑器不可用\[disabled\]\#disable且`source`参数为“`user`”时，调用将被忽略。

**方法**

setContents(delta: Delta, source: String = 'api'): Delta

**示例**

quill.setContents([
      {  insert: 'Hello ' },
      {  insert: 'World!', attributes: {  bold: true } },
      {  insert: '\n' }
    ]);

### `setText` ###

用给定的文本设置为编辑器的内容，返回代表对应变化的 `Delta`数据。注意，`Quill`文档必须以换行符结尾，如果没有则会自动添加。  
`Source`可能是 “`user`”、 “`api`” 或者 “`silent`”。当编辑器不可用\[disabled\]\#disable且`source`参数为“`user`”时，调用将被忽略。

**方法**

setText(text: String, source: String = 'api'): Delta

**示例**

quill.setText('Hello\n');

### `updateContents` ###

让编辑器内容执行`Delta`数据方法，返回代表对应变化的 `Delta`数据。如果给定的`Delta`没有无效的操作，返回值和传入的值相同。  
`Source`可能是 “`user`”、 “`api`” 或者 “`silent`”。当编辑器不可用\[disabled\]\#disable且`source`参数为“`user`”时，调用将被忽略。

**方法**

updateContents(delta: Delta, source: String = 'api'): Delta

**示例**

// Assuming editor currently contains [{ insert: 'Hello World!' }]
    quill.updateContents(new Delta()
      .retain(6)                  // Keep 'Hello '
      .delete(5)                  // 'World' is deleted
      .insert('Quill')
      .retain(1, {  bold: true })  // Apply bold to exclamation mark
    );
    // Editor should now be [
    // { insert: 'Hello Quill' },
    // { insert: '!', attributes: { bold: true} }
    // ]