Contribute to this guide

指南基本文本样式

基本样式功能允许您应用最基本的格式,例如粗体、斜体、下划线、删除线、下标、上标和代码。与更多格式化功能相结合,这些功能是任何所见即所得编辑器工具集的基础。

# 演示

您可以使用工具栏按钮应用基本格式选项。您还可以利用自动格式化功能,该功能会将 Markdown 代码在您键入时更改为格式化的文本。使用以下任一方法格式化文本

  • 粗体 - 使用粗体工具栏按钮 粗体 或键入 **text**__text__
  • 斜体 - 使用斜体工具栏按钮 斜体 或键入 *text*_text_
  • 代码 - 使用代码工具栏按钮 代码 或键入 `text`
  • 删除线 - 使用删除线工具栏按钮 删除线 或键入 ~~text~~

当您需要使某些内容显得重要时,粗体是正确的选择

您可以使用斜体来表示外来词,例如希腊语的 týpos — “reflection, form” 和 gráphō — “I am writing”,它们一起构成“排版”。

下划线文本应该谨慎使用,因为它非常突出

有时您可能需要将文本标记为已删除。删除线是正确的选择

如果您撰写有关软件的文章,则可以方便地使用标记内联代码的选项,例如 printf("hello, world\n");

还有下标上标类型,这些类型可能在涉及化学或数学的文本中很有用,您需要处理诸如 H2O 或 x2 之类的事物。

此演示展示了有限的功能集。请访问功能丰富的编辑器示例,以查看更多实际应用。

# 可用文本样式

样式功能 命令名称 工具栏组件名称 输出元素
粗体 'bold' 'bold' <strong>bold</strong>
斜体 'italic' 'italic' <i>italic</i>
下划线 'underline' 'underline' <u>underline</u>
删除线 'strikethrough' 'strikethrough' <s>strikethrough</s>
代码 'code' 'code' <code>code</code>
下标 'subscript' 'subscript' <sub>subscript</sub>
上标 'superscript' 'superscript' <sup>superscript</sup>

Code 功能提供对内联代码格式化的支持。要创建具有指定编程语言的预格式化代码块,请使用代码块功能.

# 支持的输入

默认情况下,每个功能都可以上载不止一种类型的內容。以下是从剪贴板粘贴、在启动时加载数据或使用数据 API时每个功能支持的完整元素列表。

样式功能 支持的输入元素
粗体 <strong>, <b>, <* style="font-weight: bold">(或大于或等于 600 的数值)
斜体 <i>, <em>, <* style="font-style: italic">
下划线 <u>, <* style="text-decoration: underline">
删除线 <s>, <del>, <strike>, <* style="text-decoration: line-through">
代码 <code>, <* style="word-wrap: break-word">
下标 <sub>, <* style="vertical-align: sub">
上标 <sup>, <* style="vertical-align: super">

# 在内联代码周围键入

CKEditor 5 允许在代码的内部和外部边界键入,以便让用户更容易编辑。

要在代码元素内键入,将光标移至其(开始或结束)边界。只要代码保持突出显示(默认情况下:透明度较低的灰色),键入和应用格式将在其边界内完成。

The animation showing typing inside the code element in CKEditor 5 rich text editor.

要在代码元素之前或之后键入,将光标移至其边界,然后按一次箭头键()。代码不再突出显示,您键入的任何文本或应用的任何格式都不会包含在代码元素中。

The animation showing typing after the code element in CKEditor 5 rich text editor.

# 安装

⚠️ 新的导入路径

版本 42.0.0 开始,我们更改了导入路径的格式。本指南使用新的、更短的格式。如果您使用的是旧版本的 CKEditor 5,请参考 旧版设置中的包 指南。

安装编辑器 后,将您需要的插件添加到插件列表中。然后,只需配置工具栏项目以使这些功能在用户界面中可用。

import { ClassicEditor, Bold, Code, Italic, Strikethrough, Subscript, Superscript, Underline } from 'ckeditor5';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Bold, Code, Italic, Strikethrough, Subscript, Superscript, Underline ],
        toolbar: {
            items: [ 'bold', 'italic', 'underline', 'strikethrough', 'code', 'subscript', 'superscript'  ]
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

查看这些 CKEditor 5 功能,以更好地控制您的内容样式和格式。

  • 字体样式 – 易于高效地控制字体 大小文本或背景颜色
  • 样式 – 将预先配置的样式应用于编辑器内容中的现有元素。
  • 文本对齐 – 因为内容是左对齐、右对齐、居中对齐还是两端对齐很重要。
  • 大小写更改 – 将文本片段或块转换为大写、小写或标题大小写。
  • 代码块 – 插入更长、多行的代码列表,极大地扩展了内联代码样式。
  • 突出显示 – 标记重要的词语和段落,帮助审查或引起对内容特定部分的注意。
  • 格式刷 – 易于复制文本格式并在编辑文档中的不同位置应用它。
  • 自动格式化 – 使用 Markdown 代码动态格式化文本。
  • 移除格式 – 易于清除基本的文本格式。

您可以使用 移除格式 功能删除所有基本文本样式。

# 通用 API

每个样式功能都会注册一个 命令,该命令可以从代码中执行。例如,以下代码段将对编辑器中的当前选择应用粗体样式。

editor.execute( 'bold' );

我们建议使用官方的 CKEditor 5 检查器 进行开发和调试。它将提供有关编辑器状态的大量有用信息,例如内部数据结构、选择、命令等等。

# 贡献

该功能的源代码可在 GitHub 上找到:https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-basic-styles