@unicom-cloud/ui 0.8.82 → 0.8.84

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

@@ -0,0 +1,239 @@
+import { CSSProperties, HTMLAttributes, ReactNode } from 'react';
+export type GridResponsiveBreakpoint = 'xxxl' | 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs';
+export type GridRowGutter = number | Partial<Record<GridResponsiveBreakpoint, number>>;
+/**
+ * @title Row
+ */
+export interface RowProps extends Omit<HTMLAttributes<HTMLDivElement>, 'className'> {
+    style?: CSSProperties;
+    className?: string | string[];
+    /**
+     * @zh
+     * 栅格间隔，单位是`px` 栅格间隔。可传入响应式对象写法 { xs: 4, sm: 6, md: 12}，传入数组 [ 水平间距， 垂直间距 ] 来设置两个方向。
+     * @en
+     * Spacing between grids, could be a number or a object like { xs: 8, sm: 16, md: 24}.
+     * Or you can use array to make horizontal and vertical spacing work at the same time [horizontal, vertical]
+     * @version vertical gutter in 2.5.0
+     * @defaultValue 0
+     */
+    gutter?: GridRowGutter | Array<GridRowGutter>;
+    /**
+     * @zh 开启这个选项 `<Row>` 和 `<Col>` 都会被当作 div 而不会附带任何 Grid 相关的类和样式
+     * @en If true, `<Row>` and `<Col>` will be treated as a div without any Grid related classes and styles
+     */
+    div?: boolean;
+    /**
+     * @zh 竖直对齐方式 ( `align-items` )
+     * @en Vertical alignment, same as css `align-items`
+     * @defaultValue start
+     */
+    align?: 'start' | 'center' | 'end' | 'stretch';
+    /**
+     * @zh 水平对齐方式 (`justify-content`)
+     * @en Horizontal alignment, same as css `justify-content`
+     * @defaultValue start
+     */
+    justify?: 'start' | 'center' | 'end' | 'space-around' | 'space-between';
+}
+/**
+ * @title Col
+ */
+export interface ColProps extends Omit<HTMLAttributes<HTMLDivElement>, 'className' | 'ref'> {
+    style?: CSSProperties;
+    className?: string | string[];
+    /**
+     * @zh 栅格占位格数
+     * @en Raster number of cells to occupy
+     * @defaultValue 24
+     */
+    span?: number;
+    /**
+     * @zh 栅格左侧的间隔格数，间隔内不可以有栅格
+     * @en The number of cells to offset Col from the left
+     */
+    offset?: number;
+    /**
+     * @zh 对元素进行排序
+     * @en Raster order
+     */
+    order?: number;
+    /**
+     * @zh 对元素进行排序
+     * @en Raster order
+     * @version 2.20.0
+     */
+    push?: number;
+    /**
+     * @zh 对元素进行排序
+     * @en Raster order
+     * @version 2.20.0
+     */
+    pull?: number;
+    /**
+     * @zh < 576px 响应式栅格
+     * @en `screen < 576px`
+     */
+    xs?: number | {
+        [key: string]: any;
+    };
+    /**
+     * @zh >= 576px 响应式栅格
+     * @en `screen >= 576px`
+     */
+    sm?: number | {
+        [key: string]: any;
+    };
+    /**
+     * @zh >= 768px 响应式栅格
+     * @en `screen >= 768px`
+     */
+    md?: number | {
+        [key: string]: any;
+    };
+    /**
+     * @zh >= 992px 响应式栅格
+     * @en `screen >= 992px`
+     */
+    lg?: number | {
+        [key: string]: any;
+    };
+    /**
+     * @zh >= 1200px 响应式栅格
+     * @en `screen >= 1200px`
+     */
+    xl?: number | {
+        [key: string]: any;
+    };
+    /**
+     * @zh >= 1600px 响应式栅格
+     * @en `screen >= 1600px`
+     */
+    xxl?: number | {
+        [key: string]: any;
+    };
+    /**
+     * @zh >= 2000px 响应式栅格
+     * @en `screen >= 2000px`
+     * @version 2.40.0
+     */
+    xxxl?: number | {
+        [key: string]: any;
+    };
+    /**
+     * @zh 设置 flex 布局属性
+     * @en Set flex layout properties
+     * @version 2.26.0
+     */
+    flex?: FlexType;
+}
+/**
+ * @title Grid
+ */
+export interface GridProps extends Omit<HTMLAttributes<HTMLDivElement>, 'className'> {
+    style?: CSSProperties;
+    className?: string | string[];
+    /**
+     * @zh 每一行展示的列数
+     * @en Number of columns displayed in each row
+     * @defaultValue 24
+     */
+    cols?: number | ResponsiveValue;
+    /**
+     * @zh 行与行之间的间距
+     * @en The space in row-to-row
+     * @defaultValue 0
+     */
+    rowGap?: number | ResponsiveValue;
+    /**
+     * @zh 列与列之间的间距
+     * @en The space in column-to-column
+     * @defaultValue 0
+     */
+    colGap?: number | ResponsiveValue;
+    /**
+     * @zh 是否折叠
+     * @en Whether to collapsed
+     * @defaultValue false
+     */
+    collapsed?: boolean;
+    /**
+     * @zh 折叠时显示的行数
+     * @en Number of rows displayed when collapsed
+     * @defaultValue 1
+     */
+    collapsedRows?: number;
+}
+/**
+ * @title GridItem
+ */
+export interface GridItemProps extends Omit<HTMLAttributes<HTMLDivElement>, 'className'> {
+    style?: CSSProperties;
+    className?: string | string[];
+    /**
+     * @zh 跨越的格数
+     * @en Number of grids spanned
+     * @defaultValue 1
+     */
+    span?: number | ResponsiveValue;
+    /**
+     * @zh 左侧的间隔格数
+     * @en Number of grids on the left
+     * @defaultValue 0
+     */
+    offset?: number | ResponsiveValue;
+    /**
+     * @zh 是否是后缀元素
+     * @en Is it a suffix element
+     * @defaultValue false
+     */
+    suffix?: boolean;
+    __index__?: number;
+    children?: ReactNode | ((info: {
+        overflow: boolean;
+    }) => ReactNode);
+}
+export interface GridItemData extends GridItemProps {
+    span: number;
+    offset: number;
+}
+/**
+ * @title ResponsiveValue
+ */
+export interface ResponsiveValue {
+    /**
+     * @zh >= 2000px 响应式栅格
+     * @en `screen >= 2000px`
+     */
+    xxxl?: number;
+    /**
+     * @zh >= 1600px 响应式配置
+     * @en >= 1600px responsive configuration
+     */
+    xxl?: number;
+    /**
+     * @zh >= 1200px 响应式配置
+     * @en >= 1200px responsive configuration
+     */
+    xl?: number;
+    /**
+     * @zh >= 992px 响应式配置
+     * @en >= 992px responsive configuration
+     */
+    lg?: number;
+    /**
+     * @zh >= 768px 响应式配置
+     * @en >= 768px responsive configuration
+     */
+    md?: number;
+    /**
+     * @zh >= 576px 响应式配置
+     * @en >= 576px responsive configuration
+     */
+    sm?: number;
+    /**
+     * @zh < 576px 响应式配置
+     * @en < 576px responsive configuration
+     */
+    xs?: number;
+}
+export type FlexType = string | number | 'auto' | 'none';

