G6 5.0 官网内容走查

[Aarebecca]

文档内容

格式要求

• 模版

## 属性名

**类型**：`string | number`
**默认值**：`''`

属性描述说明

## Property

**Type**: `string | number`
**Default**: `''`

Property Description

• 可选性
  属性值默认可选，如果有属性为必须的，在属性名后面添加徽标

## 属性名 <Badge type="error">必须</Badge>

## Property <Badge type="error">Required</Badge>

• 多个类型合并显示

✅

`string | number`

❌

`string` | `number`

• 类型声明

✅

`(event: IG6GraphEvent) => boolean`

❌

`type TypeName = (event: IG6GraphEvent) => boolean`

❌

```ts

type TypeName = (event: IG6GraphEvent) => boolean

```

• 复杂类型

类型描述采用单行描述，如果有类型较为复杂。

此时如果类型有相关跳转链接，则在下方附上链接

- [TypeName](link/to/type/definition)

否则在在下方通过折叠块完整显示

**类型**：`complexType`

<details>
  <summary style="color: #873bf4; cursor: pointer;">
    <!-- 类型名 -->
  </summary>
  <!-- 类型定义 -->
</details>

复杂类型注释位于属性上方，以代码块的形式

```ts

type TypeName = {
    /** 类型 A 的描述 */
    propertyA: number;
    /** 类型 B 的描述 */
    propertyB: string;
}

```

• 引用类型

如果类型中引用了其他类型，参考上方复杂类型的处理方式，将该类型通过折叠块完整展示

• 默认值

默认值规则同类型，单行能写下的就单行描述。否则使用折叠块形式

示例：

默认值：object

Details

object ```json { property: 1 } ```

内容完善

• [入门教程] 添加 React 使用 G6 教程 @Aarebecca
• [自定义X类型扩展] 补充代码示例 @yvonneyx
• [自定义交互] @Aarebecca
• [自定义主题] @yvonneyx
• [自定义布局] TBD
• [自定义插件] @Aarebecca
• [自由插件] @Aarebecca
• [API-交互/插件] 添加使用说明 @Aarebecca
• 内置事件

内容修正

• [API-自由插件-LodController-History] 不需要 container

• [自定义扩展]

  • 精简文字说明 @yvonneyx
  • 简化代码模版 @yvonneyx
  • 表格中加上相关链接跳转 @yvonneyx

• [入门教程] 拆出一部分高 [进阶教程] 中 @Aarebecca

• [进阶教程] 添加 [信息分层] 内容 @Aarebecca

案例走查

目前发现有异常的案例：

• 找不到 graph 定义 @Aarebecca

/zh/examples/feature/features/#wasmLayouts

站点走查

• 移除或更新 [其他资源/在线工具] @Aarebecca

[Aarebecca]

二期文档调整

缺失部分：

• 图生命周期事件
• 元素监听事件