@next-bricks/basic-bricks 1.258.12 → 1.259.0

package/dist/types/basic-bricks/src/general-notification/index.d.ts

@@ -0,0 +1,131 @@
+import { CSSProperties } from "react";
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { NotificationPlacement } from "antd/lib/notification";
+import { NotificationApi } from "antd/es/notification";
+import type { UseBrickConf, MenuIcon } from "@next-core/brick-types";
+export interface GeneralNotificationElementProps {
+    message?: string;
+    description?: string;
+    descriptionBrick?: DescriptionBrickprops;
+    btnBrick?: BtnBrickprops;
+    icon?: MenuIcon | string;
+    iconStyle?: CSSProperties;
+    placement?: NotificationPlacement;
+    duration?: number;
+    key?: string;
+}
+/**
+ * @id basic-bricks.general-notification
+ * @name basic-bricks.general-notification
+ * @docKind brick
+ * @description 普通的 notification
+ * @author Alex
+ * @slots
+ * @history
+ * 1.62.0:新增构件 `basic-bricks.general-notification`
+ * @memo
+ * @noInheritDoc
+ */
+interface DescriptionBrickprops {
+    useBrick: UseBrickConf;
+}
+interface BtnBrickprops {
+    useBrick: UseBrickConf;
+}
+export declare class GeneralNotificationElement extends UpdatingElement implements GeneralNotificationElementProps {
+    /**
+     * @kind string
+     * @required true
+     * @default -
+     * @description 通知提醒标题，必选
+     * @group basic
+     */
+    message: string;
+    /**
+     * @kind string
+     * @required true
+     * @default -
+     * @description 通知提醒内容，必选
+     * @group basic
+     */
+    description: string;
+    /**
+     * @kind DescriptionBrickprops
+     * @required false
+     * @default -
+     * @description 自定义通知提醒内容
+     * @group basic
+     */
+    descriptionBrick: DescriptionBrickprops;
+    /**
+     * @kind BtnBrickprops
+     * @required false
+     * @default -
+     * @description 自定义通知提醒按钮
+     * @group basic
+     */
+    btnBrick: BtnBrickprops;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 当前通知唯一标志
+     * @group basic
+     */
+    key: string;
+    /**
+     * @kind MenuIcon | string
+     * @required false
+     * @default -
+     * @description icon
+     */
+    icon: MenuIcon | string;
+    /**
+     * @kind `topLeft` `topRight` `bottomLeft` `bottomRight`
+     * @required false
+     * @default topRight
+     * @description 弹出位置，可选
+     * @group ui
+     */
+    placement: NotificationPlacement;
+    /**
+     * @kind number
+     * @required false
+     * @default 4.5
+     * @description 默认 4.5 秒后自动关闭，配置为 null 则不自动关闭
+     * @group basic
+     */
+    duration: number;
+    /**
+     * @required false
+     * @default -
+     * @description icon css 样式
+     * @group ui
+     */
+    iconStyle: CSSProperties;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    handleClose: () => void;
+    handleClick: () => void;
+    /**
+     * @detail -
+     * @description 点击通知时触发的回调函数
+     */
+    clickEvent: EventEmitter<Record<string, any>>;
+    /**
+     * @detail -
+     * @description 点击默认关闭按钮时触发的回调函数
+     */
+    closeEvent: EventEmitter<Record<string, any>>;
+    renderIcon: () => JSX.Element;
+    renderDescription: () => string | JSX.Element;
+    renderBtn: () => JSX.Element;
+    /**
+     *
+     * @params `success` | `error` | `info` | `warning` | `warn` | `open`
+     * @description  显示通知栏，默认为`open`
+     */
+    open(mtd: keyof Omit<NotificationApi, "config" | "close" | "destroy">, key?: string): void;
+    protected _render(): void;
+}
+export {};

package/dist/types/basic-bricks/src/general-popup/GeneralPopup.d.ts

