Back to Plate

加粗

docs/(plugins)/(marks)/bold.cn.mdx

1.0.02.0 KB
Original Source
<ComponentPreview name="basic-marks-demo" /> <PackageInfo>

功能特性

  • 应用加粗格式以强调重要文本
  • 支持快捷键快速格式化 (Cmd + B)
  • 默认渲染为 <strong> HTML 元素
</PackageInfo>

套件使用

<Steps>

安装

最快捷的添加加粗插件方式是使用 BasicMarksKit,该套件包含预配置的 BoldPlugin 以及其他基础标记及其 Plate UI 组件。

<ComponentSource name="basic-marks-kit" />

添加套件

将套件添加到你的插件中:

tsx
import { createPlateEditor } from 'platejs/react';
import { BasicMarksKit } from '@/components/editor/plugins/basic-marks-kit';

const editor = createPlateEditor({
  plugins: [
    // ...其他插件,
    ...BasicMarksKit,
  ],
});
</Steps>

手动配置

<Steps>

安装

bash
npm install @platejs/basic-nodes

添加插件

在创建编辑器时将 BoldPlugin 包含到 Plate 插件数组中。

tsx
import { BoldPlugin } from '@platejs/basic-nodes/react';
import { createPlateEditor } from 'platejs/react';

const editor = createPlateEditor({
  plugins: [
    // ...其他插件,
    BoldPlugin,
  ],
});

配置插件

你可以为 BoldPlugin 配置自定义快捷键。

tsx
import { BoldPlugin } from '@platejs/basic-nodes/react';
import { createPlateEditor } from 'platejs/react';

const editor = createPlateEditor({
  plugins: [
    // ...其他插件,
    BoldPlugin.configure({
      shortcuts: { toggle: 'mod+b' },
    }),
  ],
});
  • shortcuts.toggle: 定义切换加粗格式的键盘快捷键

添加工具栏按钮

你可以将 MarkToolbarButton 添加到工具栏来切换加粗格式。

</Steps>

插件

BoldPlugin

用于加粗文本格式化的插件。默认渲染为 <strong> HTML 元素。

转换方法

tf.bold.toggle

切换选中文本的加粗格式。

默认快捷键: Cmd + B