@next-bricks/basic-bricks 1.258.13 → 1.259.0

package/dist/types/basic-bricks/src/app-document-link/index.d.ts

@@ -0,0 +1,31 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface AppBarDocumentLinkElementProps {
+    iconStyle: React.CSSProperties;
+    buttonStyle: React.CSSProperties;
+    isInNavbar?: boolean;
+}
+/**
+ * @id basic-bricks.app-bar-document-link
+ * @author SheRunFeng
+ * @history
+ * 1.x.0: 新增构件 `basic-bricks.app-bar-document-link`
+ * @docKind brick
+ * @deprecated
+ * @memo
+ *  该构件已迁移至 `nav-legacy` 包中维护，后续版本将不再维护该构件，请使用 `nav-legacy.app-bar-document-link` 构件
+ * @noInheritDoc
+ */
+export declare class AppBarDocumentLinkElement extends UpdatingElement implements AppBarDocumentLinkElementProps {
+    iconStyle: React.CSSProperties;
+    buttonStyle: React.CSSProperties;
+    /**
+     * @default false
+     * @required false
+     * @description 是否在导航栏中显示，为true时显示为nav类型的通用按钮（高度为24px,圆角3px,hover颜色为灰色））
+     */
+    isInNavbar: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/brick-error/BrickError.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+export interface BrickErrorProps {
+    errorType: string;
+    errorMessage: string;
+    brickName: string;
+    isLegacyTemplate?: boolean;
+}
+export declare function BrickError({ errorType, errorMessage, brickName, isLegacyTemplate, }: BrickErrorProps): React.ReactElement;

package/dist/types/basic-bricks/src/brick-error/index.d.ts

@@ -0,0 +1,37 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface BrickErrorElementProps {
+    errorType?: string;
+    errorMessage?: string;
+    brickName?: string;
+    isLegacyTemplate?: boolean;
+}
+/**
+ * @id basic-bricks.brick-error
+ * @description 用于当构件发生允许单独 crash 的错误时显示的替代构件
+ * @author steve
+ * @history
+ * 1.84.0: 新增构件 `basic-bricks.brick-error`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class BrickErrorElement extends UpdatingElement implements BrickErrorElementProps {
+    /**
+     * @description 错误类型
+     */
+    errorType: string;
+    /**
+     * @description 错误信息
+     */
+    errorMessage: string;
+    /**
+     * @description 发生错误的构件名称
+     */
+    brickName: string;
+    /**
+     * @description 发生错误的是否是老模板
+     */
+    isLegacyTemplate: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/delete-confirm-modal/DeleteConfirmModal.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+interface DeleteConfirmModalProps {
+    name: string;
+    visible: boolean;
+    handleConfirm: () => void;
+    handleCancel: () => void;
+    title: string;
+    message?: string;
+}
+export declare function DeleteConfirmModal(props: DeleteConfirmModalProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/delete-confirm-modal/index.d.ts

@@ -0,0 +1,35 @@
+export interface DeleteConfirmModalElementProps {
+    isVisible?: boolean;
+    name?: string;
+    title?: string;
+    message?: string;
+}
+/**
+ * @id basic-bricks.delete-confirm-modal
+ * @name basic-bricks.delete-confirm-modal
+ * @docKind brick
+ * @description
+ * @author
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class DeleteConfirmModalElement extends HTMLElement {
+    private isVisible;
+    private _data;
+    private _eventName;
+    private _title;
+    private _message;
+    private _eventDetail;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private _render;
+    open(event: CustomEvent): void;
+    close(): void;
+    confirm(): void;
+    set eventName(value: string);
+    set message(value: string);
+    set title(value: string);
+    set data(value: any);
+}

package/dist/types/basic-bricks/src/easy-view/EasyView.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+interface EasyViewProps {
+    gridAreas?: Record<string, (string | number)[]>;
+    gridTemplateAreas?: string[][];
+    gridTemplateColumns?: string | string[];
+    gridTemplateRows?: string | string[];
+    containerStyle?: React.CSSProperties;
+    styleByAreas?: Record<string, React.CSSProperties>;
+}
+export declare function EasyView({ gridAreas, gridTemplateAreas, gridTemplateColumns, gridTemplateRows, containerStyle, styleByAreas, }: EasyViewProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/easy-view/index.d.ts

@@ -0,0 +1,56 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface EasyViewElementProps {
+    gridAreas?: Record<string, (string | number)[]>;
+    gridTemplateAreas?: string[][];
+    gridTemplateColumns?: string | string[];
+    gridTemplateRows?: string | string[];
+    containerStyle?: React.CSSProperties;
+    styleByAreas?: Record<string, React.CSSProperties>;
+}
+/**
+ * @id basic-bricks.easy-view
+ * @author steve
+ * @description 基于网格的简易布局容器，可以根据 grid-area 名称自动生成对应的插槽
+ * @history
+ * 1.127.0: 新增构件 `basic-bricks.easy-view`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class EasyViewElement extends UpdatingElement implements EasyViewElementProps {
+    /**
+     * @description 以键值对形式定义多个 [grid-area](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area)
+     * @group basic
+     */
+    gridAreas: Record<string, (string | number)[]>;
+    /**
+     * @description 定义 [grid-template-areas](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas)
+     * @group basic
+     */
+    gridTemplateAreas: string[][];
+    /**
+     * @description 定义 [grid-template-columns](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns)
+     * @group basic
+     */
+    gridTemplateColumns: string | string[];
+    /**
+     * @description 定义 [grid-template-rows](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows)
+     * @group basic
+     */
+    gridTemplateRows: string | string[];
+    /**
+     * @description 定义网格容器的样式
+     * @group basic
+     */
+    containerStyle: React.CSSProperties;
+    /**
+     * @description 定义网格内各区域的样式
+     * @group basic
+     */
+    styleByAreas: Record<string, React.CSSProperties>;
+    private _shadowRoot;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/event-agent/index.d.ts

@@ -0,0 +1,25 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface EventAgentElementProps {
+    [key: string]: any;
+}
+/**
+ * @id basic-bricks.event-agent
+ * @author steve
+ * @history
+ * 1.171.0: 新增构件 `basic-bricks.event-agent`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class EventAgentElement extends UpdatingElement implements EventAgentElementProps {
+    /**
+     * @detail `unknown`
+     * @description 事件被触发。
+     */
+    private _eventTrigger;
+    /**
+     * @description 触发一次事件，传递的参数为事件详情。
+     */
+    trigger(detail: unknown): void;
+    connectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/export-json-file/index.d.ts

@@ -0,0 +1,51 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+export interface ExportJsonFileElementProps {
+    fileName?: string;
+    data?: any;
+}
+/**
+ * @id basic-bricks.export-json-file
+ * @name basic-bricks.export-json-file
+ * @docKind brick
+ * @description 把数据导出为 JSON 文件
+ * @author cyril
+ * @slots
+ * @history
+ * 1.69.2:新增构件 `basic-bricks.export-json-file`
+ * @memo
+ * @noInheritDoc
+ */
+export declare class ExportJsonFileElement extends UpdatingElement implements ExportJsonFileElementProps {
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 导出的文件名
+     * @group basic
+     */
+    fileName: string;
+    /**
+     * @kind object | string
+     * @required -
+     * @default -
+     * @description 	导出的文件数据
+     * @group basic
+     */
+    data: any;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    /**
+     * @params [{ detail: { fileName: string; data: object | string; } }]
+     * @description 导出数据
+     */
+    export(event: CustomEvent): void;
+    /**
+     * @description 导出文件成功
+     */
+    success: EventEmitter;
+    /**
+     * @description 导出文件失败
+     */
+    failed: EventEmitter;
+    protected _render(): void;
+}

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

@@ -0,0 +1,55 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface FlexLayoutElementProps {
+    flexDirection?: string;
+    justifyContent?: string;
+    alignItems?: string;
+    alignContent?: string;
+    flexWrap?: string;
+    gap?: string;
+}
+/**
+ * @id basic-bricks.flex-layout
+ * @author kehua
+ * @history
+ * 1.0.0: 新增构件 `basic-bricks.flex-layout`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class FlexLayoutElement extends UpdatingElement implements FlexLayoutElementProps {
+    /**
+     * @description 定义[flex-direction]:设置主轴方向
+     * @group basic
+     */
+    flexDirection?: string;
+    /**
+     * @description 定义[justify-content]:设置主轴上子元素的排列方式
+     * @group basic
+     */
+    justifyContent?: string;
+    /**
+     * @description 定义[align-items]:设置侧轴上的子元素排列方式（单行）
+     * @group basic
+     */
+    alignItems?: string;
+    /**
+     * @description 定义[align-content]:设置侧轴上的子元素排列方式（多行）
+     * @group basic
+     */
+    alignContent?: string;
+    /**
+     * @description 定义[flex-wrap]:设置换行方式
+     * @group basic
+     */
+    flexWrap?: string;
+    /**
+     * @description 定义[gap]:设置元素间隙
+     * @group basic
+     */
+    gap?: string;
+    processString(str: string): string;
+    private _shadowRoot;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/fold-brick/FoldBrick.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { UseBrickConf } from "@next-core/brick-types";
+interface FoldBrickProps {
+    useBrick: UseBrickConf;
+    foldName: string;
+    foldStyle?: Record<string, string>;
+    defaultShow?: boolean;
+}
+export declare function FoldBrick(props: FoldBrickProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/fold-brick/index.d.ts

@@ -0,0 +1,28 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+import { UseBrickConf } from "@next-core/brick-types";
+export interface FoldBrickElementProps {
+    useBrick?: UseBrickConf;
+    foldName?: string;
+    foldStyle?: Record<string, string>;
+    defaultShow?: boolean;
+}
+/**
+ * @id basic-bricks.fold-brick
+ * @name basic-bricks.fold-brick
+ * @docKind brick
+ * @description 已废弃，请使用basic-bricks.fold-brick-v2
+ * @author momo
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class FoldBrickElement extends UpdatingElement implements FoldBrickElementProps {
+    useBrick: UseBrickConf;
+    foldName: string;
+    foldStyle: Record<string, string>;
+    defaultShow?: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/fold-brick-v2/FoldBrickV2.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+interface FoldBrickV2Props {
+    _id: string;
+    foldName: string;
+    hideFoldName?: boolean;
+    foldStyle?: Record<string, string>;
+    show: boolean;
+    showDivider?: boolean;
+    dividerOrientation?: "left" | "right" | "center";
+    dividerDashed?: boolean;
+    isShowFoldIcon?: boolean;
+    foldIcon?: any;
+    type?: "normal" | "primary";
+    foldIconStyle?: React.CSSProperties;
+}
+export declare function FoldBrickV2(props: FoldBrickV2Props): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/fold-brick-v2/index.d.ts

@@ -0,0 +1,133 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { MenuIcon } from "@next-core/brick-types";
+export interface FoldBrickV2ElementProps {
+    foldName?: string;
+    defaultShow?: boolean;
+    type: "normal" | "primary";
+    foldStyle?: Record<string, string>;
+    dividerOrientation?: "left" | "right" | "center";
+    foldIcon?: MenuIcon;
+    foldIconStyle?: any;
+}
+/**
+ * @id basic-bricks.fold-brick-v2
+ * @name basic-bricks.fold-brick-v2
+ * @docKind brick
+ * @description 折叠容器，只折叠单个内容，支持slot
+ * @groupI18N
+ * {
+ *   "divider": {
+ *     "en": "Divider",
+ *     "zh": "分割线"
+ *   }
+ * }
+ * @author momo
+ * @slots
+ * content:内容插槽
+ * @history
+ * 1.87.0:新增属性 `isShowFoldIcon`, `type`
+ * 1.64.0:新增属性 `showDivider`,`dividerOrientation`,`dividerDashed`,`show`
+ * 1.56.0:新增构件 `basic-bricks.fold-brick-v2`
+ * @memo
+ * @noInheritDoc
+ */
+export declare class FoldBrickV2Element extends UpdatingElement implements FoldBrickV2ElementProps {
+    private _id;
+    private _mountPoint;
+    private _shadowRoot;
+    /**
+     * @kind string
+     * @required true
+     * @default -
+     * @description 折叠展示名称
+     * @group basic
+     */
+    foldName: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 是否默认展开
+     * @group basic
+     */
+    defaultShow?: boolean;
+    /**
+     * @kind "normal" | "primary"
+     * @required false
+     * @default "normal"
+     * @description 折叠面板类型
+     * @group basic
+     */
+    type: "normal" | "primary";
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否显示展开图标
+     * @group ui
+     */
+    isShowFoldIcon: boolean;
+    /**
+     * @kind object
+     * @required false
+     * @default -
+     * @description 折叠展示的样式编写
+     * @group ui
+     */
+    foldStyle: Record<string, string>;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 是否展示分割线
+     * @group divider
+     */
+    showDivider: boolean;
+    /**
+     * @kind "left"|"right"|"center"
+     * @required false
+     * @default center
+     * @description 分割线标题的位置
+     * @group divider
+     */
+    dividerOrientation: "left" | "right" | "center";
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否虚线
+     * @group divider
+     */
+    dividerDashed: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default
+     * @description 是否展开
+     * @group divider
+     */
+    show: boolean;
+    /**
+     * @private
+     */
+    hideFoldName: boolean;
+    /**
+     * @private
+     */
+    foldIcon: MenuIcon;
+    /**
+     * @private
+     */
+    foldIconStyle: any;
+    /**
+     * @detail `Record<string, any>`
+     * @description 切换折叠时触发, detail boolean
+     */
+    foldChange: EventEmitter<boolean>;
+    constructor();
+    listenOnClick(): void;
+    listenToClick: (e: Event) => void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/general-anchor/GeneralAnchor.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import { AnchorProps } from "antd";
+import { AnchorListType } from "./index";
+import { UseBrickConf } from "@next-core/brick-types";
+interface GeneralAnchorProps {
+    configProps?: AnchorProps;
+    anchorList: AnchorListType[];
+    type?: "default" | "radio";
+    extraBrick?: {
+        useBrick: UseBrickConf;
+    };
+    initOffset?: number;
+    handleClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>, arg: AnchorListType) => void;
+    handleChange?: (currentActiveLink: string) => void;
+}
+export declare function GeneralAnchor(props: GeneralAnchorProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,91 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { AnchorLinkProps, AnchorProps } from "antd";
+import { UseBrickConf } from "@next-core/brick-types";
+export interface GeneralAnchorElementProps {
+    anchorList?: AnchorListType[];
+    configProps?: AnchorProps;
+    type?: "default" | "radio";
+    extraBrick?: {
+        useBrick: UseBrickConf;
+    };
+    initOffset?: number;
+}
+export interface AnchorListType extends AnchorLinkProps {
+    title: string;
+    href: string;
+    target?: string;
+    children?: AnchorListType[];
+}
+/**
+ * @id basic-bricks.general-anchor
+ * @author astrid
+ * @history
+ * 1.138.0: 新增构件 `basic-bricks.general-anchor`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class GeneralAnchorElement extends UpdatingElement implements GeneralAnchorElementProps {
+    /**
+     * @kind `AnchorListType[]`
+     * @required true
+     * @default -
+     * @description 锚点链接的list,会根据list的结构渲染出对应的锚点排布
+     * @group basic
+     */
+    anchorList: AnchorListType[];
+    /**
+     * @kind `AnchorProps`
+     * @required false
+     * @default -
+     * @description 锚点的具体参数，这里offsetTop设置了默认为`56`，其他参数可参考[antd](https://ant.design/docs/react/use-in-typescript-cn#Anchor-Props)
+     * @group basic
+     */
+    configProps: AnchorProps;
+    /**
+     * @kind `"default" | "radio"`
+     * @required false
+     * @default default
+     * @description 锚点的类型 ， `radio` 的类型不支持 `anchorList`属性有`children`，否则会样式有问题
+     * @group basic
+     */
+    type: "default" | "radio";
+    /**
+     * @kind `{ useBrick: UseBrickConf }`
+     * @required false
+     * @default  -
+     * @description 右上角有操作区
+     * @group basic
+     */
+    extraBrick: {
+        useBrick: UseBrickConf;
+    };
+    /**
+     * @default false
+     * @required false
+     * @description 禁用默认跳转事件
+     * @group basic
+     */
+    disabledJump: boolean;
+    /**
+     * @default
+     * @required false
+     * @description 页面初始化时希望额外向上滚动的距离，例如在target有较大padding但是希望内容显示在上方时可设置。
+     * @group ui
+     */
+    initOffset: number;
+    /**
+     * @detail { title: string; href: string }
+     * @description 锚点点击事件
+     */
+    anchorClick: EventEmitter<Record<string, any>>;
+    private _handleClick;
+    /**
+     * @detail { currentActiveLink: string }
+     * @description 锚点改变事件
+     */
+    anchorChange: EventEmitter<Record<string, any>>;
+    private _handleChange;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/general-button/GeneralButton.d.ts

@@ -0,0 +1,38 @@
+import React from "react";
+import { ButtonProps } from "antd/lib/button";
+import { TooltipConfig } from ".";
+declare const ButtonTypes: [
+    "default",
+    "primary",
+    "ghost",
+    "dashed",
+    "link",
+    "text",
+    "icon",
+    "nav"
+];
+declare type ButtonType = typeof ButtonTypes[number];
+interface LegacyGeneralButtonProps {
+    buttonName?: string;
+    buttonType?: ButtonType;
+    buttonDanger?: boolean;
+    buttonIcon?: string;
+    buttonShape?: "circle" | "round";
+    buttonSize?: "xs" | "small" | "large";
+    buttonProps?: ButtonProps & {
+        icon?: string;
+    };
+    buttonUrl?: string;
+    buttonHref?: string;
+    onClick?: () => void;
+    disabled?: boolean;
+    loading?: boolean;
+    disabledTooltip?: string;
+    tooltip?: string;
+    tooltipConfig?: TooltipConfig;
+    target?: string;
+    fadedText?: boolean;
+    buttonStyle?: React.CSSProperties;
+}
+export declare function GeneralButton({ buttonName, buttonType, buttonDanger, buttonIcon, buttonShape, buttonSize, buttonProps, buttonUrl, buttonHref, onClick, disabled, loading, disabledTooltip, tooltip, target, tooltipConfig, fadedText, buttonStyle, }: LegacyGeneralButtonProps): React.ReactElement;
+export {};