Merge pull request #6 from lww117/master

feat(docs): 0.2.0

Author: sunyongjian

README.md

@@ -82,7 +82,7 @@ lf.render(data);
 - [快速上手](http://logic-flow.org/guide/start.html#安装)
 - [基础教程](http://logic-flow.org/guide/basic/logic-flow.html)
 - [进阶指南](http://logic-flow.org/guide/advance/theme.html)
-- [拓展](http://logic-flow.org/guide/extension/extension-intro.html)
+- [拓展](http://logic-flow.org/guide/extension/extension-components.html)
 - [示例](http://logic-flow.org/usage/bpmn.html)
 
 

docs/.vuepress/config.js

@@ -31,7 +31,6 @@ const guide = [
     title: '拓展',
     collapsable: false,
     children: [
-      'extension/extension-intro',
       'extension/extension-components',
       'extension/bpmn-element',
       'extension/snapshot',

docs/api/customEdgeApi.md

@@ -0,0 +1,56 @@
+# 自定义连线
+
+## getShape
+
+获取连线的 SVG 元素。
+
+```ts
+getShape(): h.JSX.Element
+```
+
+## getAttributes
+
+获取连线的属性，其返回值如下：
+
+|key|类型|描述|
+|-|-|-|
+|stroke|string|连线和箭头当前状态的颜色|
+|strokeWidth|number|连线的宽度|
+|strokeOpacity|number|连线透明度|
+|selectedShadow|string|连线选中的阴影效果|
+|isSelected|boolean|连线选中状态|
+|isHoverd|boolean|连线是否被hoverd|
+|properties|object|连线属性|
+|hoverStroke|string|设置的连线被hover的颜色|
+|selectedStroke|string|设置的连线被选中的颜色|
+
+使用示例：
+
+```ts
+getAttributes() {
+  const attributes = super.getAttributes();
+  return Object.assign(attributes, {});
+}
+```
+
+## getArrowStyle
+
+获取连线的箭头样式，其返回值如下：
+
+|key|类型|描述|
+|-|-|-|
+|stroke|string|箭头当前状态的颜色|
+|strokeWidth|number|箭头的宽度|
+|fill|string|箭头填充颜色|
+|offset|number|箭头长度|
+|verticalLength|number|箭头垂直于连线的距离|
+
+使用示例：
+
+```ts
+getArrowStyle() {
+  const style = super.getArrowStyle();
+  style.fill = "transparent";
+  return style;
+}
+```

docs/api/customNodeApi.md

@@ -0,0 +1,48 @@
+# 自定义节点
+
+## getShape
+
+获取连线的 SVG 元素。
+
+```ts
+getShape(): h.JSX.Element
+```
+
+## getAttributes
+
+获取连线的属性，其返回值为[数据属性](/api/nodeApi.md#通用属性)和[样式属性](/api/nodeApi.html#样式属性)的合集。
+
+使用示例：
+
+```ts
+getAttributes() {
+  const attributes = super.getAttributes();
+  return Object.assign(attributes, {});
+}
+```
+
+## getConnectedSourceRules
+
+获取节点作为开始节点（source）的校验规则。
+
+```ts
+getConnectedSourceRules(): ConnectRule[]
+
+export type ConnectRule = {
+  message: string;
+  validate: (source: BaseNodeModel, target: BaseNodeModel) => boolean;
+};
+```
+
+## getConnectedTargetRules
+
+获取节点作为目标节点（target）的校验规则。
+
+```ts
+getConnectedTargetRules(): ConnectRule[]
+
+export type ConnectRule = {
+  message: string;
+  validate: (source: BaseNodeModel, target: BaseNodeModel) => boolean;
+};
+```