@next-bricks/basic-bricks 1.258.12 → 1.259.0

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

@@ -0,0 +1,249 @@
+import React from "react";
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { ButtonProps } from "antd/lib/button";
+export interface GeneralButtonElementProps {
+    buttonName?: string;
+    buttonIcon?: any;
+    buttonType?: ButtonType;
+    tooltip?: string;
+    disabled?: boolean;
+    disabledTooltip?: string;
+    tooltipConfig?: TooltipConfig;
+    buttonUrl?: string;
+    buttonHref?: string;
+    target?: string;
+    dataSource?: Record<string, any>;
+    buttonProps?: ButtonProps & {
+        icon?: string;
+    };
+    loading?: boolean;
+    buttonDanger?: boolean;
+    buttonShape?: "circle" | "round";
+    buttonSize?: "xs" | "small" | "large";
+    fadedText?: boolean;
+    buttonStyle?: React.CSSProperties;
+    detail?: Record<string, any>;
+}
+declare const ButtonTypes: [
+    "default",
+    "primary",
+    "ghost",
+    "dashed",
+    "link",
+    "text",
+    "icon"
+];
+declare type ButtonType = typeof ButtonTypes[number];
+export declare type TooltipPlacement = "top" | "left" | "right" | "bottom" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | "leftTop" | "leftBottom" | "rightTop" | "rightBottom";
+export interface TooltipConfig {
+    /**
+     * 气泡框位置，可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom`
+     */
+    placement?: TooltipPlacement;
+    /**
+     * 箭头是否指向目标元素中心
+     */
+    arrowPointAtCenter?: boolean;
+    /**
+     * 卡片样式
+     */
+    overlayStyle?: React.CSSProperties;
+    /**
+     * 卡片内容区域的样式对象
+     */
+    overlayInnerStyle?: React.CSSProperties;
+}
+/**
+ * @id basic-bricks.general-button
+ * @name basic-bricks.general-button
+ * @docKind brick
+ * @description 可发送点击事件、可配置按钮名称、按钮跳转链接等
+ * @author jo
+ * @slots
+ * @history
+ * 1.54.0:新增属性 `buttonHref`
+ * 1.55.1:使用 `dataSource` 替代 `detail`
+ * 1.59.0:新增属性 `disableAfterClick`
+ * 1.97.0:新增属性 `fadedText`
+ * @memo
+ * 注意，因为按钮是有 margin 的，在`type=link` 时候也一样会有，所以在表格里面放置点击链接的时候，请选用[链接](developers/brick-book/brick/presentational-bricks.brick-link)
+ *
+ * @noInheritDoc
+ */
+export declare class GeneralButtonElement extends UpdatingElement implements GeneralButtonElementProps {
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 按钮名称
+     * @group basic
+     */
+    buttonName: string;
+    /**
+     * @kind MenuIcon
+     * @required false
+     * @default -
+     * @description 按钮 icon，支持的 [icon 图标库](developers/icon) 和 [MenuIcon配置](/next-docs/docs/api-reference/brick-types.menuicon#menuicon-interface)，另外如果是 antd 图标库可以直接引用图标名称配置 { "lib": "antd", "icon": "edit" }与 "edit"等价
+     * @group basic
+     */
+    buttonIcon: any;
+    /**
+     * @kind ButtonType
+     * @required false
+     * @default -
+     * @description 按钮类型  ButtonType(`"link" | "default" | "primary" | "ghost" | "dashed" | "danger" | "icon"| "text" | "nav"`)
+     * @enums "link"|"default"|"primary"|"ghost"|"dashed"|"danger"|"icon"|"text"|"nav"
+     * @group basic
+     */
+    buttonType: ButtonType;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 按钮的 tooltip
+     * @group basic
+     */
+    tooltip: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否禁用按钮
+     * @group basic
+     */
+    disabled: boolean;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 禁用按钮的 tooltip
+     * @group basic
+     */
+    disabledTooltip: string;
+    /**
+     * @kind TooltipConfig
+     * @required false
+     * @default -
+     * @description tooltip的配置,配置属性见TooltipConfig
+     * @group basic
+     */
+    tooltipConfig: TooltipConfig;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 点击按钮跳转的 url
+     * @group basic
+     */
+    buttonUrl: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 是否使用原生 <a> 标签，通常用于外链的跳转
+     * @group advanced
+     */
+    buttonHref: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 跳转的 target，例如可以设置为"_blank"
+     * @group advanced
+     */
+    target: string;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default {}
+     * @description 替代之前 detail 属性，用法相同。暂存的数据在事件传出时使用
+     * @group advanced
+     */
+    dataSource: Record<string, any>;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 点击按钮后自动禁用
+     * @group advanced
+     */
+    disableAfterClick: boolean;
+    /**
+     * @kind ButtonProps
+     * @required -
+     * @default -
+     * @description 完全透传给 antd 的 Button 属性
+     * @group advanced
+     */
+    buttonProps: ButtonProps & {
+        icon?: string;
+    };
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 按钮加载动画
+     * @group ui
+     */
+    loading: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 设置危险按钮
+     * @group ui
+     */
+    buttonDanger: boolean;
+    /**
+     * @kind "circle" | "round"
+     * @required false
+     * @default -
+     * @description 按钮形状，支持圆形、椭圆形，不设置为默认方形
+     * @enums "circle"|"round"
+     * @group ui
+     */
+    buttonShape: "circle" | "round";
+    /**
+     * @kind xs | small | large
+     * @required false
+     * @default -
+     * @description 按钮大小，支持大、小、较小、不设置为默认中
+     * @enums "xs" | "small"| "large"
+     * @group ui
+     */
+    buttonSize: "xs" | "small" | "large";
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 淡化按钮文字，按钮类型为 text 时可以设置。默认 `false` 文字按钮颜色和平台的字体颜色一样，在一些希望弱化文字颜色的场景下可以设置为 `true`。
+     * @group ui
+     */
+    fadedText: boolean;
+    /**
+     * @kind React.CSSProperties
+     * @required -
+     * @default -
+     * @description 适用于按钮某些场景下，需要自定义一些样式
+     * @group ui
+     */
+    buttonStyle: React.CSSProperties;
+    /**
+     * @kind any
+     * @required false
+     * @default {}
+     * @deprecated
+     * @description [已废弃]按钮点击事件传出的内容。当用于列表类构件，例如 `brick-table` 中，可通过传入传入 `detail` 来识别不通的行进行操作处理。
+     */
+    detail: Record<string, any>;
+    /**
+     * @detail `Record<string, any>`
+     * @description 按钮被点击时触发, detail 为 dataSource 数据
+     */
+    buttonClick: EventEmitter<Record<string, any>>;
+    private _handleClick;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}
+export {};

