@next-bricks/presentational-bricks 1.336.9 → 1.337.0

package/dist/types/basic-progress/index.d.ts

@@ -0,0 +1,122 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+import { Color } from "./BasicProgress";
+export interface BasicProgressElementProps {
+    value?: number;
+    type?: "line" | "circle" | "dashboard";
+    text?: string;
+    description?: string;
+    textColor?: string;
+    colorMap?: ColorObj[];
+    fontSize?: string;
+    configProps?: Record<string, any>;
+}
+export interface ColorObj {
+    /**
+     * 进度范围最大值，值（value）小于等于最大值则为该颜色
+     */
+    progress: string | number;
+    /**
+     * 颜色
+     */
+    color: Color;
+}
+/**
+ * @id presentational-bricks.basic-progress
+ * @name presentational-bricks.basic-progress
+ * @docKind brick
+ * @description 进度条展示
+ * @author momo
+ * @slots
+ * @history
+ * 1.90.0:新增 text 和 fontSIze 属性
+ * 1.82.3:color 颜色选择标准化
+ * 1.82.2:新增构件 `presentational-bricks.basic-progress`
+ * @memo
+ * ```typescript
+ * export enum Color {
+ *   green = "green",
+ *   red = "red",
+ *   blue = "blue",
+ *   orange = "orange",
+ *   cyan = "cyan",
+ *   purple = "purple",
+ *   geekblue = "geekblue",
+ *   gray = "gray",
+ *   slategray = "slategray",
+ *   doderblue = "doderblue",
+ *   royalblue = "royalblue",
+ *   lightorange = "lightorange",
+ *   goldenrod = "goldenrod",
+ *   jewelryblue = "jewelryblue",
+ *   orangered = "orangered",
+ *   springgreen = "springgreen",
+ *   mediumpurple = "mediumpurple",
+ *   skyblue = "skyblue",
+ *   yellowgreen = "yellowgreen",
+ *   lightpurple = "lightpurple",
+ * }
+ * ```
+ * @noInheritDoc
+ */
+export declare class BasicProgressElement extends UpdatingElement implements BasicProgressElementProps {
+    /**
+     * @kind number
+     * @required true
+     * @description 进度值（只负责确定颜色的值）
+     * @group basic
+     */
+    value: number;
+    /**
+     * @kind line | circle | dashboard
+     * @required circle
+     * @default dashboard
+     * @description 类型
+     * @group basic
+     */
+    type: "line" | "circle" | "dashboard";
+    /**
+     * @kind string
+     * @required false
+     * @description 展示内容
+     * @group basic
+     */
+    text: string;
+    /**
+     * @kind string
+     * @required false
+     * @description 描述值
+     * @group basic
+     */
+    description: string;
+    /**
+     * @kind string
+     * @required false
+     * @description 展示内容的颜色
+     * @group ui
+     */
+    textColor: string;
+    /**
+     * @kind ColorObj[]
+     * @required false
+     * @description 颜色范围
+     * @group ui
+     */
+    colorMap: ColorObj[];
+    /**
+     * @kind string
+     * @required false
+     * @description 设定展示内容大小
+     * @group ui
+     */
+    fontSize: string;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @description 透传[antd progress](https://3x.ant.design/components/progress-cn/)
+     * @group other
+     */
+    configProps: Record<string, any>;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/brick-alert/BrickAlert.d.ts

@@ -0,0 +1,21 @@
+import React, { CSSProperties } from "react";
+import { AlertType } from "./index";
+interface BrickAlertProps {
+    message: string;
+    type: AlertType;
+    showIcon?: boolean;
+    closable?: boolean;
+    description?: string;
+    enableDescSlot?: boolean;
+    closeOnce?: boolean;
+    onClose?: () => void;
+    noBorderRadio?: boolean;
+    enableMessageSlot?: boolean;
+    enableActionSlot?: boolean;
+    iconSize?: "big" | "small" | "default";
+    messageStyle?: CSSProperties;
+    foldDesc?: boolean;
+    foldDescLabel?: string;
+}
+export declare function BrickAlert(props: BrickAlertProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,204 @@
+import { CSSProperties } from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface BrickAlertElementProps {
+    message?: string;
+    messageStyle?: CSSProperties;
+    description?: string;
+    type?: AlertType;
+    showIcon?: boolean;
+    closable?: boolean;
+    enableDescSlot?: boolean;
+    enableMessageSlot?: boolean;
+    enableActionSlot?: boolean;
+    localStorageKey?: string;
+    stripLocalStorageUrlSuffix?: boolean;
+    foldDesc?: boolean;
+    foldDescLabel?: string;
+    noBorderRadio?: boolean;
+    iconSize?: "big" | "small" | "default";
+}
+export declare type AlertType = "success" | "error" | "info" | "warning";
+/**
+ * @id presentational-bricks.brick-alert
+ * @name presentational-bricks.brick-alert
+ * @docKind brick
+ * @description 警告提示，可配置颜色类型，描述和是否显示图标
+ * @author ice
+ * @slots
+ * description:仅当 `enableDescSlot` 为真，才存在该插槽
+ * @history
+ * 1.159.0:新增属性：`stripLocalStorageUrlSuffix`
+ * 1.155.0:新增属性： `enableMessageSlot` `noBorderRadio` `iconSize` `messageStyle` `foldDesc` `enableActionSlot`
+ * 1.96.0:新增属性：`enableDescSlot`
+ * 1.72.0:新增属性：`localStorageKey`
+ * @memo
+ * @noInheritDoc
+ */
+export declare class BrickAlertElement extends UpdatingElement implements BrickAlertElementProps {
+    /**
+     * @kind string
+     * @required true
+     * @default -
+     * @description 警告提示内容
+     * @group basic
+     */
+    message: string;
+    /**
+     * @kind CSSProperties
+     * @required false
+     * @default -
+     * @description 标题样式，对message插槽有效
+     * @group ui
+     */
+    messageStyle: CSSProperties;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 警告提示的辅助性文字介绍
+     * @group basic
+     */
+    description: string;
+    /**
+     * @kind AlertType
+     * @required true
+     * @default -
+     * @description 指定警告提示的样式，有四种选择 success、info、warning、error
+     * @editor radio
+     * @editorProps {
+     *   "optionType": "button",
+     *   "options": [
+     *     {
+     *       "value": "success",
+     *       "icon": {
+     *         "lib": "antd",
+     *         "icon": "check-circle",
+     *         "theme": "outlined"
+     *       }
+     *     },
+     *     {
+     *       "value": "error",
+     *       "icon": {
+     *         "lib": "antd",
+     *         "icon": "close-circle",
+     *         "theme": "outlined"
+     *       }
+     *     },
+     *     {
+     *       "value": "info",
+     *       "icon": {
+     *         "lib": "antd",
+     *         "icon": "exclamation-circle",
+     *         "theme": "outlined"
+     *       }
+     *     },
+     *     {
+     *       "value": "warning",
+     *       "icon": {
+     *         "lib": "antd",
+     *         "icon": "warning",
+     *         "theme": "outlined"
+     *       }
+     *     }
+     *   ]
+     * }
+     * @group basic
+     */
+    type: AlertType;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 是否显示辅助图标
+     * @group basic
+     */
+    showIcon: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 是否显示关闭按钮
+     * @group basic
+     */
+    closable: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否启用 description 插槽点，启用后属性 `description` 无效
+     * @group advanced
+     */
+    enableDescSlot: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否启用 message 插槽点，启用后属性 `message` 无效
+     * @group advanced
+     */
+    enableMessageSlot: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否启用 action 插槽点
+     * @group advanced
+     */
+    enableActionSlot: boolean;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 当设置该属性时，且 `closable` 为真，用户点击关闭后写入 localStorage(浏览器存储), 之后就不再显示该警告提示。以页面 url 为命名空间，注意同一页面下该值的唯一性。
+     * @group advanced
+     */
+    localStorageKey: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 搭配`localStorageKey`使用，为true时，关闭localStorageKey的url命名空间。
+     * @group advanced
+     */
+    stripLocalStorageUrlSuffix: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 描述区折叠模式,仅`enableMessageSlot`为true时可用
+     * @group advanced
+     */
+    foldDesc: boolean;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 设置描述区折叠模式的标签文案
+     * @group advanced
+     */
+    foldDescLabel: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否关闭圆角
+     * @group advanced
+     */
+    noBorderRadio: boolean;
+    /**
+     * @kind "big"|"small"|"default"
+     * @required false
+     * @default -
+     * @description icon大小，为big时使用大图标，否则为根据是否有描述来渲染大小的默认图标
+     * @enums "big"|"small"|"default"
+     * @group advanced
+     */
+    iconSize: "big" | "small" | "default";
+    private key;
+    private pseudoSlotMounted;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    onClose: () => void;
+    protected _render(): void;
+    private renderPseudoSlot;
+}

package/dist/types/brick-alert-level/BrickAlertLevel.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { AlertLevel } from "./index";
+interface BrickAlertLevelProps {
+    value: AlertLevel;
+}
+export declare function BrickAlertLevel(props: BrickAlertLevelProps): React.ReactElement;
+export {};

package/dist/types/brick-alert-level/index.d.ts

@@ -0,0 +1,48 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface BrickAlertLevelElementProps {
+    value?: AlertLevel;
+    dataSource?: Record<string, any>;
+    fields?: {
+        value: string;
+    };
+}
+export declare type AlertLevel = 0 | 1 | 2 | "info" | "warning" | "critical";
+/**
+ * @id presentational-bricks.brick-alert-level
+ * @name presentational-bricks.brick-alert-level
+ * @docKind brick
+ * @description 将数值渲染成通用告警等级显示方式
+ * @author ice
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class BrickAlertLevelElement extends UpdatingElement implements BrickAlertLevelElementProps {
+    /**
+     * @kind AlertLevel
+     * @required false
+     * @default -
+     * @description 告警等级: 0 - 通知, 1 - 警告, 2 - 紧急
+     */
+    value: AlertLevel;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @description [已废弃]数据来源
+     */
+    dataSource: Record<string, any>;
+    /**
+     * @kind { value: string }
+     * @required false
+     * @default -
+     * @description [已废弃]字段映射, 跟 dataSource 一起使用来获得运行时 value
+     */
+    fields: {
+        value: string;
+    };
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/brick-alert-number/BrickAlertNumber.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+interface BrickAlertNumberProps {
+    alertNumber: number;
+}
+export declare function BrickAlertNumber(props: BrickAlertNumberProps): React.ReactElement;
+export {};

package/dist/types/brick-alert-number/index.d.ts

@@ -0,0 +1,27 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface BrickAlertNumberElementProps {
+    value?: number;
+}
+/**
+ * @id presentational-bricks.brick-alert-number
+ * @name presentational-bricks.brick-alert-number
+ * @docKind brick
+ * @description 数值 0 将带有绿色背景，1 带有黄色背景
+ * @author ice
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class BrickAlertNumberElement extends UpdatingElement implements BrickAlertNumberElementProps {
+    /**
+     * @kind number
+     * @required true
+     * @default -
+     * @description 告警数量
+     */
+    value: number;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/brick-alert-status/BrickAlertStatus.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+interface BrickAlertStatusProps {
+    status: number;
+    recoverType: string;
+    isRecover: boolean;
+}
+export declare function BrickAlertStatus(props: BrickAlertStatusProps): React.ReactElement;
+export {};

package/dist/types/brick-alert-status/index.d.ts

@@ -0,0 +1,68 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface BrickAlertStatusElementProps {
+    status?: number;
+    recoverType?: string;
+    isRecover?: boolean;
+    dataSource?: any;
+    fields?: {
+        status: string;
+        recoverType: string;
+        isRecover: string;
+    };
+}
+/**
+ * @id presentational-bricks.brick-alert-status
+ * @name presentational-bricks.brick-alert-status
+ * @docKind brick
+ * @description 将告警状态转换成文字表述
+ * @author ice
+ * @slots
+ * @history
+ * 1.74.0:新属性 `isRecover`
+ * @memo
+ * @noInheritDoc
+ */
+export declare class BrickAlertStatusElement extends UpdatingElement implements BrickAlertStatusElementProps {
+    /**
+     * @kind enum[0, 1, 2, 3]
+     * @required false
+     * @default -
+     * @description 告警状态
+     */
+    status: number;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 告警恢复类型
+     */
+    recoverType: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 是否已恢复告警
+     */
+    isRecover: boolean;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @description [已废弃]数据来源
+     */
+    dataSource: any;
+    /**
+     * @kind { status: string, recoverType: string, isRecover: string }
+     * @required false
+     * @default -
+     * @description [已废弃]字段映射, 跟 dataSource 一起使用来获得运行时 status 和 recoverType
+     */
+    fields: {
+        status: string;
+        recoverType: string;
+        isRecover: string;
+    };
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/brick-alert-value/BrickAlertValue.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { MonitorModels } from "@next-sdk/monitor-sdk";
+interface BrickAlertValueProps {
+    alertEvent: MonitorModels.ModelAlertEvent;
+}
+export declare function BrickAlertValue(props: BrickAlertValueProps): React.ReactElement;
+export {};

package/dist/types/brick-alert-value/index.d.ts

@@ -0,0 +1,28 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+import { MonitorModels } from "@next-sdk/monitor-sdk";
+export interface BrickAlertValueElementProps {
+    dataSource?: MonitorModels.ModelAlertEvent;
+}
+/**
+ * @id presentational-bricks.brick-alert-value
+ * @name presentational-bricks.brick-alert-value
+ * @docKind brick
+ * @description 将告警数值组合触发条件，显示成 90%↑ 的模式
+ * @author ice
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class BrickAlertValueElement extends UpdatingElement implements BrickAlertValueElementProps {
+    /**
+     * @kind monitor-sdk/MonitorModels.ModelAlertEvent
+     * @required true
+     * @default -
+     * @description 告警事件
+     */
+    dataSource: MonitorModels.ModelAlertEvent;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/brick-button/BrickButton.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import { ButtonProps } from "antd/lib/button";
+interface BrickButtonProps {
+    text: string;
+    configProps?: ButtonProps & {
+        icon?: string;
+    };
+    onClick?: (event: React.MouseEvent) => void;
+}
+export declare function BrickButton(props: BrickButtonProps): React.ReactElement;
+export {};

package/dist/types/brick-button/index.d.ts

@@ -0,0 +1,2 @@
+export interface BrickButtonElementProps {
+}