package/types/{hooks → pc/hooks}/use-verification-code/interface.d.ts

@@ -1,16 +1,57 @@
 import { ClipboardEvent, KeyboardEvent, MouseEvent } from 'react';
+/**
+ * @title VerificationCodeOptions
+ *
+ */
 export interface VerificationCodeOptions {
+    /**
+     * @zh 长度
+     * @en length
+     */
     length?: number;
+    /**
+     * @zh 默认值
+     * @en The initial input content
+     */
     defaultValue?: string;
+    /**
+     * @zh value
+     * @en value
+     */
     value?: string;
+    /**
+     * @zh onChange
+     * @en onChange
+     */
     onChange?: (value: string) => void;
+    /**
+     * @zh onFinish
+     * @en onFinish
+     */
     onFinish?: (value: string) => void;
+    /**
+     * @zh input list
+     * @en input list
+     */
     getInputRefList?: () => (HTMLInputElement | HTMLTextAreaElement)[];
 }
+/**
+ * @title VerificationCodeReturnType
+ *
+ */
 export type VerificationCodeReturnType = {
+    /**
+     * @zh filledValue
+     */
     filledValue: VerificationCodeOptions['value'][];
     value: VerificationCodeOptions['value'];
+    /**
+     * @zh 更新内部 value
+     */
     setValue: (v: VerificationCodeOptions['value']) => void;
+    /**
+     * @zh 获取 input 属性，附加到 input
+     */
     getInputProps: (index: number) => {
         key: string | number;
         value: string;

package/types/pc/hooks/use-watermark/interface.d.ts

@@ -0,0 +1,81 @@
+import { CSSProperties } from 'react';
+/**
+ * @title WatermarkOptions
+ */
+export interface WatermarkOptions {
+    /**
+     * @zh zIndex
+     * @en zIndex
+     */
+    zIndex?: CSSProperties['zIndex'];
+    /**
+     * @zh 单个水印的宽度。`image` 时默认为 100，content 时默认为文本宽度
+     * @en The width of a single watermark. The default is 100 for `image` and the text width for content.
+     */
+    width?: number | string;
+    /**
+     * @zh 单个水印的高度
+     * @en The height of a single watermark
+     */
+    height?: number | string;
+    /**
+     * @zh 单个水印旋转角度
+     * @en Single watermark rotation angle
+     * @defaultValue -20
+     */
+    rotate?: number;
+    /**
+     * @zh 水印图片源，优先级比文字内容高
+     * @en Watermark image source has higher priority than text content
+     */
+    image?: string;
+    /**
+     * @zh 水印的文字内容
+     * @en The text content of the watermark
+     */
+    content?: string | string[];
+    /**
+     * @zh 水印文字样式
+     * @en Watermark text style
+     * @defaultValue {color:`rgba(0, 0, 0, 0.12)`, fontFamily: `sans-serif`, fontSize: `14px`, fontWeight: `normal` }
+     */
+    fontStyle?: {
+        color?: string;
+        fontFamily?: string;
+        fontSize?: number | string;
+        fontWeight?: number | string;
+    };
+    /**
+     * @zh 水印间的间距
+     * @en spacing between watermarks
+     * @defaultValue [100, 100]
+     */
+    gap?: [number, number];
+    /**
+     * @zh 水印相对于 `container` 容器的偏移量。
+     * @en The offset of the watermark relative to the `container` container.
+     * @defaultValue [`gaps[0] / 2`, `gaps[1] / 2`]
+     */
+    offset?: [number, number];
+    /**
+     * @zh 添加水印的容器 `wrapper`，会把水印 `dom` 作为 `container` 的第一个子节点展示
+     * @en The container `wrapper` that adds a watermark will display the watermark `dom` as the first child node of the `container`.
+     */
+    getContainer?: () => HTMLElement;
+}
+/**
+ * WatermarkReturnType
+ */
+export type WatermarkReturnType = {
+    /**
+     *
+     * @zh 销毁水印
+     * @en destroy watermark
+     */
+    destroy: () => void;
+    /**
+     * @zh 显示/更新水印
+     * @en show/set Watermark
+     */
+    setWatermark: (options: WatermarkOptions) => void;
+};

package/types/pc/hooks/useComputedState.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useComputedState';

package/types/pc/hooks/useCreate.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useCreate';

package/types/pc/hooks/useForceUpdate.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useForceUpdate';

package/types/pc/hooks/useId.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useId';

package/types/pc/hooks/useInView.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useInView';

package/types/pc/hooks/useIntersectionObserver.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useIntersectionObserver';

package/types/pc/hooks/useInterval.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useInterval';

package/types/pc/hooks/useIsFirstRender.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useIsFirstRender';

package/types/pc/hooks/useIsomorphicLayoutEffect.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useIsomorphicLayoutEffect';

package/types/pc/hooks/useKeyboardEvent.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useKeyboardEvent';

package/types/pc/hooks/useListenResize.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useListenResize';

package/types/pc/hooks/useMedia.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useMedia';

package/types/pc/hooks/useMergeProps.d.ts

@@ -0,0 +1,2 @@
+export { default } from '../../common/hooks/useMergeProps';
+export type { MergePropsOptions } from '../../common/hooks/useMergeProps';

package/types/pc/hooks/useMergeValue.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useMergeValue';

package/types/pc/hooks/useOnlineStatus.d.ts

@@ -0,0 +1 @@
+export { default } from "../../common/hooks/useOnlineStatus";

package/types/pc/hooks/useOverflowHidden.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useOverflowHidden';

package/types/pc/hooks/useOverrideRef.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useOverrideRef';

package/types/pc/hooks/usePersistCallback.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/usePersistCallback';

package/types/pc/hooks/usePrefersColorSchemeDark.d.ts

@@ -0,0 +1 @@
+export { default } from "../../common/hooks/usePrefersColorSchemeDark";

package/types/pc/hooks/usePrevious.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/usePrevious';

package/types/pc/hooks/useRefs.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useRefs';

package/types/pc/hooks/useResizeObserver.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useResizeObserver';

package/types/pc/hooks/useStateCallback.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useStateCallback';

package/types/pc/hooks/useStateWithPromise.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useStateWithPromise';

package/types/pc/hooks/useUpdateEffect.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useUpdateEffect';

package/types/pc/hooks/useWatch.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useWatch';

package/types/pc/hooks/useWindowSize.d.ts

@@ -0,0 +1 @@
+export { default } from '../../common/hooks/useWindowSize';