Quill中文文档
  • 简介
  • 文档(Document)
    • 快速开始(QuickStart)
    • 下载(Download)
    • 配置项(Configuration)
    • 格式化(Formats)
    • API
      • content
      • formatting
      • selection
      • editor
      • events
      • model
      • extension
    • Delta
    • 模块(Modules)
      • 工具栏(Toolbar)
      • 键盘(Keyboard)
      • 历史(History)
      • 剪贴板(Clipboard)
      • 格式化(Formula)
      • 语法高亮(Syntax Highlighter)
    • 主题(Themes)
  • 指南(Guides)
    • 为什么要用Quill?(Why Quill)
    • 怎么自定义Quill
    • 将Quill添加到你的构建系统
    • 构建自定义模块
    • 通过Parchment克隆Medium
    • 设计Delta的格式
    • 与其他富文本编辑器对比
    • 升级到1.0
  • 其他相关库(Other)
    • Parchment
    • 自定义总结
  • 更新日志
Powered by GitBook
On this page
  • 容器
  • 配置项
  1. 文档(Document)

配置项(Configuration)

Previous下载(Download)Next格式化(Formats)

Last updated 5 years ago

Quill允许通过多种方式来定制它以适应你的需求。本节致力于调整现有的功能。请参阅部分添加新功能和添加主题。

容器

Quill需要在编辑器中追加一个容器。你可以传入css选择器或者DOM对象。

var editor = new Quill('.editor');  // 将是使用第一个匹配的元素
var container = document.getElementById('editor');
var editor = new Quill(container);
var container = $('.editor').get(0);
var editor = new Quill(container);

配置项

通过传入一个配置项对象来配置Quill。

var options = {
  debug: 'info',
  modules: {
    toolbar: '#toolbar'
  },
  placeholder: 'Compose an epic...',
  readOnly: true,
  theme: 'snow'
};
var editor = new Quill('#editor', options);

以下的配置参数会被识别:

bounds

  • Default:document.body

DOM元素或者一个DOM元素的css选择器,其中编辑器的UI元素(例如:tooltips)应该被包含其中。目前,只考虑左右边界。

debug

  • Default:warn

debug的开关。注意:debug是一个静态方法并且会影响同一个页面的其它编辑器实例。只用警告和错误信息是默认启用的。

formats

  • Default:All formats

modules

placeholder

  • Default:none

编辑器为空时显示的占位符。

readOnly

  • Default:false

是否将编辑器是实例设置为只读模式。

scrollingContainer

  • Default:null

DOM元素或者一个DOM元素的css选择器,指定改容器具有滚动条(例如:overflow-y: auto),如果已经被用户自定义了默认的ql-editor。当Quill设置为自动适应高度是,需要修复滚动跳转的错误,并且另一个父容器负责滚动。

注意:当使用body时,一些浏览器仍然会跳转。可以使用一个单独的div子节点来避免这种情况。

strict

  • Default:true

根据对semver的严格解释,一些改进和修改将保证主要版本的碰撞。为了防止扩大版本号的微小变化,它们被这个严格的标志禁止。具体的变化可以在Changelog中找到并搜索“strict”。将其设置为false可能会影响将来的改进。

theme

在编辑器中允许的格式白名单。请参阅以获取完整列表。

包含的模块和相应的选项。请参阅以获取更多信息。

使用的主题名称。内置的选项有“bubble”和“snow”。无效或者假的值将加载默认的最小主题。注意:主题的特定样式仍然需要手动包含。请参阅了解更多信息。

模块(Modules)
主题(Themes)
格式化
模块
主题