@@ -0,0 +1,21 @@
+import React from "react";
+export declare enum OpenDirection {
+    LeftTop = "leftTop",
+    LeftBottom = "leftBottom",
+    RightTop = "rightTop",
+    RightBottom = "rightBottom",
+    Center = "center"
+}
+export interface GeneralPopupProps {
+    popupId?: string;
+    visible: boolean;
+    popupTitle?: string;
+    popupWidth?: React.CSSProperties["width"];
+    popupHeight?: React.CSSProperties["height"];
+    closePopup?: () => void;
+    dragHeaderStyle?: Record<string, any>;
+    dragWrapperStyle?: Record<string, any>;
+    openDirection?: OpenDirection;
+    resize?: boolean;
+}
+export declare function GeneralPopup({ popupId, popupTitle, popupWidth, popupHeight, visible, dragHeaderStyle, dragWrapperStyle, openDirection, closePopup, resize, }: GeneralPopupProps): React.ReactElement;

package/dist/types/basic-bricks/src/general-popup/index.d.ts

@@ -0,0 +1,95 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+import { OpenDirection } from "./GeneralPopup";
+export interface GeneralPopupElementProps {
+    popupId?: string;
+    popupWidth?: React.CSSProperties["width"];
+    popupHeight?: React.CSSProperties["height"];
+    popupTitle?: string;
+    openDirection?: OpenDirection;
+    isVisible?: boolean;
+    dragHeaderStyle?: Record<string, any>;
+    dragWrapperStyle?: Record<string, any>;
+    resize?: boolean;
+}
+/**
+ * @id basic-bricks.general-popup
+ * @author SheRunFeng
+ * @history
+ * 1.x.0: 新增构件 `basic-bricks.general-popup`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class GeneralPopupElement extends UpdatingElement implements GeneralPopupElementProps {
+    /**
+     * @default -
+     * @required false
+     * @description 浮层Id, 如果有设置浮层id, 会开启位置记录功能
+     */
+    popupId: string;
+    /**
+     * @default 500
+     * @required false
+     * @description 弹窗宽度
+     */
+    popupWidth: React.CSSProperties["width"];
+    /**
+     * @default -
+     * @required false
+     * @description 弹窗高度
+     */
+    popupHeight: React.CSSProperties["height"];
+    /**
+     * @default -
+     * @required false
+     * @description 弹窗标题
+     */
+    popupTitle: string;
+    /**
+     * @default center
+     * @required false
+     * @description 弹窗打开位置
+     */
+    openDirection: OpenDirection;
+    /**
+     * @kind boolean
+     * @required -
+     * @default false
+     * @description 是否显示模态框
+     * @group advanced
+     */
+    isVisible: boolean;
+    /**
+     * @required false
+     * @default -
+     * @description 用于设置 popup head的样式
+     * @group ui
+     */
+    dragHeaderStyle: Record<string, any>;
+    /**
+     * @required false
+     * @default -
+     * @description 用于设置 popup wrapper的样式
+     * @group ui
+     */
+    dragWrapperStyle: Record<string, any>;
+    /**
+     * @description 是否可调整尺寸
+     * @group ui
+     */
+    resize?: boolean;
+    /**
+     * @description 显示弹窗
+     */
+    open(): void;
+    /**
+     * @description 关闭弹窗
+     */
+    close(): void;
+    closePopup: () => void;
+    private _shadowRoot;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/general-text/GeneralText.d.ts

