块引用

块引用功能允许您轻松地在内容中包含块引用或摘录。它也是吸引读者注意文本特定部分的一种有效方式。

# 演示

使用下面的编辑器中的块引用工具栏按钮 来查看功能的实际操作。您还可以通过在引文之前键入>，然后跟上一个空格，来使用自动格式化功能进行即时格式化。

# 嵌套块引用

从 27.1.0 版开始，CKEditor 5 将正确显示嵌套在另一个块引用中的块引用。这种结构在电子邮件编辑器或论坛中是必不可少的。引用先前消息并保留正确的引文结构的能力对于维护沟通流程通常至关重要。嵌套块引用也可能对科学或学术论文有用，但引用来源和引用先前写作的文章也会经常使用它。

嵌套块引用的支持是作为向后兼容性提供的，用于加载预先存在的内容，例如在 CKEditor 4 中创建的内容。此外，粘贴包含嵌套块引用的内容也受支持。您还可以使用拖放机制将块引用嵌套在另一个块引用中——只需选择一个现有块引用并将其拖放到另一个块引用中。

# 安装

在安装编辑器后，将此功能添加到插件列表和工具栏配置中

import { ClassicEditor, BlockQuote } from 'ckeditor5';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ BlockQuote, /* ... */ ],
        toolbar: [ 'blockQuote', /* ... */ ]
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# 配置

# 禁止嵌套引用块

默认情况下，编辑器支持将引用块插入另一个引用块中。

要禁止嵌套引用块，您需要注册一个额外的模式规则。它需要在将数据加载到编辑器之前添加，因此最好将其作为插件实现。

function DisallowNestingBlockQuotes( editor ) {
    editor.model.schema.addChildCheck( ( context, childDefinition ) => {
        if ( context.endsWith( 'blockQuote' ) && childDefinition.name == 'blockQuote' ) {
            return false;
        }
    } );
}

// Pass it via config.extraPlugins or config.plugins:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        extraPlugins: [ DisallowNestingBlockQuotes ],

        // The rest of the configuration.
        // ...
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# 相关功能

以下是一些其他 CKEditor 5 功能，您可以像引用块插件一样使用它们来更好地组织文本

• 块缩进 – 设置文本块（如段落或列表）的缩进。
• 代码块 – 插入更长、多行的代码列表。
• 文本对齐 – 将您的内容左对齐、右对齐、居中或两端对齐。
• 自动格式化 – 当您使用 Markdown 代码键入时，添加格式化元素（如引用块）。

# 常用 API

BlockQuote 插件注册

• 由引用块 UI 功能实现的'blockQuote' UI 按钮组件，
• 由引用块编辑功能实现的'blockQuote' 命令。

您可以使用editor.execute()方法执行命令

// Applies block quote to the selected content.
editor.execute( 'blockQuote' );

# 贡献

该功能的源代码可在 GitHub 上获取，地址为https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-block-quote。