package/dist/types/basic-bricks/src/general-card/GeneralCard.d.ts

@@ -0,0 +1,15 @@
+import React from "react";
+import { CardProps } from "antd/lib/card";
+import { OperationButton } from "../interfaces";
+export interface GeneralCardProps {
+    configProps?: CardProps;
+    operationButtons?: OperationButton[];
+    hasExtraSlot?: boolean;
+    cardTitle?: string;
+    fillVertical?: boolean;
+    verticalCenter?: boolean;
+    isFixedFooter?: boolean;
+    compactMode?: boolean;
+    cardContentWrapperStyle?: React.CSSProperties;
+}
+export declare function GeneralCard({ configProps, operationButtons, hasExtraSlot, cardTitle, fillVertical, verticalCenter, isFixedFooter, compactMode, cardContentWrapperStyle, }: GeneralCardProps): React.ReactElement;

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

@@ -0,0 +1,120 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+import { OperationButton } from "../interfaces";
+import { CardProps } from "antd/lib/card";
+export interface GeneralCardElementProps {
+    operationButtons?: OperationButton[];
+    configProps?: CardProps;
+    cardContentWrapperStyle?: React.CSSProperties;
+    cardTitle?: string;
+    fillVertical?: boolean;
+    verticalCenter?: boolean;
+    compactMode?: boolean;
+    hasExtraSlot?: boolean;
+    hasFooter?: boolean;
+    isFixedFooter?: boolean;
+}
+/**
+ * @id basic-bricks.general-card
+ * @name basic-bricks.general-card
+ * @docKind brick
+ * @description 常见于为多个构件提供统一的卡片容器，比如将搜索框与表格放在一起
+ * @author lynette
+ * @slots
+ * content:内容插槽
+ * extra:右上角操作区插槽，使用时请设置 hasExtraSlot 为 true
+ * titleSuffix:标题后缀的插槽
+ * footer:底部插槽，当底部滚动到窗口外时，默认固定在窗口底部，适用场景参考 http://192.168.100.162/next/resource-events/alert-config/inhibition-rule/create，其他情况，请设置`isFixedFooter`为false；
+ * @history
+ * 1.42.0:新增属性 `fillVertical`
+ * @noInheritDoc
+ */
+export declare class GeneralCardElement extends UpdatingElement implements GeneralCardElementProps {
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 卡片标题
+     * @group basic
+     */
+    cardTitle: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 设置该属性后，设置卡片高度为 100%，卡片高度会自动撑满父容器
+     * @group ui
+     */
+    fillVertical: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 设置该属性后，卡片内容区的元素自动垂直居中
+     * @group ui
+     */
+    verticalCenter: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 卡片是否ui8.2的紧凑模式
+     * @group ui
+     */
+    compactMode: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否右上角有操作区 slot
+     * @group advanced
+     */
+    hasExtraSlot: boolean;
+    /**
+     * @group advanced
+     */
+    hasFooter: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description footer滚动到窗口外时，是否需要将footer固定在窗口底部
+     * @group advanced
+     */
+    isFixedFooter: boolean;
+    /**
+     * @kind OperationButton[]
+     * @required false
+     * @default -
+     * @description 右上角的操作按钮列表，可自定义指定该按钮的名字，按钮点击后发出的事件等
+     * @group advanced
+     */
+    operationButtons: OperationButton[];
+    /**
+     * @kind map
+     * @required false
+     * @default -
+     * @description 完全透传给 antd 的 Card 属性，详见：[Card](https://ant.design/components/card-cn/#Card)
+     * @group advanced
+     */
+    configProps: CardProps;
+    /**
+     * @description content slot外层元素样式
+     * @group ui
+     */
+    cardContentWrapperStyle: React.CSSProperties;
+    private _mountPoint;
+    private _shadowRoot;
+    private _operationBtns;
+    private idEventNameMap;
+    private eventDetailMap;
+    private _getFooterSlot;
+    private _checkFooterSlot;
+    constructor();
+    connectedCallback(): void;
+    listenOnClick(): void;
+    dealCustomEvent(event: CustomEvent): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+    emitEvent(eventName: string): void;
+}

