✏️ provide layout api's return type

antvis · Dec 25, 2019 · bc62059 · bc62059
1 parent ed4c867
commit bc62059
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 9 deletions.
diff --git a/packages/graphin-site/docs/api/extend.en.md b/packages/graphin-site/docs/api/extend.en.md
@@ -7,12 +7,12 @@ The property `extend` of  component `<Graphin/>` is used to extend layout, NodeS
 
 |   Property    | Type                                                           | Required | Description       |
 | --------- | -------------------------------------------------------------- | -------- | ---------- |
-| layout    | (graphin: [Graphin](), prevProps: [GraphinProps](/zh/docs/api/graphin#props)) => [ExendLayout](#extendlayout)[ ]  | no       | custom Layout |
+| layout    | (graphin: [Graphin](), prevProps: [GraphinProps](/zh/docs/api/graphin#props)) => [ExtendLayout](#extendlayout)[ ]  | no       | custom Layout |
 | nodeShape | (node: [Node](/zh/docs/api/graphin#node)) => [ExtendNodeShape](#extendnodeshape)[ ] | no       | custom Node |
 | marker    | ( ) => [ExtendMarker](#extendmarker)[ ]         | no       | custom Icon |
 
 
-### ExendLayout
+### ExtendLayout
 
 Configuration of custom layout
 

diff --git a/packages/graphin-site/docs/api/extend.zh.md b/packages/graphin-site/docs/api/extend.zh.md
@@ -7,12 +7,12 @@ order: 3
 
 |   属性    | 类型                                                           | 是否必选 | 说明       |
 | --------- | -------------------------------------------------------------- | -------- | ---------- |
-| layout    | (graphin: [Graphin](), prevProps: [GraphinProps](/zh/docs/api/graphin#props)) => [ExendLayout](#extendlayout)[ ]  | 否       | 自定义布局 |
+| layout    | (graphin: [Graphin](), prevProps: [GraphinProps](/zh/docs/api/graphin#props)) => [ExtendLayout](#extendlayout)[ ]  | 否       | 自定义布局 |
 | nodeShape | (node: [Node](/zh/docs/api/graphin#node)) => [ExtendNodeShape](#extendnodeshape)[ ] | 否       | 自定义节点 |
 | marker    | ( ) => [ExtendMarker](#extendmarker)[ ]         | 否       | 自定义图标 |
 | icon   | ( ) => [ExtendIcon](#extendicon)[ ]         | 否       | 自定义图标（iconfont 形式） |
 
-### ExendLayout
+### ExtendLayout
 
 自定义布局配置
 

diff --git a/packages/graphin/src/Graphin.tsx b/packages/graphin/src/Graphin.tsx
@@ -12,7 +12,16 @@ import apisController from './apis';
 import eventController from './events/index';
 
 /** types  */
-import { GraphinProps, GraphinState, ExtendedGraphOptions, GraphType, ForceSimulation, Data, Layout } from './types';
+import {
+    GraphinProps,
+    GraphinState,
+    ExtendedGraphOptions,
+    GraphType,
+    ForceSimulation,
+    Data,
+    Layout,
+    ExtendLayout,
+} from './types';
 
 /** utils */
 import debug from './utils/debug';

diff --git a/packages/graphin/src/controller/layout/index.tsx b/packages/graphin/src/controller/layout/index.tsx
@@ -1,5 +1,5 @@
 import dataChecking from './dataChecking';
-import { GraphinProps, Data, ForceSimulation, ExendLayout } from '../../types';
+import { GraphinProps, Data, ForceSimulation, ExtendLayout } from '../../types';
 import Graphin from '../../Graphin';
 import defaultLayouts, { LayoutOption } from './defaultLayouts';
 
@@ -8,7 +8,7 @@ interface LayoutParams {
     prevProps?: GraphinProps;
 }
 
-const layoutInfo = (layouts: ExendLayout[]) => {
+const layoutInfo = (layouts: ExtendLayout[]) => {
     return layouts.map(item => {
         const { desc, name, icon } = item;
         return {

diff --git a/packages/graphin/src/types.ts b/packages/graphin/src/types.ts
@@ -230,7 +230,7 @@ export interface ExtendNodeShape {
     name: string;
     render: NodeShapeFunction;
 }
-export interface ExendLayout {
+export interface ExtendLayout {
     /** 布局名称，唯一标示 */
     name: string;
     /** 布局展示名称 */
@@ -286,7 +286,7 @@ export interface GraphinProps {
     layout?: Layout;
 
     extend?: {
-        layout?: (graphin: Graphin, prevProps: GraphinProps) => ExendLayout[];
+        layout?: (graphin: Graphin, prevProps: GraphinProps) => ExtendLayout[];
         nodeShape?: () => ExtendNodeShape[];
         marker?: () => ExtendMarker[];
         icon?: () => ExtendIcon[];