@next-bricks/basic-bricks 1.258.12 → 1.259.0

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

@@ -0,0 +1,68 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface PrintButtonElementProps {
+    prefixTitle?: string;
+    right?: string;
+    bottom?: string;
+    color?: string;
+    border?: string;
+    backgroundColor?: string;
+}
+/**
+ * @id basic-bricks.print-button
+ * @name basic-bricks.print-button
+ * @docKind brick
+ * @description 触发打开浏览器的打印窗口
+ * @author momo
+ * @slots
+ * @history
+ * @memo
+ * @noInheritDoc
+ */
+export declare class PrintButtonElement extends UpdatingElement implements PrintButtonElementProps {
+    top: string;
+    /**
+     * @kind string
+     * @required true
+     * @default -
+     * @description 打印保存的 pdf 文件前缀
+     */
+    prefixTitle: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description fixed 布局下，按钮的位置
+     */
+    right: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description fixed 布局下，按钮的位置
+     */
+    bottom: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 按钮图标颜色
+     */
+    color: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 按钮边框
+     */
+    border: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 按钮的背景
+     */
+    backgroundColor: string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/quick-visit-menu/FavouriteMenu.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+export declare function arrayMoveImmutable(array: any, fromIndex: any, toIndex: any): any;
+export declare function FavouriteMenu({ menus, handleMenuRemove, handleMenuDrag, handleMenuClick, }: any): React.ReactElement;

package/dist/types/basic-bricks/src/quick-visit-menu/MenuTag.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+interface MenuTagProps {
+    menu: Record<string, unknown>;
+    handleCollect?: (item: Record<string, unknown>) => void;
+    target?: string;
+    handleMenuClick: (item: Record<string, unknown>) => void;
+    handleMenuRemove: (item: Record<string, unknown>) => void;
+    canCollect?: boolean;
+    handleCollectFailed?: () => void;
+    favouriteCount?: number;
+    maxFavouriteCount?: number;
+}
+export declare function MenuTag(props: MenuTagProps): React.ReactElement;
+export {};

package/dist/types/basic-bricks/src/quick-visit-menu/QuickVisitMenu.d.ts

@@ -0,0 +1,34 @@
+import React from "react";
+interface QuickVisitMenuProps {
+    buttonName: string;
+    searchPlaceholder?: string;
+    menu: Record<string, unknown>;
+    favouriteMenus?: Record<string, unknown>[];
+    handleMenuDrag: (items: Record<string, unknown>[]) => void;
+    handleMenuRemove: (items: Record<string, unknown>[]) => void;
+    handleMenuAdd: (items: Record<string, unknown>[]) => void;
+    handleMenuClick: (item: Record<string, unknown>) => void;
+    handleCollectFailed?: () => void;
+    maxFavouriteCount?: number;
+}
+interface MenuContainerProps {
+    searchPlaceholder?: string;
+    allMenus: Record<string, unknown>[];
+    favouriteMenus: Record<string, unknown>[];
+    handleMenuDrag?: (items: Record<string, unknown>[]) => void;
+    handleMenuRemove?: (items: Record<string, unknown>[]) => void;
+    handleMenuAdd?: (items: Record<string, unknown>[]) => void;
+    handleMenuClick?: (item: Record<string, unknown>) => void;
+    handleCollectFailed?: () => void;
+    maxFavouriteCount?: number;
+}
+export declare function filterMenuTitle(title: string, key: string): boolean;
+export declare function flagFavourite(favouriteMenus: Record<string, unknown>[], menu: any): boolean;
+export declare function flattenMenus(menu: any, favouriteMenus?: any[]): any[];
+export declare function menuIsSame(menu1: any, menu2: any): boolean;
+export declare function removeItemFromList(list: any, item: any): any[];
+export declare function searchMenu(menus: any, key: string): any;
+export declare function MenuContainer({ searchPlaceholder, allMenus, favouriteMenus, handleMenuAdd, handleMenuRemove, handleMenuClick, handleMenuDrag, handleCollectFailed, maxFavouriteCount, }: MenuContainerProps): React.ReactElement;
+export declare function getContainer(): HTMLElement;
+export declare function QuickVisitMenu(props: QuickVisitMenuProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,92 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+export interface QuickVisitMenuElementProps {
+    menu?: Record<string, any>;
+    buttonName?: string;
+    favouriteMenus?: {
+        text: string;
+        to?: string;
+        href?: string;
+    }[];
+    searchPlaceholder?: string;
+    maxFavouriteCount?: number;
+}
+/**
+ * @id basic-bricks.quick-visit-menu
+ * @author annzhang
+ * @history
+ * 1.x.0: 新增构件 `basic-bricks.quick-visit-menu`
+ * @docKind brick
+ * @deprecated
+ * @memo
+ * 该构件已迁移至 `nav-legacy` 包中维护，后续版本将不再维护该构件，请使用 `nav-legacy.menu-bar` 构件
+ * @noInheritDoc
+ */
+export declare class QuickVisitMenuElement extends UpdatingElement implements QuickVisitMenuElementProps {
+    /**
+     * @default
+     * @required true
+     * @description 菜单数据，可通过APP.getMenu(menuId)获取
+     */
+    menu: Record<string, any>;
+    /**
+     * @default
+     * @required true
+     * @description 按钮文本
+     */
+    buttonName: string;
+    /**
+     * @default false
+     * @required false
+     * @description 已添加到快捷访问中的菜单数组
+     */
+    favouriteMenus: {
+        text: string;
+        to?: string;
+        href?: string;
+    }[];
+    /**
+     * @default 输入关键词搜索
+     * @required false
+     * @description 搜索框placeholder
+     */
+    searchPlaceholder: string;
+    /**
+     * @detail 快捷访问全量菜单
+     * @description 拖拽快捷访问的菜单标签时发出的事件
+     */
+    /**
+     * @default
+     * @required false
+     * @description 支持收藏的最大数量
+     */
+    maxFavouriteCount: number;
+    menuDragEvent: EventEmitter<Record<string, any>>;
+    private _handleMenuDrag;
+    /**
+     * @detail 快捷访问全量菜单
+     * @description 移除快捷访问里的菜单时发出的事件
+     */
+    menuRemoveEvent: EventEmitter<Record<string, any>>;
+    private _handleMenuRemove;
+    /**
+     * @detail 快捷访问全量菜单
+     * @description 添加到快捷访问时发出的事件
+     */
+    menuAddEvent: EventEmitter<Record<string, any>>;
+    private _handleMenuAdd;
+    /**
+     * @detail 点击的菜单项，{text: 菜单标题，to/href: url}
+     * @description 点击菜单标签时发出的事件，一般配置为history.push
+     */
+    menuClickEvent: EventEmitter<Record<string, any>>;
+    private _handleMenuClick;
+    /**
+     * @detail
+     * @description 收藏超过最大数量时发出的事件
+     */
+    menuCollectFailedEvent: EventEmitter<Record<string, any>>;
+    private _handleCollectFailed;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/redirect-to/index.d.ts

@@ -0,0 +1,74 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface RedirectToElementProps {
+    href?: string;
+    href2?: string;
+    useHref2?: boolean;
+}
+/**
+ * @id basic-bricks.redirect-to
+ * @name basic-bricks.redirect-to
+ * @docKind brick
+ * @description 用于重定向的工具构件
+ * @author steve
+ * @slots
+ * @history
+ * 1.27.0:新增 href2 能力
+ * @memo
+ * ### DEMO
+ * ```json
+ * {
+ *   "brick": "basic-bricks.redirect-to",
+ *   "properties": {
+ *     "href": "" // 目标url
+ *   }
+ * }
+ * ```
+ * 如果没数据则跳转到指引页面
+ *
+ * ```json
+ * {
+ *   "brick": "basic-bricks.redirect-to",
+ *   "properties": {
+ *     "href": "${APP.homepage}/guide",
+ *     "href2": "${APP.homepage}/list"
+ *    },
+ *    "lifeCycle": {
+ *      "useResolves": [
+ *        {
+ *          "provider": "xxxxx",
+ *          "transform": {
+ *            "useHref2": "@{list.length}"
+ *          }
+ *        }
+ *      ]
+ *    }
+ * }
+ *```
+ * >Tips: 新增 href2 用来解决如下场景：如果有数据则跳转到列表页面，如果没数据则跳转到提示新建页面
+ * @noInheritDoc
+ */
+export declare class RedirectToElement extends UpdatingElement implements RedirectToElementProps {
+    /**
+     * @kind string
+     * @required true
+     * @default -
+     * @description 重定向的 url
+     */
+    href: string;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 重定向的 url2
+     */
+    href2: string;
+    /**
+     * @kind boolean
+     * @required true
+     * @default -
+     * @description 是否选用 href2 作为最终的跳转链接
+     */
+    useHref2: boolean;
+    connectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/resizable-box/ResizableBox.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+export interface ResizableBoxProps {
+    resizeDirection: ResizeDirection;
+    storageKey?: string;
+    defaultSize?: number;
+    minSize?: number;
+    minSpace?: number;
+    boxStyle?: React.CSSProperties;
+    boxStyleWhenNotResizing?: React.CSSProperties;
+    resizable?: boolean;
+    variant?: "dashboard" | "default";
+}
+export declare type ResizeDirection = "left" | "right" | "top" | "bottom";
+export declare function ResizableBox({ resizeDirection, storageKey, defaultSize, minSize, minSpace, boxStyle, boxStyleWhenNotResizing, resizable, variant, }: ResizableBoxProps): React.ReactElement;

package/dist/types/basic-bricks/src/resizable-box/index.d.ts

@@ -0,0 +1,38 @@
+import React from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+import { type ResizeDirection } from "./ResizableBox";
+export interface ResizableBoxElementProps {
+    boxStyle?: React.CSSProperties;
+    boxStyleWhenNotResizing?: React.CSSProperties;
+    variant?: "dashboard" | "default";
+    resizeDirection?: ResizeDirection;
+    storageKey?: string;
+    defaultSize?: number;
+    minSize?: number;
+    minSpace?: number;
+    resizable?: boolean;
+}
+/**
+ * @id basic-bricks.resizable-box
+ * @author steve
+ * @history
+ * 1.x.0: 新增构件 `basic-bricks.resizable-box`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class ResizableBoxElement extends UpdatingElement implements ResizableBoxElementProps {
+    resizeDirection: ResizeDirection;
+    storageKey: string;
+    defaultSize: number;
+    minSize: number;
+    resizable: boolean;
+    minSpace: number;
+    boxStyle: React.CSSProperties;
+    boxStyleWhenNotResizing: React.CSSProperties;
+    variant: "dashboard" | "default";
+    private _shadowRoot;
+    constructor();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

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

@@ -0,0 +1,91 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { GeneralTransform } from "@next-core/brick-types";
+export interface ScriptBrickElementProps {
+    data?: any;
+    transform?: GeneralTransform;
+    multiple?: boolean;
+    target?: string;
+}
+/**
+ * @id basic-bricks.script-brick
+ * @name basic-bricks.script-brick
+ * @docKind brick
+ * @description 可自定义函数来转换数据，并将处理后的数据给到其他构件
+ * @author alren
+ * @slots
+ * @history
+ * 1.x36.0:新增方法 `sendNotify` 和事件 `data.true` 和 `data.false`
+ * @memo
+ >`sendNotify`使用场景
+>
+> 在编排的时候，如果想要动态根据某个条件来决定是否做某个事情，可以：
+>
+> 1. 在事件或`useResolve`中通过`properties`给`script-brick`的`data`设定标记位，注意不能用`execute`，因为`execute`不改变内部的 data 变量
+> 2. 在`script-brick`根据所需绑定的`data.true`的事件或`data.false`事件
+> 3. 执行`sendNotify`，则会根据`data`发送`data.true`或`data.false`事件，从而执行不同的绑定行为
+ * @noInheritDoc
+ */
+export declare class ScriptBrickElement extends UpdatingElement implements ScriptBrickElementProps {
+    /**
+     * @kind any
+     * @required false
+     * @default -
+     * @description 可通过 useResolve 来更新 data 字段并执行，具体见第 2 个示例
+     */
+    data: any;
+    /**
+     * @kind string
+     * @required true
+     * @default -
+     * @description 自定义函数，入参为`data`，注意要`return`，如`return {'a': data.split('.')};"`
+     */
+    fun: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 目标构件是否为多个，target 有值时生效
+     */
+    multiple: boolean;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 目标构件，格式为`css selector`，如果不在这边填，也可以通过事件来给其他构件赋值
+     */
+    target: string;
+    /**
+     * @kind `GeneralTransform`
+     * @required false
+     * @default -
+     * @description 属性数据转换配置，请参考[Transform 数据转换](http://docs.developers.easyops.cn/docs/brick-next/transform)，当 target 有值时，可直接在此处做数据的转换，注意，如果`target`有值，`transform`也要填
+     */
+    transform: GeneralTransform;
+    /**
+     *
+     * @param data
+     * @description 透传给自定义函数的入参`data`，并发送`script.execute`事件，注意该函数不改变内部的 data 变量
+     */
+    execute(data?: any): Promise<void>;
+    /**
+     * @description 根据内部 data 的值决定发送`data.true`或`data.false`事件
+     */
+    sendNotify(): void;
+    /**
+     * @detail any
+     * @description 自定义函数`fun`返回的值
+     */
+    scriptExecute: EventEmitter;
+    /**
+     * @detail any
+     * @description 自定义函数`fun`返回的值
+     */
+    dataTrue: EventEmitter;
+    /**
+     * @detail any
+     * @description 自定义函数`fun`返回的值
+     */
+    dataFalse: EventEmitter;
+    connectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/shared/DeferredService.d.ts

@@ -0,0 +1,10 @@
+export declare class DeferredService {
+    private preFetchId;
+    private preFetchScheduled;
+    private firstFetchPromise;
+    private isFetching;
+    private readonly task;
+    constructor(task: () => Promise<unknown>);
+    schedulePrefetch(): void;
+    fetch(eager?: boolean): Promise<unknown>;
+}

package/dist/types/basic-bricks/src/sub-menu/SubMenu.d.ts

@@ -0,0 +1,11 @@
+import React from "react";
+import { SidebarMenu, UseBrickConf } from "@next-core/brick-types";
+interface SubMenuProps {
+    dataSource: SidebarMenu;
+    topOperationConf?: {
+        useBrick: UseBrickConf;
+    };
+    isThirdLevel?: boolean;
+}
+export declare function SubMenu({ dataSource, topOperationConf, isThirdLevel, }: SubMenuProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,49 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+import { SidebarMenu, UseBrickConf } from "@next-core/brick-types";
+export interface SubMenuElementProps {
+    dataSource?: SidebarMenu;
+    topOperationConf?: {
+        useBrick: UseBrickConf;
+    };
+    isThirdLevel?: boolean;
+}
+/**
+ * @id basic-bricks.sub-menu
+ * @name basic-bricks.sub-menu
+ * @editor shared-editors.general-menu--editor
+ * @docKind brick
+ * @description 二级菜单
+ * @author lynette
+ * @slots
+ * @history
+ * @memo
+ * > Tips: 通用子菜单构件，相关配置项同 Storyboard.routes.menu.sidebarMenu，暂时不支持 icon
+ * @noInheritDoc
+ */
+export declare class SubMenuElement extends UpdatingElement implements SubMenuElementProps {
+    /**
+     * @kind [SidebarMenu](http://developers.162.d.easyops.local/micro-app/storyboard-routes-menu-sidebarmenu.html)
+     * @required true
+     * @default -
+     * @description 数据源
+     */
+    dataSource: SidebarMenu;
+    /**
+     * @kind { useBrick: UseBrickConf }
+     * @required false
+     * @default -
+     * @description 菜单顶部操作按钮
+     */
+    topOperationConf: {
+        useBrick: UseBrickConf;
+    };
+    /**
+     * @default
+     * @required false
+     * @description 是否作为页面三级菜单出现，如果为true，菜单高度为100%
+     */
+    isThirdLevel: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}

package/dist/types/basic-bricks/src/sub-menu-filter/SubMenuFilter.d.ts

@@ -0,0 +1,38 @@
+import React from "react";
+import { UseBrickConf, MenuIcon } from "@next-core/brick-types";
+import { LocationDescriptor } from "history";
+export interface SubMenuFilterSimpleItem {
+    title: string;
+    key: string;
+    type?: "item";
+    icon: MenuIcon;
+    to?: LocationDescriptor;
+    style?: React.CSSProperties;
+}
+export interface SubMenuFilterGroup {
+    type: "group" | "subMenu";
+    title: string;
+    items: SubMenuFilterSimpleItem[];
+    key?: string;
+}
+export declare type SubMenuFilterItem = SubMenuFilterSimpleItem | SubMenuFilterGroup;
+export interface SubMenuFilterProps {
+    defaultSelectedKeys: string[];
+    defaultOpenKeys: string[];
+    selectable: boolean;
+    suffixBrick?: {
+        useBrick: UseBrickConf;
+    };
+    menuItems: SubMenuFilterItem[];
+    placeholder?: string;
+    unsearchable: boolean;
+    onSelect: (menuItem: SubMenuFilterItem[]) => void;
+    onClick: (menuItem: SubMenuFilterItem) => void;
+    onSearch: (query: string) => void;
+    multiple: boolean;
+    inlineIndent?: number;
+    transparentBackground?: boolean;
+    accordion?: boolean;
+    suffixBrickTriggerByHover?: boolean;
+}
+export declare function SubMenuFilter({ defaultSelectedKeys, defaultOpenKeys, selectable, suffixBrick, menuItems: rowMenuItem, placeholder, unsearchable, onSelect, onClick, onSearch, multiple, inlineIndent, transparentBackground, accordion, suffixBrickTriggerByHover, }: SubMenuFilterProps): React.ReactElement;