package/dist/types/basic-bricks/src/general-custom-buttons/GeneralCustomButtons.d.ts

@@ -0,0 +1,31 @@
+import React from "react";
+import { MenuIcon } from "@next-core/brick-types";
+import { CustomButton, DropdownPlacement } from "./index";
+declare const ButtonTypes: [
+    "default",
+    "primary",
+    "ghost",
+    "dashed",
+    "link",
+    "text",
+    "icon"
+];
+declare type ButtonType = typeof ButtonTypes[number];
+interface AdminButtonProps {
+    buttons: CustomButton[];
+    handleClick: (eventName: string, button: CustomButton) => void;
+    dropdownBtnText?: string;
+    dropdownBtnIcon?: MenuIcon | string;
+    isMoreButton?: boolean;
+    useButtonDataSource?: boolean;
+    moreBtnIcon?: MenuIcon | string;
+    moreButtonShape?: "circle" | "rectangle" | "no" | "icon";
+    moreButtonType?: ButtonType;
+    alignment?: "start" | "center" | "end" | "stretch";
+    dropdownPlacement?: DropdownPlacement;
+    dropdownBtnType?: "default" | "link";
+    onDropdownVisibleChange: (visible: boolean) => void;
+    moreButtonStyle?: React.CSSProperties;
+}
+export declare function GeneralCustomButtons(props: AdminButtonProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,235 @@
+import React from "react";
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { MenuIcon } from "@next-core/brick-types";
+import { ButtonType, ButtonShape, ButtonSize } from "antd/lib/button";
+import { TooltipPlacement } from "antd/lib/tooltip";
+export interface GeneralCustomButtonsElementProps {
+    customButtons: CustomButton[];
+    dataSource?: any;
+    moreBtnIcon?: MenuIcon | string;
+    dropdownBtnType?: "default" | "link";
+    dropdownBtnIcon?: MenuIcon | string;
+    moreButtonStyle: React.CSSProperties;
+}
+export interface CustomButton {
+    /**
+     * 是否收纳成下拉框
+     */
+    isDropdown?: boolean;
+    /**
+     * 菜单项分割线，只用在弹出菜单内
+     */
+    isDivider?: boolean;
+    /**
+     * 按钮名
+     */
+    text: string;
+    /**
+     * 按钮 icon，支持[icon图标库](/next/developers/icon)，可直接复制图标图标的配置（antd、fa 及 easyops 三种库都支持），也可只取 icon 字段的值（仅支持 antd 库）。配置{ "lib": "antd", "icon": "edit" }与 "edit"等价
+     */
+    icon?: MenuIcon | string;
+    /**
+     * 按钮点击事件名
+     */
+    eventName: string;
+    /**
+     * 按钮字体颜色
+     */
+    color?: string;
+    /**
+     * 按钮 ID, updateButton 时使用
+     */
+    id?: string;
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * 是否隐藏
+     */
+    hide?: boolean;
+    /**
+     * 样式类型
+     */
+    buttonType?: ButtonType | "icon";
+    /**
+     * 形状类型
+     */
+    buttonShape?: ButtonShape;
+    /**
+     * 点击跳转的地址，一般站内链接使用此属性
+     */
+    buttonUrl?: string;
+    /**
+     * 点击跳转的地址，一般站外链接使用此属性
+     */
+    buttonHref?: string;
+    /**
+     * 按钮大小
+     */
+    buttonSize?: ButtonSize;
+    /**
+     * 相当于 a 链接的 target 属性，buttonUrl 或 buttonHref 存在时生效
+     */
+    urlTarget?: string;
+    /**
+     * 	按钮简单的文字提示气泡框
+     */
+    tooltip?: string;
+    /**
+     * 	禁用按钮的 tooltip
+     */
+    disabledTooltip?: string;
+    /**
+     * tooltip 位置
+     */
+    tooltipPlacement?: TooltipPlacement;
+    /**
+     * 设置按钮载入状态
+     */
+    loading?: boolean;
+    /**
+     * 用于测试时定位的 ID
+     */
+    testId?: string;
+    /**
+     * 是否显示为危险样式
+     */
+    danger?: boolean;
+    /**
+     * 每个事件的数据源
+     */
+    dataSource?: any;
+}
+export declare type DropdownPlacement = "bottomRight" | "topLeft" | "topCenter" | "topRight" | "bottomLeft" | "bottomCenter";
+/**
+ * @id basic-bricks.general-custom-buttons
+ * @name basic-bricks.general-custom-buttons
+ * @docKind brick
+ * @description 可配置收纳起来的更多按钮，可配置不同事件
+ * @groupI18N
+ * {
+ *   "moreButton": {
+ *     "en": "MoreButton",
+ *     "zh": "更多按钮"
+ *   },
+ *   "dropdownButton": {
+ *     "en": "DropdownButton",
+ *     "zh": "含下拉选框的按钮"
+ *   }
+ * }
+ * @author ice
+ * @slots
+ * @history
+ * 1.72.0:新增属性 `loading`
+ * 1.59.0:新增属性 `disableAfterClick`
+ * 1.48.0:按钮新增 `hide` 属性
+ * 1.45.0:新增 `dropdownPlacement` 属性, 按钮新增 `isDivider` 属性
+ * 1.40.0:按钮新增 `buttonHref`, `tooltip`, `tooltipPlacement` 属性
+ * 1.35.0:新增 `alignment` 属性
+ * 1.30.0:按钮新增 `buttonSize`, `buttonUrl`, `urlTarget` 属性
+ * 1.29.0:按钮新增 `buttonType`, `buttonShape` 属性
+ * 1.28.0:新增 `updateButton` 方法，按钮新增 `id`, `disabled` 属性
+ * @memo
+ * @noInheritDoc
+ */
+export declare class GeneralCustomButtonsElement extends UpdatingElement implements GeneralCustomButtonsElementProps {
+    /**
+     * @kind CustomButton[]
+     * @description 自定义按钮组
+     * @group basic
+     */
+    customButtons: CustomButton[];
+    /**
+     * @default "center"
+     * @description 对齐方式
+     * @enums "start"|"center"|"end"|"stretch
+     * @group basic
+     */
+    alignment?: "start" | "center" | "end" | "stretch";
+    /**
+     * @description 按钮事件的 detail
+     * @group advanced
+     */
+    dataSource?: any;
+    /**
+     * @description 点击按钮后自动禁用
+     * @group advanced
+     */
+    disableAfterClick?: boolean;
+    /**
+     * @default false
+     * @description 按钮组中 isDropdown 为 true 的按钮收纳成 dropdown。isMoreButton 为 true 时更多按钮显示纯icon样式，为 false 时显示icon+文字样式。
+     * @group moreButton
+     */
+    isMoreButton?: boolean;
+    /**
+     * @default false
+     * @description 按钮组中 的按钮点击事件的detail返回按钮自身的dataSource，而不是整体的dataSource
+     * @group moreButton
+     */
+    useButtonDataSource?: boolean;
+    /**
+     * @description isMoreButton 为 true 时更多按钮的图标，默认为`...`
+     * @group moreButton
+     */
+    moreBtnIcon?: MenuIcon | string;
+    /**
+     * @description 更多按钮的类型
+     * @group moreButton
+     */
+    moreButtonType?: ButtonType;
+    /**
+     * @description isMoreButton 为 true 时更多按钮的样式，通常使用 icon 类型
+     * @enums "circle"|"no"|"rectangle"|"icon"
+     * @group moreButton
+     */
+    moreButtonShape?: "circle" | "no" | "rectangle" | "icon";
+    /**
+     * @default "管理"
+     * @description isMoreButton 为 false 时，按钮组中 isDropdown 为 true 的按钮收纳成 dropdown，收纳起来的按钮文字
+     * @group dropdownButton
+     */
+    dropdownBtnText?: string;
+    /**
+     * @description dropdown按钮的类型
+     * @enums "default"|"link"
+     * @group dropdownButton
+     */
+    dropdownBtnType?: "default" | "link";
+    /**
+     * @description isMoreButton 为 false 时，按钮组中 isDropdown 为 true 的按钮收纳成 dropdown，收纳起来的按钮 icon，支持[icon 图标库](/next/developers/icon)，可直接复制图标图标的配置（antd、fa 及 easyops 三种库都支持），也可只取 icon 字段的值（仅支持 antd 库）。配置{ "lib": "antd", "icon": "edit" }与 "edit"等价
+     * @group dropdownButton
+     */
+    dropdownBtnIcon?: MenuIcon | string;
+    /**
+     * @default "bottomRight"
+     * @description dropdown 的弹出位置
+     * @enums "bottomRight"|"topLeft"|"topCenter"|"topRight"|"bottomLeft"|"bottomCenter"
+     * @group dropdownButton
+     */
+    dropdownPlacement?: DropdownPlacement;
+    /**
+     * @kind React.CSSProperties
+     * @required -
+     * @default -
+     * @description 适用于按钮的isMoreButton为true时候，需要自定义一些样式更多按钮的样式。
+     * @group ui
+     */
+    moreButtonStyle: React.CSSProperties;
+    /**
+     * @detail "boolean"
+     * @description dropdown是否显示
+     */
+    onDropdownVisibleChange: EventEmitter<boolean>;
+    constructor();
+    private handleClick;
+    connectedCallback(): void;
+    /**
+     * @description 更新按钮
+     */
+    updateButton(id: string, btn: Partial<CustomButton>): void;
+    handleDropdownVisibleChange: (visible: boolean) => void;
+    protected _render(): void;
+    disconnectedCallback(): void;
+}

package/dist/types/basic-bricks/src/general-drawer/GeneralDrawer.d.ts

@@ -0,0 +1,27 @@
+import React from "react";
+import { DrawerProps } from "antd/lib/drawer";
+import type { ModalStack } from "@next-core/brick-kit";
+import { ICustomSwitchConfig } from "./index";
+interface GeneralDrawerProps {
+    visible: boolean;
+    title?: string;
+    width?: number | string;
+    getContainer?: HTMLElement;
+    closable?: boolean;
+    bodyStyle?: Record<string, any>;
+    drawerStyle?: Record<string, any>;
+    hasFooter?: boolean;
+    loading?: boolean;
+    mask?: boolean;
+    headerStyle?: Record<string, any>;
+    configProps?: DrawerProps;
+    isFloat?: boolean;
+    hasOuterSwitch?: boolean;
+    useBigOuterSwitch?: boolean;
+    customSwitchConfig?: ICustomSwitchConfig;
+    scrollToTopWhenOpen?: boolean;
+    stack: ModalStack;
+    stackable?: boolean;
+}
+export declare function GeneralDrawer(props: GeneralDrawerProps): React.ReactElement;
+export {};