am-editor-002/docs/plugin/plugin-heading.zh-CN.md

# @aomao/plugin-heading

标题样式插件

## 安装

```bash
$ yarn add @aomao/plugin-heading
```

添加到引擎

```ts
import Engine, { EngineInterface } from '@aomao/engine';
import Heading from '@aomao/plugin-heading';

new Engine(...,{ plugins:[Heading] })
```

## 可选项

### 锚点

开启后在标题左边出现可复制锚点按钮

```ts
showAnchor?: boolean;
```

当点击复制锚点的时候触发，传入当前标题的 id 值，返回的内容将写入到用户的粘贴板上，默认将返回当前 url+id

```ts
anchorCopy?:(id:string) => string
```

### 快捷键

```ts
//快捷键
hotkey?: {
    h1?: string;//标题1，默认 mod+opt+1
    h2?: string;//标题2，默认 mod+opt+2
    h3?: string;//标题3，默认 mod+opt+3
    h4?: string;//标题4，默认 mod+opt+4
    h5?: string;//标题5，默认 mod+opt+5
    h6?: string;//标题6，默认 mod+opt+6
};
//使用配置
new Engine(...,{
    config:{
        "heading":{
            //修改快捷键
            hotkey:{
                h1:"快捷键"
            }
        }
    }
 })
```

### Markdown

默认支持 markdown，传入`false`关闭

Heading 插件 markdown 语法为`#` `##` `###` `####` `#####` `######`

```ts
markdown?: boolean;//默认开启，false 关闭
//使用配置
new Engine(...,{
    config:{
        "heading":{
            //关闭markdown
            markdown:false
        }
    }
 })
```

### 禁用 mark 插件样式效果

可以在标题下禁用 mark 插件效果，默认禁用 ['fontsize', 'bold'] ，在分割、粘贴等情况下过滤掉这些插件样式

```ts
disableMark?: Array<string> //mark插件名称集合
```

### 要启用的类型（h1 h2 h3 h4 h5 h6）

可以定义 h1 - h6 所需要的节点类型，如果不定义则支持全部

设置后 markdown 也会失效

```ts
enableTypes?: Array<string>
```

另外可能还需要配置 toolbar 中 items 属性的 heading 插件

```ts
{
    type: 'dropdown',
    name: 'heading',
    items: [
        {
            key: "p",
            className: 'heading-item-p',
            content: "正文"
        },
        {
            key: "h1",
            className: 'heading-item-h1',
            content: "标题1"
        }
    ]
    }
```

## 命令

传入 `p` 或当前标题样式与当前传入值一致 时将取消标题

```ts
//使用 command 执行插件、并传入所需参数
engine.command.execute(
	'heading',
	'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p',
);
//使用 command 执行查询当前状态，返回 string | undefined，返回 "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "p"
engine.command.queryState('heading');
```

## 大纲

生成标题的大纲数据

需要从 `@aomao/plugin-heading` 导入 `Outline` 类

```ts
import { Outline } from '@aomao/plugin-heading';
```

### `normalize`

将标题节点数据归一化为带深度层级的结构

```ts
/**
 * 将 heading 数据归一化为带深度层级的结构
 * 归一化后，每个元素的结构为:
 * {
 *   id: string,       // id
 *   title: string,    // 标题
 *   level: number ,   // 标题层级
 *   domNode: Node,    // dom 节点
 *   depth: number     // 展示深度
 * }
 * depth 的算法和 Google Docs 的一致
 * - 效果：h1 -> h4 分配固定的 depth，保证相同 level 的标题最终的层级深度是一样的
 * - 算法：找出文档存在的标题层级；按层级由大到小依次分别分配缩进深度；
 * @param {Element[]}headings heading 的标准 DOM 节点数组
 *
 * @return {Array} 标题节点数组
 */
normalize(headings: Array<Element>): OutlineData[];
```

### `getFromDom`

从 DOM 节点提取大纲

```ts
/**
 * 从 DOM 节点提取大纲
 * @param {Element} rootNode 根节点
 * @return {Array}
 */
getFromDom(rootNode: Element): OutlineData[];
```

### 例子

```ts
import React, { useRef, useEffect, useState, useCallback } from 'react';
import { $, EditorInterface } from '@aomao/engine';
import { Outline, OutlineData } from '@aomao/plugin-heading';

type Props = {
	editor: EditorInterface;
};

const outline = new Outline();

const Toc: React.FC<Props> = ({ editor }) => {
	const rootRef = useRef<HTMLDivElement | null>(null);
	const [datas, setDatas] = useState<Array<OutlineData>>([]);

	useEffect(() => {
		const onChange = () => {
			//获取大纲数据
			const data = getTocData();
			setDatas(data);
		};
		//绑定编辑器值改变事件
		editor.on('change', onChange);
		setTimeout(() => {
			onChange();
		}, 50);
		return () => editor.off('change', onChange);
	}, [editor]);

	const getTocData = useCallback(() => {
		// 从编辑区域提取符合结构要求的标题 Dom 节点
		let nodes: Array<Element> = [];
		const { card } = editor;
		editor.container.find('h1,h2,h3,h4,h5,h6').each((child) => {
			const node = $(child);
			// Card 里的标题，不纳入大纲
			if (card.closest(node)) {
				return;
			}
			// 非一级深度标题，不纳入大纲
			if (!node.parent()?.isRoot()) {
				return;
			}
			nodes.push(node.get<Element>()!);
		});
		return outline.normalize(nodes);
	}, []);

	return (
		<div className="data-toc-wrapper">
			<div className="data-toc-title">大纲</div>
			<div className="data-toc" ref={rootRef}>
				{datas.map((data, index) => {
					return (
						<a
							key={index}
							href={'#' + data.id}
							className={`data-toc-item data-toc-item-${data.depth}`}
						>
							{data.text}
						</a>
					);
				})}
			</div>
		</div>
	);
};
export default Toc;
```