@@ -0,0 +1,13 @@
+import React, { CSSProperties } from "react";
+interface GeneralTextProps {
+    text: string;
+    color?: CSSProperties["color"];
+    fontSize?: CSSProperties["fontSize"];
+    fontWeight?: CSSProperties["fontWeight"];
+    lineHeight?: CSSProperties["lineHeight"];
+    display?: CSSProperties["display"];
+    textAlign?: CSSProperties["textAlign"];
+    customStyle?: CSSProperties;
+}
+export declare function GeneralText(props: GeneralTextProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/general-text/index.d.ts

@@ -0,0 +1,81 @@
+import { CSSProperties } from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface GeneralTextElementProps {
+    text?: string;
+    fontSize?: CSSProperties["fontSize"];
+    fontWeight?: CSSProperties["fontWeight"];
+    color?: CSSProperties["color"];
+    lineHeight?: CSSProperties["lineHeight"];
+    textAlign?: CSSProperties["textAlign"];
+    display?: CSSProperties["display"];
+    customStyle?: CSSProperties;
+}
+/**
+ * @id basic-bricks.general-text
+ * @author SailorShe
+ * @history
+ * 1.x.0: 新增构件 `basic-bricks.general-text`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class GeneralTextElement extends UpdatingElement implements GeneralTextElementProps {
+    /**
+     * @default ''
+     * @required false
+     * @description 字体文本
+     * @group basic
+     */
+    text: string;
+    /**
+     * @default 14px
+     * @required false
+     * @description 字体大小
+     * @group basic
+     */
+    fontSize: CSSProperties["fontSize"];
+    /**
+     * @default normal
+     * @required false
+     * @description 字体粗细
+     * @group basic
+     */
+    fontWeight: CSSProperties["fontWeight"];
+    /**
+     * @default black
+     * @required false
+     * @description 字体颜色
+     * @group basic
+     */
+    color: CSSProperties["color"];
+    /**
+     * @default 14px
+     * @required false
+     * @description 字体行高
+     * @group basic
+     */
+    lineHeight: CSSProperties["lineHeight"];
+    /**
+     * @default left
+     * @required false
+     * @description 字体对齐方式
+     * @group basic
+     */
+    textAlign: CSSProperties["textAlign"];
+    /**
+     * @default inline
+     * @required false
+     * @description 显示类型, 在文字构件中常用inline inline-block block,其余类型请查看[相关文档](https://developer.mozilla.org/zh-CN/docs/Web/CSS/display)
+     * @group basic
+     */
+    display: CSSProperties["display"];
+    /**
+     * @default 使用自定义样式,将会覆盖默认样式
+     * @required false
+     * @description 自定义样式
+     * @group ui
+     */
+    customStyle: CSSProperties;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/general-timer/index.d.ts

@@ -0,0 +1,70 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+export interface GeneralTimerElementProps {
+    eventName?: string;
+    interval?: number;
+    isInterval?: boolean;
+    dataSource?: any;
+}
+/**
+ * @id basic-bricks.general-timer
+ * @name basic-bricks.general-timer
+ * @docKind brick
+ * @description 启动一个定时发出指定事件的定时器
+ * @author cyril
+ * @slots
+ * @history
+ * 1.67.2:新增构件 `basic-bricks.general-timer`
+ * @memo
+ * @noInheritDoc
+ */
+export declare class GeneralTimerElement extends UpdatingElement implements GeneralTimerElementProps {
+    /**
+     * @kind string
+     * @required false
+     * @default general-timer.timing-event
+     * @description 定时抛出的事件
+     * @group basic
+     */
+    eventName: string;
+    /**
+     * @kind number
+     * @required false
+     * @default 60000
+     * @description 定时间隔（单位：ms）
+     * @group basic
+     */
+    interval: number;
+    /**
+     * @default true
+     * @required
+     * @description 是否开启定时间隔
+     */
+    isInterval: boolean;
+    /**
+     * @kind any
+     * @required false
+     * @default -
+     * @description 抛出事件的数据
+     * @group basic
+     */
+    dataSource: any;
+    private _intervalId;
+    private _stopped;
+    private defaultEventName;
+    private defaultInterval;
+    /**
+     *
+     * @description 停止timer
+     */
+    stopTimer(): void;
+    /**
+     *
+     * @description 重启timer
+     */
+    reStartTimer(): void;
+    timeChangeEvent: EventEmitter;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private startTimeout;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/general-title/GeneralTitle.d.ts

@@ -0,0 +1,21 @@
+import React from "react";
+import { UseBrickConf } from "@next-core/brick-types";
+interface GeneralTitleProps {
+    mainTitle: string;
+    subTitle?: string;
+    description?: string;
+    url?: string;
+    target?: string;
+    titleSuffixBrick?: {
+        useBrick: UseBrickConf;
+    };
+    descPrefixBrick?: {
+        useBrick: UseBrickConf;
+    };
+    dataSource?: Record<string, any>;
+    descSuffixBrick?: {
+        useBrick: UseBrickConf;
+    };
+}
+export declare function GeneralTitle(props: GeneralTitleProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/general-title/index.d.ts

@@ -0,0 +1,129 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+import { UseBrickConf } from "@next-core/brick-types";
+export interface GeneralTitleElementProps {
+    mainTitle?: string;
+    description?: string;
+    subTitle?: string;
+    url?: string;
+    target?: string;
+    descPrefixBrick?: {
+        useBrick: UseBrickConf;
+    };
+    titleSuffixBrick?: {
+        useBrick: UseBrickConf;
+    };
+    descSuffixBrick?: {
+        useBrick: UseBrickConf;
+    };
+    dataSource?: Record<string, any>;
+    fields?: {
+        mainTitle?: string;
+        description?: string;
+        subTitle?: string;
+    };
+}
+/**
+ * @id basic-bricks.general-title
+ * @author astrid
+ * @slots
+ * @history
+ * 1.139.0: 新增构件 `basic-bricks.general-title`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class GeneralTitleElement extends UpdatingElement implements GeneralTitleElementProps {
+    /**
+     * @kind `string`
+     * @required true
+     * @default
+     * @description 标题
+     * @group basic
+     */
+    mainTitle: string;
+    /**
+     * @kind `string`
+     * @required false
+     * @default
+     * @description 描述
+     * @group basic
+     */
+    description: string;
+    /**
+     * @kind `string`
+     * @required
+     * @default
+     * @description 副标题
+     * @group basic
+     */
+    subTitle: string;
+    /**
+     * @kind `string`
+     * @required false
+     * @default
+     * @description 链接,点击标题时跳转
+     * @group basic
+     */
+    url: string;
+    /**
+     * @kind `string`
+     * @required false
+     * @default
+     * @description  title跳转 target，例如可以设置成 _blank
+     * @group basic
+     */
+    target: string;
+    /**
+     * @kind `{useBrick: UseBrickConf }`
+     * @required false
+     * @default
+     * @description 可以在描述前添加前缀
+     * @group other
+     */
+    descPrefixBrick: {
+        useBrick: UseBrickConf;
+    };
+    /**
+     * @kind `{useBrick: UseBrickConf }
+     * @required false
+     * @default
+     * @description 可以在标题后添加后缀
+     * @group other
+     */
+    titleSuffixBrick: {
+        useBrick: UseBrickConf;
+    };
+    /**
+     * @kind `{useBrick: UseBrickConf }`
+     * @required false
+     * @default
+     * @description 可以在描述后面添加后缀
+     * @group other
+     */
+    descSuffixBrick: {
+        useBrick: UseBrickConf;
+    };
+    /**
+     * @kind ` Record<string, any>`
+     * @required false
+     * @default
+     * @description 数据源
+     * @group other
+     */
+    dataSource: Record<string, any>;
+    /**
+     * @kind ` {mainTitle?: string; subTitle?: string; description?: string;}`
+     * @required false
+     * @default
+     * @description 字段映射, 跟 dataSource 一起使用来获得运行时 mainTitle、 description
+     * @group other
+     */
+    fields: {
+        mainTitle?: string;
+        description?: string;
+        subTitle?: string;
+    };
+    private initData;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/grid-layout/index.d.ts

@@ -0,0 +1,134 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface GridLayoutElementProps {
+    columns?: number;
+    columnSpan?: number;
+    rows?: number;
+    rowSpan?: number;
+    templateColumns?: string;
+    responsive?: ResponsiveSettings;
+    gap?: string;
+    showGridBorder?: boolean;
+    gridBorderColor?: string;
+}
+export interface ResponsiveSettings {
+    large?: GridSettings;
+    medium?: GridSettings;
+    small?: GridSettings;
+    xSmall?: GridSettings;
+}
+export interface GridSettings {
+    columns?: number;
+    rows?: number;
+    templateColumns?: string;
+    columnSpan?: number;
+    rowSpan?: number;
+}
+/**
+ * @id basic-bricks.grid-layout
+ * @name basic-bricks.grid-layout
+ * @docKind brick
+ * @description 提供多行多列的响应式网格布局
+ * @author steve
+ * @slots
+ * @history
+ * @memo
+ * ### 响应式布局说明
+
+*Bootstrap 等 UI 框架是移动优先的设计，它们的响应式为默认匹配小屏幕，并由小到大适配。而 EasyOps 平台以 PC 优先，并由大到小适配。这里我们针对常见桌面显示器大小，分为以下五档（屏幕宽度）：
+
+* - `xSmall`：<= 1024px （老式投影仪）
+* - `small`：<= 1280px （13 寸笔记本）
+* - `medium`：<= 1600px （中等显示器）
+* - `large`：<= 1920px （大号显示器）
+* - 其它：超大显示器
+
+* 例如以下设置：
+
+*```json
+*{
+*  "columns": 3,
+*  "responsive": {
+*    "medium": {
+*      "columns": 2
+*    },
+*    "small": {
+*      "columns": 1
+*    }
+*  }
+*}
+*```
+
+*在 `> 1600px` 的屏幕上时将显示为三列，`<= 1600px && > 1280px` 时显示两列，更小的屏幕显示为一列。
+ */
+export declare class GridLayoutElement extends UpdatingElement implements GridLayoutElementProps {
+    private _mountPoint;
+    private _sizeMatch;
+    private _mediaMatchListeners;
+    /**
+     * @kind number
+     * @default -
+     * @description 	网格布局列数（各列等宽）
+     * @group basic
+     */
+    columns?: number;
+    /**
+     * @kind number
+     * @default auto
+     * @description 自己在父级网格中所占列数
+     * @group basic
+     */
+    columnSpan?: number;
+    /**
+     * @kind number
+     * @default 1
+     * @description 	网格布局行数，通常不需设置，各行高度由内容决定。设置为 > 1 时，各行高度相同。
+     * @group basic
+     */
+    rows?: number;
+    /**
+     * @kind number
+     * @default 1
+     * @description 自己在父级网格中所占行数
+     * @group basic
+     */
+    rowSpan?: number;
+    /**
+     * @kind string
+     * @default -
+     * @description 	网格布局模板列，即 CSS 的 gridTemplateColumns，优先于 `columns`。
+     * @group basic
+     */
+    templateColumns?: string;
+    /**
+     * @kind ResponsiveSettings
+     * @default 1
+     * @description 响应式布局设置
+     * @group basic
+     */
+    responsive?: ResponsiveSettings;
+    /**
+     * @kind string
+     * @default "var(--page-card-gap)"
+     * @description 子元素之间的间距
+     * @group basic
+     */
+    gap: string;
+    /**
+     * @kind Boolean
+     * @default false
+     * @description 网格布局边框
+     * @group basic
+     */
+    showGridBorder: boolean;
+    /**
+     * @kind string
+     * @default #454547
+     * @description 网格布局边框颜色
+     */
+    gridBorderColor: string;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private _clearMediaMatchListeners;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/header-bar/HeaderBar.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export interface HeaderBarProps {
+    logoUrl?: string;
+    headerBackgroundColor?: string;
+}
+export declare function HeaderBar({ logoUrl, headerBackgroundColor, }: HeaderBarProps): React.ReactElement;