@next-bricks/presentational 0.1.10 → 0.2.0

package/dist/types.json

@@ -1,76 +1,303 @@
 {
-  "presentational.general-descriptions": [
-    {
-      "name": "DescriptionItem",
-      "type": "interface",
-      "annotation": [
-        {
-          "type": "propertySignature",
-          "name": "label",
-          "property": {
-            "type": "keyword",
-            "value": "string"
-          }
-        },
-        {
-          "type": "propertySignature",
-          "name": "field",
-          "property": {
-            "type": "keyword",
-            "value": "string"
-          }
-        },
-        {
-          "type": "propertySignature",
-          "name": "group",
-          "property": {
-            "type": "keyword",
-            "value": "string"
-          }
-        },
-        {
-          "type": "propertySignature",
-          "name": "text",
-          "property": {
-            "type": "union",
-            "types": [
-              {
+  "presentational.general-descriptions": {
+    "properties": [
+      {
+        "name": "descriptionTitle",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "string"
+            }
+          ]
+        }
+      },
+      {
+        "name": "list",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "array",
+              "elementType": {
+                "type": "reference",
+                "typeName": "DescriptionItem"
+              }
+            }
+          ]
+        }
+      },
+      {
+        "name": "showCard",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "boolean"
+            }
+          ]
+        }
+      },
+      {
+        "name": "column",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "number"
+            }
+          ]
+        }
+      },
+      {
+        "name": "layout",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "reference",
+              "typeName": "Layout"
+            }
+          ]
+        }
+      },
+      {
+        "name": "bordered",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "boolean"
+            }
+          ]
+        }
+      },
+      {
+        "name": "hideGroups",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "string"
+            },
+            {
+              "type": "array",
+              "elementType": {
                 "type": "keyword",
                 "value": "string"
-              },
-              {
-                "type": "keyword",
-                "value": "number"
               }
-            ]
-          }
-        },
-        {
-          "type": "propertySignature",
-          "name": "useBrick",
-          "property": {
-            "type": "reference",
-            "typeName": "UseSingleBrickConf"
+            }
+          ]
+        }
+      },
+      {
+        "name": "dataSource",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "reference",
+              "typeName": "Record",
+              "typeParameters": [
+                {
+                  "type": "keyword",
+                  "value": "string"
+                },
+                {
+                  "type": "keyword",
+                  "value": "any"
+                }
+              ]
+            }
+          ]
+        }
+      }
+    ],
+    "types": [
+      {
+        "name": "DescriptionItem",
+        "type": "interface",
+        "annotation": [
+          {
+            "type": "propertySignature",
+            "name": "label",
+            "property": {
+              "type": "keyword",
+              "value": "string"
+            }
+          },
+          {
+            "type": "propertySignature",
+            "name": "field",
+            "property": {
+              "type": "keyword",
+              "value": "string"
+            }
+          },
+          {
+            "type": "propertySignature",
+            "name": "group",
+            "property": {
+              "type": "keyword",
+              "value": "string"
+            }
+          },
+          {
+            "type": "propertySignature",
+            "name": "text",
+            "property": {
+              "type": "union",
+              "types": [
+                {
+                  "type": "keyword",
+                  "value": "string"
+                },
+                {
+                  "type": "keyword",
+                  "value": "number"
+                }
+              ]
+            }
+          },
+          {
+            "type": "propertySignature",
+            "name": "useBrick",
+            "property": {
+              "type": "reference",
+              "typeName": "UseSingleBrickConf"
+            }
           }
+        ]
+      },
+      {
+        "name": "Layout",
+        "type": "typeAlias",
+        "annotation": {
+          "type": "union",
+          "types": [
+            {
+              "type": "literal",
+              "value": "horizontal"
+            },
+            {
+              "type": "literal",
+              "value": "vertical"
+            }
+          ]
+        }
+      }
+    ]
+  },
+  "presentational.general-alert": {
+    "properties": [
+      {
+        "name": "type",
+        "types": {
+          "type": "reference",
+          "typeName": "AlertType"
         }
-      ]
-    },
-    {
-      "name": "Layout",
-      "type": "typeAlias",
-      "annotation": {
-        "type": "union",
-        "types": [
+      },
+      {
+        "name": "hasTitle",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "boolean"
+            }
+          ]
+        }
+      },
+      {
+        "name": "closable",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "boolean"
+            }
+          ]
+        }
+      },
+      {
+        "name": "localStorageKey",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "string"
+            }
+          ]
+        }
+      },
+      {
+        "name": "disableUrlNamespace",
+        "types": {
+          "type": "union",
+          "types": [
+            {
+              "type": "keyword",
+              "value": "boolean"
+            }
+          ]
+        }
+      }
+    ],
+    "types": [
+      {
+        "name": "AlertType",
+        "type": "enums",
+        "members": [
+          {
+            "name": {
+              "type": "stringLiteral",
+              "value": "SUCCESS"
+            },
+            "value": {
+              "type": "stringLiteral",
+              "value": "success"
+            }
+          },
+          {
+            "name": {
+              "type": "stringLiteral",
+              "value": "INFO"
+            },
+            "value": {
+              "type": "stringLiteral",
+              "value": "info"
+            }
+          },
           {
-            "type": "literal",
-            "value": "horizontal"
+            "name": {
+              "type": "stringLiteral",
+              "value": "WARNING"
+            },
+            "value": {
+              "type": "stringLiteral",
+              "value": "warning"
+            }
           },
           {
-            "type": "literal",
-            "value": "vertical"
+            "name": {
+              "type": "stringLiteral",
+              "value": "ERROR"
+            },
+            "value": {
+              "type": "stringLiteral",
+              "value": "error"
+            }
           }
         ]
       }
-    }
-  ]
+    ]
+  }
 }

