@unicom-cloud/ui 0.8.83 → 0.8.84

package/types/pc/modal/interface.d.ts

@@ -0,0 +1,186 @@
+import { CSSProperties, ReactNode } from 'react';
+import { ButtonProps } from '../button';
+import { ConfirmProps } from './Confirm';
+/**
+ * @title Modal
+ */
+export interface ModalProps {
+    style?: CSSProperties;
+    className?: string | string[];
+    /**
+     * @zh 关闭弹出框的回调
+     * @en Callback when click cancel button
+     */
+    onCancel?: () => void;
+    /**
+     * @zh 点击确认按钮的回调
+     * @en Callback when click ok button
+     */
+    onOk?: (e?: MouseEvent) => Promise<any> | void;
+    onConfirm?: (e?: MouseEvent) => Promise<any> | void;
+    /**
+     * @zh 指定弹出框挂载的父节点
+     * @en Specify the parent node of the Modal
+     * @defaultValue () => document.body
+     */
+    getPopupContainer?: () => Element;
+    /**
+     * @zh 对话框里的弹出框 `Select` `Tooltip` 等挂载的容器，默认挂载在对话框内。
+     * @en The Popup in Modal. Such as `Select` and `Tooltip` are mounted in the Modal
+     */
+    getChildrenPopupContainer?: (node: HTMLElement) => Element;
+    /**
+     * @zh 弹出框的标题
+     * @en The title of Modal
+     */
+    title?: string | ReactNode;
+    subtitle?: string | ReactNode;
+    /**
+     * @zh 弹出框是否可见
+     * @en Whether the Modal is visible
+     */
+    visible?: boolean;
+    /**
+     * @zh 是否显示遮罩
+     * @en Whether show mask
+     * @defaultValue true
+     */
+    mask?: boolean;
+    /**
+     * @zh
+     * 简洁模式的样式，没有分割线，底部按钮居中显示。默认通过方法调用的提示类型的弹窗会展示`simple`样式。设置为true时，默认不显示右上角关闭图标
+     * @en
+     * Simple Mode, no dividing line, the bottom button is displayed in the center.
+     * The Alter Modal called by the default method will use `simple` mode. When set to true, the close icon is not display
+     */
+    simple?: boolean;
+    /**
+     * @zh 确认按钮文案
+     * @en The text of `ok` button
+     */
+    okText?: ReactNode;
+    /**
+     * @zh 取消按钮文案
+     * @en The text of `cancel` button
+     */
+    cancelText?: ReactNode;
+    /**
+     * @zh 确认按钮的 props
+     * @en The props of `ok` button
+     */
+    okButtonProps?: ButtonProps;
+    /**
+     * @zh 取消按钮的 props
+     * @en The props of `cancel` button
+     */
+    cancelButtonProps?: ButtonProps;
+    /**
+     * @zh 自定义页脚，传入 null 则不显示
+     * @en Custom `footer`. if it is null, the footer will not be displayed.
+     * @version 2.12.0
+     */
+    footer?: ReactNode | ((cancelButtonNode: ReactNode, okButtonNode: ReactNode) => ReactNode);
+    /**
+     * @zh 是否显示右上角的关闭按钮
+     * @en Whether to show the close button in TitleBar
+     */
+    closable?: boolean;
+    /**
+     * @zh 自定义右上角的关闭按钮节点
+     * @en Customize the close icon
+     * @version 2.21.0
+     */
+    closeIcon?: ReactNode;
+    /**
+     * @zh 点击蒙层是否可以关闭
+     * @en Whether enable click mask to close Modal.
+     * @defaultValue true
+     */
+    maskClosable?: boolean;
+    /**
+     * @zh 蒙层的样式
+     * @en The style of mask
+     * @version 2.6.0
+     */
+    maskStyle?: CSSProperties;
+    /**
+     * @zh 弹框打开之后的回调
+     * @en Callback when Modal opened
+     */
+    afterOpen?: () => void;
+    /**
+     * @zh 弹框关闭之后的回调
+     * @en Callback when Modal closed
+     */
+    afterClose?: () => void;
+    /**
+     * @zh 确认按钮加载中
+     * @en Whether the `ok` button is loading
+     */
+    confirmLoading?: boolean;
+    /**
+     * @zh 是否在初次打开对话框时才渲染 dom
+     * @en Whether to render DOM when first opened
+     * @defaultValue true
+     */
+    mountOnEnter?: boolean;
+    /**
+     * @zh 是否在隐藏之后销毁DOM结构
+     * @en Whether to destroy DOM after closed
+     */
+    unmountOnExit?: boolean;
+    /**
+     * @zh 按 `ESC` 键关闭
+     * @en Whether enable press `ESC` to close Modal
+     * @defaultValue true
+     */
+    escToExit?: boolean;
+    /**
+     * @zh 弹出框垂直水平居中
+     * @en Modal is centered vertically and horizontally
+     * @defaultValue true
+     */
+    alignCenter?: boolean;
+    /**
+     * @zh 弹出框外层 dom 类名
+     * @en The class of the wrapped dom
+     */
+    wrapClassName?: string | string[];
+    /**
+     * @zh 弹出框外层样式
+     * @en The style of the wrapped dom
+     * @version 2.16.0
+     */
+    wrapStyle?: CSSProperties;
+    hideCancel?: boolean;
+    /**
+     * @zh 自定义渲染对话框
+     * @en Custom the render of Modal
+     * @version 2.2.0
+     */
+    modalRender?: (modalNode: ReactNode) => ReactNode;
+    prefixCls?: string;
+    /**
+     * @zh 是否开启全屏
+     * @en Whether to enable fullscreenable
+     */
+    fullscreenable?: boolean;
+    draggable?: boolean;
+}
+export type ModalReturnProps = {
+    update: Function;
+    close: Function;
+};
+type modalHookFunction = (config: ConfirmProps) => {
+    close: () => void;
+    update: (config: ConfirmProps) => void;
+};
+export type ModalHookReturnType = {
+    show?: modalHookFunction;
+    confirm?: modalHookFunction;
+    info?: modalHookFunction;
+    success?: modalHookFunction;
+    warning?: modalHookFunction;
+    error?: modalHookFunction;
+};
+export {};

