@next-bricks/basic-bricks 1.258.13 → 1.259.0

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

@@ -0,0 +1,191 @@
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { DrawerProps } from "antd/lib/drawer";
+export interface GeneralDrawerElementProps {
+    width?: number | string;
+    bodyStyle?: Record<string, any>;
+    drawerStyle?: Record<string, any>;
+    headerStyle?: Record<string, any>;
+    configProps?: DrawerProps;
+}
+export interface OpenCloseOption {
+    noEvent?: boolean;
+}
+/**
+ * 文字和图标只会显示其中一个，优先显示图标，文字最多显示4个字符。
+ */
+export interface ICustomSwitchConfig {
+    openText?: string;
+    openIcon?: any;
+    closeText?: string;
+    closeIcon?: any;
+    top?: string;
+}
+/**
+ * @id basic-bricks.general-drawer
+ * @name basic-bricks.general-drawer
+ * @docKind brick
+ * @description 提供插槽以展示其他构件
+ * @author ice
+ * @slots
+ * headerLeft:标题左侧插槽位，当设置 `customTitle` 属性时，该插槽无效
+ * headerRight:标题右侧插槽位，当使用该插槽时，应设置 `closable` 为 false
+ * content:内容插槽位
+ * footer:底部插槽位，仅当 `hasFooter` 为真时，该插槽才会存在
+ * @history
+ * 1.60.0:`open` 和 `close` 方法新增 `noEvent` 选项
+ * 1.34.0:新增插槽 `headerLeft`, `headerRight` 和 `footer`，新增 `general.drawer.open` 事件
+ * 1.30.0:新增 `bodyStyle` 和 `drawerStyle` 配置
+ * @memo
+ * ### OpenCloseOption
+
+* | property | type      | required | default | description |
+* | -------- | --------- | -------- | ------- | ----------- |
+* | noEvent  | `boolean` | -        | -       | 不触发事件  |
+ * @noInheritDoc
+ */
+export declare class GeneralDrawerElement extends UpdatingElement implements GeneralDrawerElementProps {
+    private _mountPoint;
+    private isVisible;
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 标题
+     * @group basic
+     */
+    customTitle: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 点击蒙层是否允许关闭
+     * @group basic
+     */
+    maskClosable: boolean;
+    /**
+     * @kind number
+     * @required false
+     * @default -
+     * @description 宽度
+     * @group basic
+     */
+    width: number | string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 是否显示右上角的关闭按钮
+     * @group basic
+     */
+    closable: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否提供 `footer` 插槽
+     * @group basic
+     */
+    hasFooter: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 是否显示loading效果
+     * @group ui
+     */
+    loading: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否展示遮罩
+     * @group ui
+     */
+    mask: boolean;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @description 可用于设置 Drawer 内容部分的样式
+     * @group ui
+     */
+    bodyStyle: Record<string, any>;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @description 用于设置 Drawer 弹出层的样式
+     * @group ui
+     */
+    drawerStyle: Record<string, any>;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @description 用于设置 Drawer 头部的样式
+     * @group ui
+     */
+    headerStyle: Record<string, any>;
+    /**
+     * @default false
+     * @required false
+     * @description 是否浮层样式，如果设为true,则抽屉边缘会有外边距，圆角和阴影
+     * @group ui
+     */
+    isFloat: boolean;
+    /**
+     * @kind object
+     * @required false
+     * @default -
+     * @description 完全透传给 antd 的 Drawer 属性，详见：[https://ant.design/components/drawer-cn/#API](https://ant.design/components/drawer-cn/#API)
+     * @group other
+     */
+    configProps: DrawerProps;
+    hasOuterSwitch: boolean;
+    useBigOuterSwitch: boolean;
+    customSwitchConfig: ICustomSwitchConfig;
+    /**
+     * @kind boolean
+     * @required false
+     * @default -
+     * @description 打开抽屉时内容区是否自动滚动到顶部
+     * @group other
+     */
+    scrollToTopWhenOpen: boolean;
+    /**
+     * @description 是否可堆叠，开启后每次打开抽屉会将新的抽屉置于上层（zIndex ++）。注意：仅初始设置有效。
+     */
+    stackable: boolean;
+    private _stack;
+    constructor();
+    connectedCallback(): void;
+    listenOnClose(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+    /**
+     *
+     * @detail
+     * @description 构件打开时所发出的事件, 事件数据为空
+     */
+    drawerOpen: EventEmitter<Record<string, any>>;
+    /**
+     *
+     * @description 显示抽屉构件
+     */
+    open(option?: OpenCloseOption): void;
+    /**
+     * @description 抽屉内部内容上下滚动
+     */
+    bodyScroll(top: number): void;
+    /**
+     *
+     * @detail
+     * @description 构件关闭时所发出的事件, 事件数据为空
+     */
+    drawerClose: EventEmitter<Record<string, any>>;
+    /**
+     *
+     * @description 显示抽屉构件
+     */
+    close(option?: OpenCloseOption): void;
+}

package/dist/types/basic-bricks/src/general-heading/GeneralHeading.d.ts

@@ -0,0 +1,9 @@
+import React, { CSSProperties } from "react";
+declare type headType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+interface GeneralHeaderProps {
+    text: string;
+    type?: headType;
+    customStyle?: CSSProperties;
+}
+export declare function GeneralHeading(props: GeneralHeaderProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,43 @@
+import { CSSProperties } from "react";
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface GeneralHeadingElementProps {
+    text?: string;
+    type?: headType;
+    customStyle?: CSSProperties;
+}
+declare type headType = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+/**
+ * @id basic-bricks.general-heading
+ * @author MJmajiong
+ * @history
+ * 1.x.0: 新增构件 `basic-bricks.general-heading`
+ * @docKind brick
+ * @noInheritDoc
+ */
+export declare class GeneralHeadingElement extends UpdatingElement implements GeneralHeadingElementProps {
+    /**
+     * @default ''
+     * @required true
+     * @description 字体文本
+     * @group basic
+     */
+    text: string;
+    /**
+     * @default h1
+     * @required true
+     * @description 标题类型 h1-h6
+     * @group basic
+     */
+    type: headType;
+    /**
+     * @default 使用自定义样式,将会覆盖默认样式
+     * @required false
+     * @description 自定义样式
+     * @group ui
+     */
+    customStyle: CSSProperties;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}
+export {};

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

@@ -0,0 +1,57 @@
+import { UpdatingElement } from "@next-core/brick-kit";
+export interface GeneralHotkeysElementProps {
+    hotkeysConfig?: HotkeysConfig[];
+    disabled?: boolean;
+}
+interface HotkeysConfig {
+    key: string;
+    eventName: string;
+}
+/**
+* @id basic-bricks.general-hotkeys
+* @name basic-bricks.general-hotkeys
+* @docKind brick
+* @description 可配置通用快捷键以及相关事件名
+* @author lynette
+* @slots
+* @history
+* 1.66.0:新增构件 `basic-bricks.general-hotkeys`
+* @memo
+* ### Supported Keys
+
+*  HotKeys 构件可以识别以下修饰符，方便配置：`⇧`, `shift`, `option`, `⌥`, `alt`, `ctrl`, `control`, `command`和 `⌘`.
+
+*  以下特殊键可用于配置快捷键：`backspace`, `tab`, `clear`, `enter`, `return`, `esc`, `escape`, `space`, `up`, `down`, `left`, `right`, `home`, `end`, `pageup`, `pagedown`, `del`, `delete` , `f1` 到 `f19`.
+
+*  其中：
+
+*  - `⌘` Command()
+*  - `⌃` Control
+*  - `⌥` Option(alt)
+*  - `⇧` Shift
+*  - `⇪` Caps Lock(Capital)
+*  - `↩︎` return/Enter space
+* @noInheritDoc
+*/
+export declare class GeneralHotkeysElement extends UpdatingElement implements GeneralHotkeysElementProps {
+    /**
+     * @kind {key: string,eventName: string}[]
+     * @required false
+     * @default -
+     * @description 快捷键配置，支持的 keys 列表如下
+     * @group basic
+     */
+    hotkeysConfig: HotkeysConfig[];
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @group basic
+     * @description 是否禁用
+     */
+    disabled: boolean;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected _render(): void;
+}
+export {};

package/dist/types/basic-bricks/src/general-modal/GeneralModal.d.ts

@@ -0,0 +1,33 @@
+import React from "react";
+import { ModalProps } from "antd/lib/modal";
+import { MenuIcon } from "@next-core/brick-types";
+import type { ModalStack } from "@next-core/brick-kit";
+export declare type positionType = "left" | "center" | "right";
+declare type SrcIcon = {
+    imgSrc?: string;
+    imgStyle?: React.CSSProperties;
+};
+interface GeneralModalProps {
+    visible: boolean;
+    configProps?: ModalProps;
+    modalTitle: string;
+    hideCancelButton?: boolean;
+    enableFooterSlot?: boolean;
+    titleAlign?: string;
+    titleIcon?: MenuIcon | SrcIcon;
+    fullscreen?: boolean;
+    okDisabled?: boolean;
+    confirmLoading?: boolean;
+    footerPosition?: positionType;
+    isHiddenBodyPadding?: boolean;
+    isHiddenHeaderBorder?: boolean;
+    isHiddenFooterColor?: boolean;
+    isHiddenModalTitle?: boolean;
+    isHiddenModalFooter?: boolean;
+    isShowCustomHeader?: boolean;
+    stack: ModalStack;
+    stackable?: boolean;
+    onAfterClose?: () => void;
+}
+export declare function GeneralModal(props: GeneralModalProps): React.ReactElement;
+export {};

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

@@ -0,0 +1,330 @@
+import { ModalProps } from "antd/lib/modal";
+import { UpdatingElement, EventEmitter } from "@next-core/brick-kit";
+import { positionType } from "./GeneralModal";
+import { MenuIcon } from "@next-core/brick-types";
+import { ButtonType } from "antd/lib/button";
+export interface GeneralModalElementProps {
+    modalTitle?: string;
+    titleIcon?: MenuIcon;
+    titleAlign?: string;
+    dataSource?: Record<string, any>;
+    width?: string | number;
+    configProps?: ModalProps;
+    fields?: {
+        modalTitle: string;
+    };
+    enableFooterSlot?: boolean;
+    footerPosition?: positionType;
+    isHiddenBodyPadding?: boolean;
+    isHiddenHeaderBorder?: boolean;
+    isHiddenModalTitle?: boolean;
+    isHiddenModalFooter?: boolean;
+    isShowCustomHeader?: boolean;
+    stackable?: boolean;
+    okText?: string;
+    okType?: ButtonType;
+    okDisabled?: boolean;
+    confirmLoading?: boolean;
+    cancelText?: string;
+    hideCancelButton?: boolean;
+    closeWhenOk?: boolean;
+    closeWhenCancel?: boolean;
+    maskClosable?: boolean;
+    fullscreen?: boolean;
+}
+export interface OpenCloseOption {
+    noEvent?: boolean;
+}
+/**
+ * @id basic-bricks.general-modal
+ * @name basic-bricks.general-modal
+ * @docKind brick
+ * @description 提供插槽以展示其他构件，注意与表单通用模态框 (forms.general-modal) 的不同
+ * @groupI18N
+ * {
+ *    "buttonAndInteract": {"en": "Button/Interact", "zh": "按钮及交互"}
+ * }
+ * @author ice
+ * @slots
+ * content:模态框里面的内容
+ * headerExtra:模态框头部标题后面的内容
+ * @history
+ * 1.26.0:新增 `modal.close` 事件
+ * 1.34.0:新增 `width` 属性
+ * 1.37.0:新增 `okText`, `cancelText` 属性, 新增 `modal.open` 事件
+ * 1.53.0:新增 `hideCancelButton` 属性
+ * 1.60.0:`open` 和 `close` 方法新增 `noEvent` 选项
+ * 1.61.0:新增 `enableFooterSlot` 属性
+ * 1.88.0:新增 `titleAlign` 和 `titleIcon` 属性
+ * @memo
+ * ### OpenCloseOption
+
+* | property | type      | required | default | description |
+* | -------- | --------- | -------- | ------- | ----------- |
+* | noEvent  | `boolean` | -        | -       | 不触发事件  |
+ * @noInheritDoc
+ */
+export declare class GeneralModalElement extends UpdatingElement implements GeneralModalElementProps {
+    /**
+     * @kind string
+     * @required false
+     * @default -
+     * @description 模态框标题
+     * @group basic
+     */
+    modalTitle: string;
+    /**
+     * @kind MenuIcon
+     * @required false
+     * @default -
+     * @description 标题图标
+     * @group basic
+     */
+    titleIcon?: MenuIcon;
+    /**
+     * @required false
+     * @default -
+     * @description 标题对齐方式
+     * @group basic
+     */
+    titleAlign?: string;
+    /**
+     * @kind Record<string, any>
+     * @required false
+     * @default -
+     * @description 数据来源
+     * @group basic
+     */
+    dataSource: Record<string, any>;
+    /**
+     * @kind string | number
+     * @required false
+     * @default -
+     * @description 模态框宽度
+     * @group ui
+     */
+    width: string | number;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否启用 footer 插槽
+     * @group ui
+     */
+    enableFooterSlot: boolean;
+    /**
+     * @kind string
+     * @required false
+     * @default right
+     * @description 按钮的位置 left | center | right
+     * @group ui
+     */
+    footerPosition: positionType;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否需要隐藏弹窗内容的padding
+     * @group ui
+     */
+    isHiddenBodyPadding: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否需要隐藏弹窗头部的分割线
+     * @group ui
+     */
+    isHiddenHeaderBorder: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否需要隐藏弹窗的title
+     * @group ui
+     */
+    isHiddenModalTitle: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否需要隐藏弹窗的footer
+     * @group ui
+     */
+    isHiddenModalFooter: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否需要显示自定义顶部header
+     * @group ui
+     */
+    isShowCustomHeader: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否需要隐藏底部特殊的颜色
+     * @group ui
+     */
+    isHiddenFooterColor: boolean;
+    /**
+     * @default false
+     * @description 全屏模式
+     * @group ui
+     */
+    fullscreen?: boolean;
+    /**
+     * @kind string
+     * @required false
+     * @default 确认
+     * @description 确认按钮文字
+     * @group buttonAndInteract
+     */
+    okText: string;
+    /**
+     * @kind ButtonType
+     * @required false
+     * @default primary
+     * @description 模态框确认按钮类型 ButtonType("link" | "default" | "primary" | "ghost" | "dashed" | "danger")
+     * @group buttonAndInteract
+     */
+    okType: ButtonType;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否禁用确认按钮
+     * @group buttonAndInteract
+     */
+    okDisabled: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 点击确定时，是否立即关闭模态框，如果设为`false`，则需要自行关闭。
+     * @group basic
+     */
+    closeWhenOk: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 确定按钮 loading
+     * @group buttonAndInteract
+     */
+    confirmLoading: boolean;
+    /**
+     * @kind string
+     * @required false
+     * @default 取消
+     * @description 取消按钮文字
+     * @group buttonAndInteract
+     */
+    cancelText: string;
+    /**
+     * @kind boolean
+     * @required false
+     * @default false
+     * @description 是否隐藏取消按钮
+     * @group buttonAndInteract
+     */
+    hideCancelButton: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 点击取消时，是否立即关闭模态框，如果设为`false`，则需要自行关闭。
+     * @group buttonAndInteract
+     */
+    closeWhenCancel: boolean;
+    /**
+     * @kind boolean
+     * @required false
+     * @default true
+     * @description 是否点击背景关闭模态框
+     * @group buttonAndInteract
+     */
+    maskClosable: boolean;
+    /**
+     * @kind object
+     * @required false
+     * @default -
+     * @description 完全透传给 antd 的 Modal 属性，详见 [文档](https://ant.design/components/modal-cn#API)
+     * @group other
+     */
+    configProps: ModalProps;
+    /**
+     * @kind {modalTitle: string}
+     * @deprecated true
+     * @required false
+     * @default -
+     * @description `已废弃` 字段映射, 跟 dataSource 一起使用来获得运行时 modalTitle
+     * @group other
+     */
+    fields: {
+        modalTitle: string;
+    };
+    /**
+     * @description 是否可堆叠，开启后每次打开抽屉会将新的抽屉置于上层（zIndex ++）。注意：仅初始设置有效。
+     */
+    stackable: boolean;
+    private _stack;
+    private _mountPoint;
+    private isVisible;
+    private modalProps;
+    constructor();
+    connectedCallback(): void;
+    handleAfterClose: () => void;
+    listenOnClose(): void;
+    disconnectedCallback(): void;
+    private initData;
+    protected _render(): void;
+    /**
+     *
+     * @description 弹出模态框
+     */
+    open(option?: OpenCloseOption): void;
+    /**
+     * @params option?: OpenCloseOption
+     * @description 打开 modal 时发出该事件
+     */
+    openModal: EventEmitter<Record<string, any>>;
+    /**
+     * @params `option?: OpenCloseOption`
+     * @description 关闭模态框
+     */
+    close(option?: OpenCloseOption): void;
+    /**
+     * @detail -
+     * @description 关闭 modal 时发出该事件
+     */
+    closeModal: EventEmitter<Record<string, any>>;
+    /**
+     * @detail -
+     * @description 当 modal 完全关闭后发出该事件
+     */
+    afterCloseModel: EventEmitter;
+    /**
+     * @detail `Record<string, any>`
+     * @deprecated 请使用`modal.cancel`代替
+     * @description 当点击 modal 自带的取消按钮时发出该事件，detail来源为当前的dataSource属性值
+     */
+    generalModalCancel: EventEmitter<Record<string, any>>;
+    /**
+     * @detail `Record<string, any>`
+     * @description 当点击 modal 自带的取消按钮时发出该事件，detail来源为当前的dataSource属性值
+     */
+    modalCancel: EventEmitter;
+    /**
+     * @detail `Record<string, any>`
+     * @deprecated 请使用`modal.confirm`代替
+     * @description 当点击 modal 自带的确认按钮时发出该事件，detail来源为当前的dataSource属性值
+     */
+    generalModalConfirm: EventEmitter;
+    /**
+     * @detail `Record<string, any>`
+     * @description 当点击 modal 自带的确认按钮时发出该事件，detail来源为当前的dataSource属性值
+     */
+    modalConfirm: EventEmitter;
+}