package/dist-types/bootstrap.d.ts

@@ -1 +1,2 @@
 import "./descriptions/index.js";
+import "./general-alert/index.js";

package/dist-types/general-alert/constants.d.ts

@@ -0,0 +1,65 @@
+export declare enum AlertType {
+    "SUCCESS" = "success",
+    "INFO" = "info",
+    "WARNING" = "warning",
+    "ERROR" = "error"
+}
+export declare const alertTypeMap: {
+    success: {
+        outlinedIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        filledIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        color: string;
+        bgColor: string;
+    };
+    info: {
+        outlinedIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        filledIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        color: string;
+        bgColor: string;
+    };
+    warning: {
+        outlinedIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        filledIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        color: string;
+        bgColor: string;
+    };
+    error: {
+        outlinedIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        filledIcon: {
+            lib: string;
+            icon: string;
+            theme: string;
+        };
+        color: string;
+        bgColor: string;
+    };
+};
+export declare const LOCAL_STORAGE_PREFIX = "presentational.general-alert-hidden";

package/dist-types/general-alert/index.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="react" />
+import { ReactNextElement } from "@next-core/react-element";
+import "@next-core/theme";
+import { AlertType } from "./constants.js";
+export interface GeneralAlertProps {
+    type: AlertType;
+    hasTitle?: boolean;
+    closable?: boolean;
+    localStorageKey?: string;
+    disableUrlNamespace?: boolean;
+}
+/**
+ * 告警提示
+ * @slot 内容区
+ * @slot title - 标题
+ */
+export declare class GeneralAlert extends ReactNextElement implements GeneralAlertProps {
+    /**
+     * 警告类型
+     */
+    accessor type: AlertType;
+    /**
+     * 是否显示标题。开启后，可以使用 `title` 插槽
+     */
+    accessor hasTitle: boolean | undefined;
+    /**
+     * 是否显示关闭按钮
+     */
+    accessor closable: boolean | undefined;
+    /**
+     * 以该值和页面 url 作为命名空间，决定是否显示该警告提示
+     */
+    accessor localStorageKey: string | undefined;
+    /**
+     * 关闭后仅以 `localStorageKey` 作为命名空间
+     */
+    accessor disableUrlNamespace: boolean | undefined;
+    render(): JSX.Element;
+}
+export declare function GeneralAlertComponent(props: GeneralAlertProps): JSX.Element;