package/types/pc/notification/interface.d.ts

@@ -0,0 +1,78 @@
+import { CSSProperties, ReactInstance, ReactNode } from 'react';
+/**
+ * @title Notification
+ */
+export interface NotificationProps {
+    style?: CSSProperties;
+    className?: string | string;
+    /**
+     * @zh 通知标题
+     * @en Notification title
+     */
+    title?: ReactNode | string;
+    /**
+     * @zh 通知内容
+     * @en Notification content
+     */
+    content: ReactNode | string;
+    /**
+     * @zh 是否显示图标
+     * @en Whether to show the icon
+     * @defaultValue true
+     */
+    showIcon?: boolean;
+    /**
+     * @zh 自定义图标
+     * @en Custom icon
+     */
+    icon?: ReactNode;
+    /**
+     * @zh 自动关闭的时间，单位为 `ms`
+     * @en Automatic shutdown time, the unit is `ms`
+     * @defaultValue 3000
+     */
+    duration?: number;
+    /**
+     * @zh 关闭时的回调
+     * @en Callback when close
+     */
+    onClose?: () => void;
+    /**
+     * @zh 当前通知的唯一标识，可以用来更新消息
+     * @en The unique identifier of the current notification, which can be used to update the message
+     */
+    id?: string;
+    /**
+     * @zh 消息的位置，分为 `topLeft` 左上方、`topRight` 右上方、`bottomLeft` 左下方和 `bottomRight` 右下方
+     * @en The position of the message
+     */
+    position?: 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
+    /**
+     * @zh 添加操作按钮
+     * @en Add action button
+     */
+    btn?: ReactNode;
+    /**
+     * @zh 是否显示关闭按钮
+     * @en Whether to show the close button
+     * @defaultValue true
+     */
+    closable?: boolean;
+    /**
+     * @zh 自定义右上角关闭按钮
+     * @en Custom the close button on top-right of the drawer dialog
+     * @version 2.50.0
+     */
+    closeIcon?: ReactNode;
+    type?: string;
+}
+type notificationHookFunction = (config: NotificationProps) => ReactInstance;
+export type NotificationHookReturnType = {
+    info?: notificationHookFunction;
+    success?: notificationHookFunction;
+    warning?: notificationHookFunction;
+    error?: notificationHookFunction;
+    loading?: notificationHookFunction;
+    normal?: notificationHookFunction;
+};
+export {};

