@next-bricks/basic-bricks 1.258.12 → 1.259.0

package/dist/types/basic-bricks/src/menu-bar/index.d.ts

@@ -0,0 +1,96 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+import { SidebarMenu, SidebarSubMenu, MenuBarBrick } from "@next-core/brick-types";
+export interface MenuBarElementProps extends Partial<MenuBarBrick> {
+    menu?: SidebarMenu;
+    subMenu?: SidebarSubMenu;
+    collapsed?: boolean;
+}
+/**
+* @id basic-bricks.menu-bar
+* @name basic-bricks.menu-bar
+* @docKind brick
+* @editor shared-editors.general-menu--editor
+* @description 点击后注意左侧菜单即为效果图，点击浏览器返回
+* @author steve
+* @slots
+* @history
+* @deprecated
+* @memo
+* 该构件已迁移至 `nav-legacy` 包中维护，后续版本将不再维护该构件，请使用 `nav-legacy.menu-bar` 构件
+*
+*
+* > Tips: 因为绝对定位的原因，当前菜单被覆盖，右侧即为效果图，如果需要返回开发者中心，请点击浏览器返回
+*```typescript
+* export interface SidebarMenu {
+*  title: string;
+*  icon?: MenuIcon;
+*  link?: LocationDescriptor;
+*  defaultCollapsed?: boolean;
+*  menuItems: SidebarMenuItem[];
+* }
+* export declare type SidebarMenuItem = SidebarMenuSimpleItem | SidebarMenuGroup;
+* export interface SidebarMenuSimpleItem {
+*  text: string;
+*  to: LocationDescriptor;
+*  icon?: MenuIcon;
+*  type?: "default";
+*  exact?: boolean;
+*  activeIncludes?: string[];
+*  activeExcludes?: string[];
+*  key?: string;
+*}
+*export interface SidebarMenuGroup {
+*  type: "group" | "subMenu";
+*  title: string;
+*  items: SidebarMenuItem[];
+*  key?: string;
+*}
+* export declare type MenuIcon = AntdIcon | FaIcon | EasyopsIcon;
+* export interface AntdIcon {
+*  lib: "antd";
+*  type: string;
+*  theme?: ThemeType;
+*}
+*export interface FaIcon {
+*  lib: "fa";
+*  icon: IconName;
+*  prefix?: IconPrefix;
+*}
+*export interface EasyopsIcon {
+*  lib: "easyops";
+*  icon: string;
+*  category?: string;
+*}
+*```
+
+*
+* @noInheritDoc
+*/
+export declare class MenuBarElement extends UpdatingElement implements MenuBarElementProps {
+    /**
+     * @kind SidebarMenu
+     * @required true
+     * @default -
+     * @description 菜单项
+     */
+    menu: SidebarMenu;
+    /**
+     * @kind SidebarMenu
+     * @required true
+     * @default -
+     * @description 二级菜单项
+     */
+    subMenu: SidebarSubMenu;
+    /**
+     * @kind boolean
+     * @required true
+     * @default -
+     * @description 是否折叠
+     */
+    collapsed: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+    set softExpanded(value: boolean);
+    get softExpanded(): boolean;
+}

package/dist/types/basic-bricks/src/micro-app/BtnExitDashboardMode.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export declare function BtnExitDashboardMode(): React.ReactElement;