package/dist-types/general-alert/index.spec.d.ts

@@ -0,0 +1 @@
+import "./";

package/docs/general-alert.md

@@ -0,0 +1,105 @@
+告警提示
+
+## Examples
+
+### Basic
+
+```yaml preview
+brick: div
+properties:
+  style:
+    display: flex
+    flex-direction: column
+    gap: 10px
+slots:
+  "":
+    type: bricks
+    bricks:
+      - brick: presentational.general-alert
+        properties:
+          textContent: 你好！欢迎使用EasyOps 2.0专业版，你可以根据自身需求添加业务模块。
+          type: info
+          closable: true
+      - brick: presentational.general-alert
+        properties:
+          textContent: 恭喜！你所提交的信息已经审核通过。
+          type: success
+          closable: true
+      - brick: presentational.general-alert
+        properties:
+          textContent: "系统将于 15 : 00 - 17 : 00 进行升级，请及时保存你的资料！"
+          type: warning
+          closable: true
+      - brick: presentational.general-alert
+        properties:
+          textContent: 系统错误，请稍后重试。
+          type: error
+          closable: true
+```
+
+### HasTitle
+
+```yaml preview
+brick: div
+properties:
+  style:
+    display: flex
+    flex-direction: column
+    gap: 10px
+slots:
+  "":
+    type: bricks
+    bricks:
+      - brick: presentational.general-alert
+        properties:
+          textContent: 你好，由于你的良好信用，我们决定赠送你三个月产品会员，欲了解会员特权与活动请进首页会员专区查看。
+          type: info
+          closable: true
+          hasTitle: true
+        slots:
+          title:
+            type: bricks
+            bricks:
+              - brick: div
+                properties:
+                  textContent: 帮助信息
+      - brick: presentational.general-alert
+        properties:
+          textContent: 你所提交的审核信息已全部通过审核，请及时跟进申请状况。
+          type: success
+          closable: true
+          hasTitle: true
+        slots:
+          title:
+            type: bricks
+            bricks:
+              - brick: div
+                properties:
+                  textContent: 已成功
+      - brick: presentational.general-alert
+        properties:
+          textContent: 你所提交的审核信息审核失败，可以进入个人信箱查看原因。如有疑问，请联系客服人员。
+          type: warning
+          closable: true
+          hasTitle: true
+        slots:
+          title:
+            type: bricks
+            bricks:
+              - brick: div
+                properties:
+                  textContent: 请注意
+      - brick: presentational.general-alert
+        properties:
+          textContent: 你的账户会员使用权限将在3天后到期，请及时跟进申请状况，如有疑问，请联系审核人员。
+          type: error
+          closable: true
+          hasTitle: true
+        slots:
+          title:
+            type: bricks
+            bricks:
+              - brick: div
+                properties:
+                  textContent: 出错了
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-bricks/presentational",
-  "version": "0.1.10",
+  "version": "0.2.0",
   "homepage": "https://github.com/easyops-cn/next-bricks/tree/master/bricks/presentational",
   "repository": {
     "type": "git",
@@ -34,8 +34,8 @@
     "postpublish": "mv package.json.bak package.json"
   },
   "devDependencies": {
-    "@next-core/build-next-bricks": "^1.9.0",
+    "@next-core/build-next-bricks": "^1.10.0",
     "@next-core/test-next": "^1.0.6"
   },
-  "gitHead": "17a18f696648ddc1417ec395d5b46a28a9dc386c"
+  "gitHead": "d24d177295f0f3edbf6d28b1d9b6ae87c2f506ec"
 }