package/types/pc/page-header/interface.d.ts

@@ -0,0 +1,49 @@
+import { CSSProperties, ReactNode } from 'react';
+import { BreadcrumbProps } from '../breadcrumb';
+/**
+ * @title PageHeader
+ */
+export interface PageHeaderProps {
+    className?: string | string[];
+    style?: CSSProperties;
+    /**
+     * @zh 扩展头部内容
+     * @en The header element
+     */
+    header?: ReactNode;
+    /**
+     * @zh 主标题
+     * @en The title element
+     */
+    title?: ReactNode;
+    /**
+     * @zh 次级标题
+     * @en The subtitle element
+     */
+    subTitle?: ReactNode;
+    /**
+     * @zh 面包屑，接受面包屑的所有属性, [BreadcrumbProps](/react/component/breadcrumb)
+     * @en The props of [Breadcrumb](/react/component/breadcrumb) component
+     */
+    breadcrumb?: BreadcrumbProps;
+    /**
+     * @zh 返回图标，设置为 `false` 时会隐藏图标
+     * @en Customize back icon, if false The back icon will not be displayed
+     */
+    backIcon?: ReactNode | boolean;
+    /**
+     * @zh 展示额外内容
+     * @en Customize the extra content. The extra element will be rendered to the end of the title line
+     */
+    extra?: ReactNode;
+    /**
+     * @zh 底部内容
+     * @en The footer element
+     */
+    footer?: ReactNode;
+    /**
+     * @zh 点击返回图标的回调
+     * @en Callback when click the back icon
+     */
+    onBack?: (e: MouseEvent) => void;
+}

package/types/{pagination → pc/pagination}/PageItem.d.ts

@@ -45,8 +45,19 @@ export interface StepPagerProps {
     };
     itemRender?: itemRenderType;
 }
+/**
+ * default pager item
+ */
 declare function Pager(props: PagerProps): import("react/jsx-dev-runtime").JSX.Element;
+/**
+ * preJump or nextJump button
+ * @param props
+ */
 export declare const JumpPager: (props: JumpPagerProps) => import("react/jsx-dev-runtime").JSX.Element;
+/**
+ * previous or next button
+ * @param props
+ */
 export declare const StepPager: (props: StepPagerProps) => import("react/jsx-dev-runtime").JSX.Element;
 declare const _default: React.MemoExoticComponent<typeof Pager>;
 export default _default;

package/types/pc/pagination/interface.d.ts