package/dist/types/basic-bricks/src/micro-app/MicroApp.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+interface MicroAppProps {
+    pageTitle?: string;
+    pageTitleScale?: number;
+    bannerPageTitle?: string;
+    bannerStyle?: React.CSSProperties;
+    noGap?: boolean;
+    dashboardMode?: boolean;
+    hideLogo?: boolean;
+    hideExitBtn?: boolean;
+}
+export declare function MicroApp({ pageTitle, pageTitleScale, bannerPageTitle, bannerStyle, noGap, dashboardMode, hideLogo, hideExitBtn, }: MicroAppProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,152 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface MicroViewElementProps {
+    pageTitle?: string;
+    bannerPageTitle?: string;
+    overflowXAuto?: boolean;
+    noGap?: boolean;
+    dashboardMode?: boolean;
+    pageTitleScale?: number;
+    hideToolbar?: boolean;
+    hideLogo?: boolean;
+    hideExitBtn?: boolean;
+    hasToolbar?: boolean;
+    hasTitleBar?: boolean;
+    hasSubMenu?: boolean;
+    hasBanner?: boolean;
+    hasBannerTitleBar?: boolean;
+    hasBannerToolbar?: boolean;
+    bannerStyle?: React.CSSProperties;
+}
+/**
+ * @id basic-bricks.micro-view
+ * @name basic-bricks.micro-view
+ * @docKind brick
+ * @description 通用页面视图容器, 提供了 titleBar、toolbar、content、subMenu、banner、bannerTitleBar、bannerToolbar 插槽
+ * @author steve
+ * @slots
+ * titleBar: 左上角页面标题
+ * toolbar: 右上角页面操作栏
+ * content: 内容区
+ * subMenu: 内面内的左侧子菜单
+ * banner: 顶部的 banner 的内容区
+ * bannerTitleBar: 顶部的 banner 的标题
+ * bannerToolbar: 顶部的 banner 的操作栏
+ * @history
+ * 1.19.0:新增构件
+ * 1.89.0:新增 bannerPageTitle、bannerStyle 属性，banner、bannerTitleBar、bannerToolbar 插槽
+ * @memo
+ * @noInheritDoc
+ */
+export declare class MicroViewElement extends UpdatingElement implements MicroViewElementProps {
+    /**
+     * @kind string
+     * @required -
+     * @default -
+     * @description 设置标题。如果要使用复杂的标题构件，请使用插槽 `titleBar`
+     * @group basic
+     */
+    pageTitle: string;
+    /**
+     * @kind string
+     * @required -
+     * @default -
+     * @description 设置 banner 标题。如果要使用复杂的标题构件，请使用插槽 `bannerTitleBar`
+     * @group other
+     */
+    bannerPageTitle: string;
+    /**
+     * @kind boolean
+     * @required -
+     * @default false
+     * @description 内容区是否需要设置`overflow-x: auto`
+     * @group ui
+     */
+    overflowXAuto: boolean;
+    /**
+     * @kind boolean
+     * @required -
+     * @default false
+     * @description 内容区默认为 grid 布局且有默认的 gap，设为 `true` 则使之没有 gap。
+     * @group ui
+     */
+    noGap: boolean;
+    /**
+     * @kind boolean
+     * @default false
+     * @description 是否启用大屏模式。
+     * @group ui
+     */
+    dashboardMode: boolean;
+    /**
+     * @description 标题栏大小比例，默认为 1，仅用于暗黑大屏模式。
+     * @group ui
+     */
+    pageTitleScale?: number;
+    /**
+     * @kind boolean
+     * @default false
+     * @description 是否隐藏工具栏（常用语大屏模式）。
+     * @group ui
+     */
+    hideToolbar: boolean;
+    /**
+     * @default -
+     * @description banner 的样式
+     * @group ui
+     */
+    bannerStyle?: React.CSSProperties;
+    /**
+     * @kind boolean
+     * @required -
+     * @default false
+     * @description 隐藏logo
+     * @group ui
+     */
+    hideLogo: boolean;
+    /**
+     * @kind boolean
+     * @required -
+     * @default false
+     * @description 隐藏退出按钮
+     * @group ui
+     */
+    hideExitBtn: boolean;
+    /**
+     * @private
+     */
+    hasSubMenu: boolean;
+    /**
+     * @private
+     *
+     */
+    hasTitleBar: boolean;
+    /**
+     * @private
+     */
+    hasToolbar: boolean;
+    /**
+     * @private
+     */
+    hasBanner: boolean;
+    /**
+     * @private
+     */
+    hasBannerTitleBar: boolean;
+    /**
+     * @private
+     */
+    hasBannerToolbar: boolean;
+    /**
+     * @description 用户点击退出大屏模式时触发。
+     */
+    private _modeDashboardExitEmitter;
+    private _mountPoint;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+    private _initInternalListeners;
+    private _getSlotBySelector;
+    private _checkSlotBySelector;
+}

package/dist/types/basic-bricks/src/multiple-columns-card/MultipleColumnsCard.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export interface MultipleColumnsCardProps {
+    cardBorder: boolean;
+    gridColumns: string | Array<string | number>;
+}
+export declare function transformCss(gridColumns: MultipleColumnsCardProps["gridColumns"]): string | number;
+export declare function MultipleColumnsCard({ cardBorder, gridColumns }: MultipleColumnsCardProps): React.ReactElement;

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

@@ -0,0 +1,38 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface MultipleColumnsCardElementProps {
+    gridColumns?: string;
+    cardBorder?: boolean;
+}
+/**
+ * @id basic-bricks.multiple-columns-card
+ * @name basic-bricks.multiple-columns-card
+ * @docKind brick
+ * @description 支持多列布局的容器
+ * @author jo
+ * @slots
+ * @history
+ * @memo
+ * Tips: 多列布局默认每一列都会有 padding，如果其中某一列不需要则在相应的用户构件 storyboard 内配置 columns-card-no-padding 的类名属性即可，如示例二所示
+ * @noInheritDoc
+ */
+export declare class MultipleColumnsCardElement extends UpdatingElement implements MultipleColumnsCardElementProps {
+    /**
+     * @kind `Array<string | number>`
+     * @required false
+     * @default -
+     * @description 配置多列布局时每一列的宽度，可以是具体的像素长度`200px`，也可以是数字`1，2...`等等，表示该列的宽度为相应的比例值，列数要与放入插槽的构件数相符
+     */
+    gridColumns: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default `true`
+     * @description 是否显示卡片边框
+     */
+    cardBorder: boolean;
+    private _mountPoint;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/page-error/PageError.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+interface PageErrorProps {
+    error: string;
+    code: number;
+}
+export declare function PageError(props: PageErrorProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,4 @@
+export interface PageErrorElementProps {
+    error?: string;
+    code?: number;
+}

package/dist/types/basic-bricks/src/page-not-found/PageNotFound.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+interface PageNotFoundProps {
+    url: string;
+}
+export declare function PageNotFound(props: PageNotFoundProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/page-not-found/index.d.ts

@@ -0,0 +1,10 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface PageNotFoundElementProps {
+    url?: string;
+}
+export declare class PageNotFoundElement extends UpdatingElement implements PageNotFoundElementProps {
+    url: string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/page-title/PageTitle.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+interface PageTitleProps {
+    pageTitle: string;
+    pageTitleScale?: number;
+    dashboardMode?: boolean;
+}
+export declare function PageTitle({ pageTitle, pageTitleScale, dashboardMode, }: PageTitleProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,36 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface PageTitleElementProps {
+    pageTitle?: string;
+    dashboardMode?: boolean;
+}
+/**
+ * @id basic-bricks.page-title
+ * @name basic-bricks.page-title
+ * @docKind brick
+ * @description 页面标题，在`basic-bricks.micro-view`的titleBar插槽中使用，如果只是普通字符串的可用pageTitle属性代替，如果是动态的话则用这个构件
+ * @author steve
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class PageTitleElement extends UpdatingElement implements PageTitleElementProps {
+    /**
+     * @required true
+     * @default -
+     * @description 页面标题
+     * @group basic
+     */
+    pageTitle: string;
+    /**
+     * @kind boolean
+     * @default false
+     * @description 是否以 dashboard 模式显示
+     * @group basic
+     */
+    dashboardMode?: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+    setPageTitle(value: string): void;
+}

package/dist/types/basic-bricks/src/popover-container/PopoverContainer.d.ts

@@ -0,0 +1,39 @@
+import React from "react";
+import { UseBrickConf, MenuIcon } from "@next-core/brick-types";
+import { TooltipPlacement } from "antd/lib/tooltip";
+import { ActionType, AlignType } from "rc-trigger/lib/interface";
+interface PopoverContainerProps {
+    data?: any;
+    visible?: boolean;
+    displayBrick: {
+        useBrick: UseBrickConf;
+        data?: any;
+    };
+    popoverBrick: {
+        useBrick: UseBrickConf;
+        data?: any;
+    };
+    popoverTitleBrick?: {
+        useBrick: UseBrickConf;
+    };
+    align?: AlignType;
+    getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
+    onVisibleChange?: (visible: boolean) => void;
+    popoverIcon?: MenuIcon;
+    placement?: TooltipPlacement;
+    trigger?: ActionType | ActionType[];
+    showPopoverBg?: boolean;
+    popoverContentStyle?: Record<string, any>;
+    triggerByIcon?: boolean;
+    showIcon?: "always" | "never" | "hover";
+    related?: boolean;
+    highlighted?: boolean;
+    faded?: boolean;
+    transferGraphAttrs?: boolean;
+    zIndex?: number;
+    itemMouseEnter?: () => void;
+    itemMouseLeave?: () => void;
+    transferVisible?: boolean;
+}
+export declare function PopoverContainer(props: PopoverContainerProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/popover-container/index.d.ts

@@ -0,0 +1,244 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { UseBrickConf, MenuIcon } from "@next-core/brick-types";
+import { TooltipPlacement } from "antd/lib/tooltip";
+import { ActionType, AlignType } from "rc-trigger/lib/interface";
+export interface PopoverContainerElementProps {
+    data?: any;
+    displayBrick?: {
+        useBrick: UseBrickConf;
+        data?: any;
+    };
+    popoverTitleBrick?: {
+        useBrick: UseBrickConf;
+    };
+    align?: AlignType;
+    popoverBrick: {
+        useBrick: UseBrickConf;
+        data?: any;
+    };
+    popoverIcon?: MenuIcon;
+    placement?: TooltipPlacement;
+    trigger?: ActionType | ActionType[];
+    popoverContentStyle?: Record<string, any>;
+    showIcon?: "always" | "never" | "hover";
+    zIndex?: number;
+    highlighted?: boolean;
+    related?: boolean;
+    faded?: boolean;
+    transferGraphAttrs?: boolean;
+    transferVisible?: boolean;
+    getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
+}
+/**
+ * @id basic-bricks.popover-container
+ * @name basic-bricks.popover-container
+ * @docKind brick
+ * @description 可以配置显示构件和弹出框构件，常用于快速编辑和详情展示
+ * @author lynette
+ * @slots
+ * @history
+ * 1.39.0:新增属性 `triggerByIcon`,`showIcon`
+ * 1.33.0:新增构件 `basic-bricks.popover-container`
+ * @memo
+ * ### CustomBrick
+
+* | property | type         | required | default | description              |
+* | -------- | ------------ | -------- | ------- | ------------------------ |
+* | useBrick | UseBrickConf | ✔️       | -       | 自定义构件               |
+* | data     | any          | -        | -       | 数据，优先级高于整体数据 |
+
+### UseBrickConf
+
+* | property      | type           | required | default | description                                        |
+* | ------------- | -------------- | -------- | ------- | -------------------------------------------------- |
+* | brick         | string         | ✔️       | -       | 构件名称                                           |
+* | properties    | object         | -        | -       | 构件属性                                           |
+* | events        | BrickEventsMap | -        | -       | 事件                                               |
+* | transform     | string\|object | -        | -       | 属性数据转换                                       |
+* | transformFrom | string         | -        | -       | 属性数据转换来自数据源的哪个字段，不填则为整个数据 |
+ * @noInheritDoc
+ */
+export declare class PopoverContainerElement extends UpdatingElement implements PopoverContainerElementProps {
+    /**
+     * @kind any
+     * @required false
+     * @default false
+     * @description 整体数据，如果展示构件和弹出框构件数据都来自于同一个 provider，可以直接配置 data，如果来源不一样，可以分别配置 CustomBrick.data
+     * @group basic
+     */
+    data: any;
+    /**
+     * @kind CustomBrick
+     * @required true
+     * @default -
+     * @description 展示构件
+     * @group basic
+     */
+    displayBrick: {
+        useBrick: UseBrickConf;
+        data?: any;
+    };
+    /**
+     * @kind UseBrickConf
+     * @description 弹出框title构件
+     * @group basic
+     */
+    popoverTitleBrick: {
+        useBrick: UseBrickConf;
+    };
+    /**
+     * @kind AlignType
+     * @description popover 的对其配置详情可查看 [AlignType](https://4x-ant-design.antgroup.com/components/tooltip-cn/)
+     * @group basic
+     */
+    align: AlignType;
+    /**
+     * @kind CustomBrick
+     * @required true
+     * @default -
+     * @description 弹出框构件
+     * @group basic
+     */
+    popoverBrick: {
+        useBrick: UseBrickConf;
+        data?: any;
+    };
+    /**
+     * @kind MenuIcon
+     * @required false
+     * @default { lib: "fa", icon: "pencil-alt", prefix: "fas" }
+     * @description 触发弹出框的 icon [MenuIcon](/next-docs/docs/api-reference/brick-types.menuicon#menuicon-interface)
+     * @group ui
+     */
+    popoverIcon: MenuIcon;
+    /**
+     * @kind top|left|right|bottom|topLeft|topRight|bottomLeft|bottomRight|leftTop|leftBottom|rightTop|rightBottom
+     * @required false
+     * @default bottom
+     * @description 气泡框位置。注意设置该属性的时候可能需要调整`popoverContentStyle`。
+     * @enums "top"|"left"|"right"|"bottom"|"topLeft"|"topRight"|"bottomLeft"|"bottomRight"|"leftTop"|"leftBottom"|"rightTop"|"rightBottom"
+     * @group basic
+     */
+    placement: TooltipPlacement;
+    /**
+     * @required false
+     * @default -
+     * @description 触发方式
+     * @group basic
+     */
+    trigger: ActionType | ActionType[];
+    /**
+     * @required false
+     * @description 触发行为
+     * @group basic
+     */
+    triggerByIcon: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否显示 popover 的默认背景
+     * @group basic
+     */
+    showPopoverBg: boolean;
+    /**
+     * @kind Record<string,any>
+     * @required false
+     * @default {width:200px}
+     * @description popover 内容区域的样式，默认给了 200 的宽度。由于我们的弹出框拥有自定义构件的能力，在第一次点击之前，popover 是不知道所渲染构件的宽高，可能发生错位的问题。可以通过设置宽高来解决问题。注意，根据不同的`placement`需要按需调整宽度/高度。[详见](https://github.com/ant-design/ant-design/issues/3545)
+     * @group basic
+     */
+    popoverContentStyle: Record<string, any>;
+    /**
+     * @kind "always"|"hover"|"never"
+     * @required false
+     * @default hover
+     * @description 在什么时候显示 Icon
+     * @enums "always"|"hover"|"never"
+     * @group ui
+     */
+    showIcon: "always" | "never" | "hover";
+    /**
+     * @kind number
+     * @required false
+     * @default 1030
+     * @description popover的z轴顺序
+     * @group ui
+     */
+    zIndex: number;
+    /**
+     * @kind {useBrick:UseBrickConf;data?:any}
+     * @required false
+     * @default false
+     * @description 弹出框是否可见
+     * @group ui
+     */
+    visible: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否高亮，由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。
+     * @group ui
+     */
+    highlighted: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否被关联，由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。
+     * @group ui
+     */
+    related: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否弱化，由[general-graph](developers/brick-book/brick/graph.general-graph)构件设置。
+     * @group ui
+     */
+    faded: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否透传拓扑视图的高亮相关属性给子展示构件。由于该构件常用于[general-graph](developers/brick-book/brick/graph.general-graph)构件，故特别增设该属性。开启之后将会透传highlighted(高亮节点)/related(关联节点)/faded(淡化节点)三个属性给子展示构件，以实现高亮功能。
+     * @group ui
+     */
+    transferGraphAttrs: boolean;
+    /**
+     * @kind (triggerNode: HTMLElement) => HTMLElement;
+     * @description 浮层渲染父节点，默认渲染到 body 上
+     * @group ui
+     */
+    getPopupContainer: (triggerNode: HTMLElement) => HTMLElement;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否透传 popover 构件的 visible给 popoverBrick 的子构件，以便用户对子构件做特殊处理
+     * @group ui
+     */
+    transferVisible: boolean;
+    /**
+     * @detail any
+     * @description 鼠标移动到元素上发出的事件，事件详情为用户设置的 data
+     */
+    itemMouseEnter: EventEmitter<any>;
+    /**
+     * @detail any
+     * @description 鼠标离开元素发出的事件，事件详情为用户设置的 data
+     */
+    itemMouseLeave: EventEmitter<any>;
+    private _itemMouseEnter;
+    private _itemMouseLeave;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    /**
+     * @detail {visible:boolean}
+     * @description 弹出框`是否可见`变化触发的事件
+     */
+    visibleChange: EventEmitter;
+    private _handleVisibleChange;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/print-button/PrintButton.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+interface PrintButtonProps {
+    prefixTitle: string;
+    backgroundColor?: string;
+    color?: string;
+    border?: string;
+    size?: number;
+}
+export declare function PrintButton(props: PrintButtonProps): React.ReactElement;
+export {};