移除格式

移除格式功能允许您快速移除任何使用内联 HTML 元素和 CSS 样式应用的文字格式，例如 基本文字样式（粗体、斜体）或 字体系列、大小和颜色。此功能不会移除块级格式（标题、图像）或语义数据（链接）。

# 演示

选择您要清理的内容，然后按工具栏中的移除格式按钮 。

# 安装

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

import { ClassicEditor, RemoveFormat } from 'ckeditor5';

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

# 配置移除格式功能

此功能没有集成级别的配置。启用后，它开箱即用地与所有 核心编辑器功能 协同工作。

# 关于编辑器中内容类型的简短说明

移除格式功能旨在帮助用户清理内容中不必要的格式。每个编辑器功能都为所见即所得编辑器带来了自己的内容类型。如果您不希望不必要的格式一开始就启用，您可能需要考虑减少编辑器中启用的功能数量。

这样做可以避免用户每次从其他程序粘贴内容时都要手动移除格式的麻烦，使编辑体验更加流畅。更窄的编辑器功能集还能让您更好地控制保存到数据库中的内容，并防止意外使用您不希望存储在应用程序中的内容类型。

# 与编辑器功能集成

为了使移除格式功能与自定义内容协同工作，您需要通过在自定义 文本属性 上设置 isFormatting 属性来更新 模式。

这已经针对 通用 HTML 支持 插件及其衍生插件（如 样式 插件）支持的大多数内联元素完成了。

默认情况下，不会从 链接 元素中移除格式。要从它们中移除格式，您需要创建一个 插件 来扩展模式，并告诉编辑器链接功能生成的 linkHref 文本属性是格式化属性

// A simple plugin that extends the remove format feature to consider links.
function RemoveFormatLinks( editor ) {
    // Extend the editor schema and mark the "linkHref" model attribute as formatting.
    editor.model.schema.setAttributeProperties( 'linkHref', {
        isFormatting: true
    } );
}

在 配置 中启用 RemoveFormatLinks 插件并运行编辑器

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [
            RemoveFormat,
            RemoveFormatLinks,
            // More plugins.
            // ...
        ],
        toolbar: [
            'removeFormat',
            // More toolbar items.
            // ...
        ]
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

从现在开始，移除格式按钮也应该移除内容中的链接。 详细了解属性属性。

# 相关功能

CKEditor 5 提供了更多功能来帮助您格式化内容。

• 基本文本样式 – 包括必要的样式，如粗体、斜体等。
• 字体样式 – 轻松高效地控制字体 家族、大小、文本或背景颜色。
• 格式刷 – 轻松复制文本格式并将其应用于编辑文档中的其他位置。
• 文本对齐 – 将您的内容左对齐、右对齐、居中对齐或两端对齐。

# 通用 API

RemoveFormat 插件注册了'removeFormat' UI 按钮组件以及由 RemoveFormatCommand 实现的同名命令。

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

// Removes all the formatting in the selection.
editor.execute( 'removeFormat' );

# 贡献

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