@@ -0,0 +1,134 @@
+import { CSSProperties, ReactNode } from 'react';
+import { SelectProps } from '../select/interface';
+/**
+ * @title Pagination
+ */
+export interface PaginationProps {
+    style?: CSSProperties;
+    className?: string | string[];
+    /**
+     * @zh 分页按钮样式
+     * @en Pagination button style
+     */
+    pageItemStyle?: CSSProperties;
+    /**
+     * @zh 被选中的分页按钮样式
+     * @en The style of the selected page button
+     */
+    activePageItemStyle?: CSSProperties;
+    /**
+     * @zh 当前页
+     * @en Current page
+     */
+    current?: number;
+    /**
+     * @zh 每页数据条数
+     * @en Number of data items per page
+     */
+    pageSize?: number;
+    /**
+     * @zh 数据总数
+     * @en Total number of data
+     */
+    total?: number;
+    /**
+     * @zh 当前页默认值
+     * @en To set default current page
+     */
+    defaultCurrent?: number;
+    /**
+     * @zh 默认每页数据条数
+     * @en To set default number of data per page
+     */
+    defaultPageSize?: number;
+    /**
+     * @zh 是否禁用
+     * @en Whether to disable
+     */
+    disabled?: boolean;
+    /**
+     * @zh 是否在只有一页的情况下隐藏
+     * @en Whether to hide when there is only one page
+     * @version 2.6.0
+     */
+    hideOnSinglePage?: boolean;
+    /**
+     * @zh 定制分页按钮的结构
+     * @en Customized pagination button structure
+     */
+    itemRender?: (page: number, type: 'page' | 'more' | 'prev' | 'next', originElement: ReactNode) => ReactNode;
+    /**
+     * @zh 分页器尺寸
+     * @en pager size
+     */
+    size?: 'mini' | 'small' | 'default' | 'large';
+    /**
+     * @zh 是否显示数据总数
+     * @en Whether to display the total number of data
+     */
+    showTotal?: boolean | ((total: number, range: number[]) => ReactNode);
+    /**
+     * @zh 是否可以改变每页条数
+     * @en Is it possible to change page size
+     */
+    sizeCanChange?: boolean;
+    /**
+     * @zh 每页可以显示数据条数
+     * @en The number of data items that can be displayed per page
+     */
+    sizeOptions?: number[];
+    /**
+     * @zh `current` 页与 `...` 之间的页码个数
+     * @en the number of pages between the `current` page and `...`
+     * @defaultValue 2
+     * @version 2.32.0
+     */
+    bufferSize?: number;
+    /**
+     * @zh 变化时的回调
+     * @en Callback when page changes
+     */
+    onChange?: (pageNumber: number, pageSize: number) => void;
+    /**
+     * @zh pageSize 变化时的回调
+     * @en Callback when pageSize changes
+     */
+    onPageSizeChange?: (size: number, current: number) => void;
+    /**
+     * @zh `pageSize` 改变的时候重置当前页码为 `1`
+     * @en When pageSize changes, resets the current page number to `1`
+     * @defaultValue true
+     */
+    pageSizeChangeResetCurrent?: boolean;
+    /**
+     * @zh 是否应用精简分页模式
+     * @en Whether to use simplified pagination mode
+     */
+    simple?: boolean;
+    /**
+     * @zh 是否显示快速跳转到某页，在 `simple` 模式下默认为 true
+     * @en Whether to display quick jump. Defaults to true in `simple` mode
+     */
+    showJumper?: boolean;
+    /**
+     * @zh 是否显示更多页码提示（当尚无法计算数据总数时可以使用）
+     * @en Whether to show more page number tips (can be used when the total number of data cannot be calculated yet)
+     */
+    showMore?: boolean;
+    /**
+     * @zh 用于配置弹出框的属性
+     * @en Props of the `Select`
+     */
+    selectProps?: Partial<SelectProps>;
+    /**
+     * @zh 设置分页器的图标
+     * @en Set icon of the pager
+     */
+    icons?: {
+        prev?: ReactNode;
+        next?: ReactNode;
+        more?: ReactNode;
+    };
+    mini?: boolean;
+    pageOption?: boolean | ReactNode;
+}

package/types/pc/popconfirm/interface.d.ts

