🏷️ feat: 优化配置结构

BREAKING CHANGE: 配置中 `arrange` 字段更名为 `sections`
arvinxx · Apr 10, 2021 · a780bcd · a780bcd · vercel · Apr 10, 2021
1 parent 34deff8
commit a780bcd
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 23 deletions.
diff --git a/packages/journey-map/schema/journey-map.schema.json b/packages/journey-map/schema/journey-map.schema.json
@@ -4,8 +4,16 @@
     "Config": {
       "description": "图表配置",
       "properties": {
-        "arrange": {
-          "description": "section 的排序",
+        "color": {
+          "description": "主色",
+          "type": "string"
+        },
+        "height": {
+          "$ref": "#/definitions/Partial<Record<SectionType,number>>",
+          "description": "每个部分的高度"
+        },
+        "sections": {
+          "description": "待显示的区块\n默认为: ['stage', 'action', 'emotion','thought']",
           "items": {
             "enum": [
               "action",
@@ -19,18 +27,6 @@
           },
           "type": "array"
         },
-        "color": {
-          "description": "主色",
-          "type": "string"
-        },
-        "height": {
-          "$ref": "#/definitions/Partial<Record<SectionType,number>>",
-          "description": "每个部分的高度"
-        },
-        "section": {
-          "description": "显示左侧区域",
-          "type": "boolean"
-        },
         "title": {
           "description": "显示旅程图标题",
           "type": "boolean"

diff --git a/packages/journey-map/src/index.tsx b/packages/journey-map/src/index.tsx
@@ -60,7 +60,7 @@ const JourneyMap: FC<JourneyMapProps> = ({
     chance: () => <div />,
   };
 
-  const arrange = store.config?.arrange || [
+  const list = store.config?.sections || [
     'stage',
     'action',
     'emotion',
@@ -78,7 +78,7 @@ const JourneyMap: FC<JourneyMapProps> = ({
             <div className="avx-journey-map-title">{store.title}</div>
           ) : null}
           <div className="avx-journey-map-content">
-            {arrange.map((a) => {
+            {list.map((a) => {
               const Section = sections[a];
               return <Section key={a} />;
             })}

diff --git a/packages/journey-map/src/types/type.ts b/packages/journey-map/src/types/type.ts
@@ -79,24 +79,21 @@ export type SectionType =
  * 图表配置
  */
 export interface Config {
-  /**
-   * 显示左侧区域
-   */
-  section?: boolean;
   /**
    * 显示旅程图标题
    */
   title?: boolean;
   /**
-   * 主色
+   * 旅程图主色风格
    */
   color?: string;
   /**
    * 每个部分的高度
    */
   height?: Partial<Record<SectionType, number>>;
   /**
-   * section 的排序
+   * 待显示的区块
+   * 默认为: ['stage', 'action', 'emotion','thought']
    */
-  arrange?: Partial<SectionType>[];
+  sections?: Partial<SectionType>[];
 }