@@ -0,0 +1,114 @@
+import React, { CSSProperties, ReactNode } from 'react';
+import { ButtonProps } from '../button';
+import { TriggerProps } from '../trigger';
+/**
+ * @title Popconfirm
+ */
+export interface PopconfirmProps {
+    style?: CSSProperties;
+    className?: string | string[];
+    /**
+     * @zh 弹出挂载的节点
+     * @en The parent node which the confirmation box will be rendered to.
+     */
+    getPopupContainer?: (node: HTMLElement) => Element;
+    /**
+     * @zh 弹出框的方位，有 12 个方位可供选择
+     * @en The position of the confirmation box relative to the target.
+     * @defaultValue top
+     */
+    position?: 'top' | 'tl' | 'tr' | 'bottom' | 'bl' | 'br' | 'left' | 'lt' | 'lb' | 'right' | 'rt' | 'rb';
+    /**
+     * @zh 标题。 函数类型在 `2.48.0` 支持
+     * @en Title of Popconfirm. Function types are supported in `2.48.0`
+     */
+    title?: ReactNode | (() => ReactNode);
+    /**
+     * @zh 内容.函数类型在 `2.48.0` 支持
+     * @en Content of Popconfirm   Function types are supported in `2.48.0`
+     * @version 2.44.0
+     */
+    content?: ReactNode | (() => ReactNode);
+    /**
+     * @zh 是否禁用
+     * @en whether to disabled
+     * @version 2.11.0
+     */
+    disabled?: boolean;
+    /**
+     * @zh 取消按钮文字
+     * @en The text of the cancel button
+     */
+    cancelText?: ReactNode;
+    /**
+     * @zh 确认按钮文字
+     * @en The text of the ok button
+     */
+    okText?: ReactNode;
+    /**
+     * @zh 确认按钮的类型
+     * @en The type of the ok button
+     * @defaultValue primary
+     */
+    okType?: ButtonProps['type'];
+    /**
+     * @zh 确定按钮的参数，可接受 `Button` 组件的所有参数
+     * @en The props of the ok button
+     */
+    okButtonProps?: ButtonProps;
+    /**
+     * @zh 取消按钮的参数，可接受 `Button` 组件的所有参数
+     * @en The props of the cancel button
+     */
+    cancelButtonProps?: ButtonProps;
+    /**
+     * @zh 点击确认按钮的回调函数。回调函数 `event` 参数在 `2.29.0` 支持
+     * @en Callback when click the ok button. Callback `event` params is supported in `2.29.0`
+     */
+    onOk?: (e: React.MouseEvent) => Promise<any> | void;
+    /**
+     * @zh 点击取消按钮的回调函数。 回调函数 `event` 参数在 `2.29.0` 支持
+     * @en Callback when click the cancel button. Callback `event` params is supported in `2.29.0`
+     */
+    onCancel?: (e: React.MouseEvent) => void;
+    /**
+     * @zh 默认弹出框是打开还是关闭
+     * @en Whether the confirmation box is visible by default
+     */
+    defaultPopupVisible?: boolean;
+    /**
+     * @zh 弹出框是打开还是关闭。(受控)
+     * @en Whether the confirmation box is visible
+     */
+    popupVisible?: boolean;
+    /**
+     * @zh 弹出打开和关闭触发的回调
+     * @en Callback when the visibility of the confirmation box is changed
+     */
+    onVisibleChange?: (visible: boolean) => void;
+    /**
+     * @zh 标题前的图标
+     * @en Customize icon of the confirmation box
+     * @defaultValue <IconUiExclamationCircleFill />
+     */
+    icon?: ReactNode;
+    blurToHide?: boolean;
+    /**
+     * @zh 是否在隐藏的时候销毁 DOM 节点
+     * @en Whether to destroy the confirmation box when hidden
+     * @defaultValue true
+     */
+    unmountOnExit?: boolean;
+    /**
+     * @zh 触发方式
+     * @en Trigger mode
+     * @defaultValue click
+     */
+    trigger?: TriggerProps['trigger'];
+    escToClose?: TriggerProps['escToClose'];
+    /**
+     * @zh 可以接受所有 Trigger 的参数
+     * @en The Props of the `Trigger` component
+     */
+    triggerProps?: Partial<TriggerProps>;
+}

package/types/{popover → pc/popover}/interface.d.ts

@@ -1,8 +1,20 @@
 import { CSSProperties, ReactNode } from 'react';
 import type { TooltipProps } from '../tooltip';
+/**
+ * @title Popover
+ */
 export interface PopoverProps extends Omit<TooltipProps, 'mini'> {
     style?: CSSProperties;
     className?: string | string[];
+    /**
+     * @zh 标题
+     * @en Title of the popup card
+     */
     title?: ReactNode;
+    /**
+     * @zh 是否禁用
+     * @en Whether to disabled
+     * @version 2.11.0
+     */
     disabled?: boolean;
 }

package/types/{portal → pc/portal}/Portal.d.ts

@@ -1,5 +1,6 @@
 import React, { ReactNode } from 'react';
 export interface PortalProps {
+    /** Portal 挂载的容器 */
     getContainer?: () => Element;
     children?: ReactNode;
 }

package/types/{portal → pc/portal}/index.d.ts

@@ -1,5 +1,6 @@
 import React, { ReactNode } from 'react';
 export interface PortalWrapperProps {
+    /** Portal 挂载的容器 */
     getContainer?: () => Element;
     childrenComponent?: Element;
     forceRender?: boolean;